@rslib/core 0.0.12 → 0.0.13

package/dist/index.js

@@ -112,12 +112,28 @@ function pick(obj, keys) {
         return ret;
     }, {});
 }
-function omit(obj, keys) {
+function omit(obj, keysObj) {
     return Object.keys(obj).reduce((ret, key)=>{
-        if (!keys.includes(key)) ret[key] = obj[key];
+        if (true !== keysObj[key]) ret[key] = obj[key];
         return ret;
     }, {});
 }
+function isPluginIncluded(config, pluginName) {
+    return Boolean(config.plugins?.some((plugin)=>{
+        if ('object' == typeof plugin && null !== plugin && 'name' in plugin) return plugin.name === pluginName;
+        return false;
+    }));
+}
+function checkMFPlugin(config) {
+    if ('mf' !== config.format) return true;
+    // https://github.com/module-federation/core/blob/4e5c4b96ee45899f3ba5904b8927768980d5ad0e/packages/rsbuild-plugin/src/cli/index.ts#L17
+    const added = isPluginIncluded(config, 'rsbuild:module-federation-enhanced');
+    if (!added) {
+        __WEBPACK_EXTERNAL_MODULE__compiled_rslog_index_js__.logger.warn(`${__WEBPACK_EXTERNAL_MODULE__compiled_picocolors_index_js__["default"].green('format: "mf"')} should be used with ${__WEBPACK_EXTERNAL_MODULE__compiled_picocolors_index_js__["default"].blue('@module-federation/rsbuild-plugin')}", consider installing and adding it to plugins. Check the documentation (https://module-federation.io/guide/basic/rsbuild.html#rslib-module) to get started with "mf" output.`);
+        process.exit(1);
+    }
+    return added;
+}
 // setup the logger level
 if (process.env.DEBUG) __WEBPACK_EXTERNAL_MODULE__compiled_rslog_index_js__.logger.level = 'verbose';
 function initNodeEnv() {
@@ -134,7 +150,7 @@ function prepareCli() {
     // Some package managers automatically output a blank line, some do not.
     const { npm_execpath } = process.env;
     if (!npm_execpath || npm_execpath.includes('npx-cli.js') || npm_execpath.includes('.bun')) console.log();
-    __WEBPACK_EXTERNAL_MODULE__compiled_rslog_index_js__.logger.greet(`  Rslib v0.0.12\n`);
+    __WEBPACK_EXTERNAL_MODULE__compiled_rslog_index_js__.logger.greet(`  Rslib v0.0.13\n`);
 }
 const DEFAULT_CONFIG_NAME = 'rslib.config';
 const DEFAULT_CONFIG_EXTENSIONS = [
@@ -173,17 +189,17 @@ const ENTRY_EXTENSIONS = [
 const JS_EXTENSIONS_PATTERN = new RegExp(`\\.(${JS_EXTENSIONS.join('|')})$`);
 const CSS_EXTENSIONS_PATTERN = new RegExp(`\\.(${CSS_EXTENSIONS.join('|')})$`);
 const ENTRY_EXTENSIONS_PATTERN = new RegExp(`\\.(${ENTRY_EXTENSIONS.join('|')})$`);
-const pluginName = 'REMOVE_CSS_EXTRACT_ASSET_PLUGIN';
+const RemoveCssExtractAssetPlugin_pluginName = 'REMOVE_CSS_EXTRACT_ASSET_PLUGIN';
 class RemoveCssExtractAssetPlugin {
-    name = pluginName;
+    name = RemoveCssExtractAssetPlugin_pluginName;
     options;
     constructor(options){
         this.options = options;
     }
     apply(compiler) {
         const include = this.options.include;
-        compiler.hooks.thisCompilation.tap(pluginName, (compilation)=>{
-            compilation.hooks.chunkAsset.tap(pluginName, (_chunk, filename)=>{
+        compiler.hooks.thisCompilation.tap(RemoveCssExtractAssetPlugin_pluginName, (compilation)=>{
+            compilation.hooks.chunkAsset.tap(RemoveCssExtractAssetPlugin_pluginName, (_chunk, filename)=>{
                 const asset = compilation.getAsset(filename);
                 if (!asset) return;
                 const needRemove = Boolean(asset.name.match(include));
@@ -395,115 +411,104 @@ const RSPACK_TARGET_UNLISTED_MODERN_ECMA_VERSIONS = [
  * https://github.com/rspack-contrib/browserslist-to-es-version
  * TODO: align with Rsbuild, we may should align with SWC
  */ const ESX_TO_BROWSERSLIST = {
+    es5: {
+        chrome: '5.0.0',
+        edge: '12.0.0',
+        firefox: '2.0.0',
+        ie: '9.0.0',
+        ios: '6.0.0',
+        node: '0.4.0',
+        opera: '10.10.0',
+        safari: '3.1.0'
+    },
     es6: {
-        Chrome: '63.0.0',
-        Edge: '79.0.0',
-        Firefox: '67.0.0',
-        iOS: '13.0.0',
-        Node: [
-            'node > 12.20.0 and node < 13.0.0',
-            'node > 13.2.0'
-        ],
-        Opera: '50.0.0',
-        Safari: '13.0.0'
+        chrome: '63.0.0',
+        edge: '79.0.0',
+        firefox: '67.0.0',
+        ios: '13.0.0',
+        node: '13.2.0',
+        opera: '50.0.0',
+        safari: '13.0.0'
     },
     es2015: {
-        Chrome: '63.0.0',
-        Edge: '79.0.0',
-        Firefox: '67.0.0',
-        iOS: '13.0.0',
-        Node: '10.0.0',
-        Opera: '50.0.0',
-        Safari: '13.0.0'
+        chrome: '63.0.0',
+        edge: '79.0.0',
+        firefox: '67.0.0',
+        ios: '13.0.0',
+        node: '13.2.0',
+        opera: '50.0.0',
+        safari: '13.0.0'
     },
     es2016: {
-        Chrome: '52.0.0',
-        Edge: '14.0.0',
-        Firefox: '52.0.0',
-        iOS: '10.3.0',
-        Node: '7.0.0',
-        Opera: '39.0.0',
-        Safari: '10.1.0'
+        chrome: '63.0.0',
+        edge: '79.0.0',
+        firefox: '67.0.0',
+        ios: '13.0.0',
+        node: '13.2.0',
+        opera: '50.0.0',
+        safari: '13.0.0'
     },
     es2017: {
-        Chrome: '55.0.0',
-        Edge: '15.0.0',
-        Firefox: '52.0.0',
-        iOS: '11.0.0',
-        Node: '7.6.0',
-        Opera: '42.0.0',
-        Safari: '11.0.0'
+        chrome: '63.0.0',
+        edge: '79.0.0',
+        firefox: '67.0.0',
+        ios: '13.0.0',
+        node: '13.2.0',
+        opera: '50.0.0',
+        safari: '13.0.0'
     },
     es2018: {
-        Chrome: '64.0.0',
-        Edge: '79.0.0',
-        Firefox: '78.0.0',
-        iOS: '16.4.0',
-        Node: [
-            'node > 18.20.0 and node < 19.0.0',
-            'node > 20.12.0 and node < 21.0.0',
-            'node > 21.3.0'
-        ],
-        Opera: '51.0.0',
-        Safari: '16.4.0'
+        chrome: '64.0.0',
+        edge: '79.0.0',
+        firefox: '78.0.0',
+        ios: '16.4.0',
+        node: '13.2.0',
+        opera: '51.0.0',
+        safari: '16.4.0'
     },
     es2019: {
-        Chrome: '66.0.0',
-        Edge: '79.0.0',
-        Firefox: '58.0.0',
-        iOS: '11.3.0',
-        Node: '10.0.0',
-        Opera: '53.0.0',
-        Safari: '11.1.0'
+        chrome: '66.0.0',
+        edge: '79.0.0',
+        firefox: '78.0.0',
+        ios: '16.4.0',
+        node: '13.2.0',
+        opera: '53.0.0',
+        safari: '16.4.0'
     },
     es2020: {
-        Chrome: '91.0.0',
-        Edge: '91.0.0',
-        Firefox: '80.0.0',
-        iOS: '14.5.0',
-        Node: '16.1.0',
-        Opera: '77.0.0',
-        Safari: '14.1.0'
+        chrome: '91.0.0',
+        edge: '91.0.0',
+        firefox: '80.0.0',
+        ios: '16.4.0',
+        node: '16.1.0',
+        opera: '77.0.0',
+        safari: '16.4.0'
     },
     es2021: {
-        Chrome: '85.0.0',
-        Edge: '85.0.0',
-        Firefox: '79.0.0',
-        iOS: '14.0.0',
-        Node: '15.0.0',
-        Opera: '71.0.0',
-        Safari: '14.0.0'
+        chrome: '91.0.0',
+        edge: '91.0.0',
+        firefox: '80.0.0',
+        ios: '16.4.0',
+        node: '16.1.0',
+        opera: '77.0.0',
+        safari: '16.4.0'
     },
     es2022: {
-        Chrome: '91.0.0',
-        Edge: '94.0.0',
-        Firefox: '93.0.0',
-        iOS: '16.4.0',
-        Node: '16.11.0',
-        Opera: '80.0.0',
-        Safari: '16.4.0'
+        chrome: '91.0.0',
+        firefox: '93.0.0',
+        ios: '16.4.0',
+        node: '16.11.0',
+        safari: '16.4.0'
     },
     es2023: {
-        Chrome: '74.0.0',
-        Edge: '79.0.0',
-        Firefox: '67.0.0',
-        iOS: '13.4.0',
-        Node: '12.5.0',
-        Opera: '62.0.0',
-        Safari: '13.1.0'
+        chrome: '91.0.0',
+        firefox: '93.0.0',
+        ios: '16.4.0',
+        node: '16.11.0',
+        safari: '16.4.0'
     },
     es2024: calcEsnextBrowserslistByTarget,
-    esnext: calcEsnextBrowserslistByTarget,
-    es5: {
-        Chrome: '5.0.0',
-        Edge: '12.0.0',
-        Firefox: '2.0.0',
-        ie: '9.0.0',
-        iOS: '6.0.0',
-        Node: '0.4.0',
-        Opera: '10.10.0',
-        Safari: '3.1.0'
-    }
+    esnext: calcEsnextBrowserslistByTarget
 };
 function transformSyntaxToRspackTarget(syntax) {
     const handleSyntaxItem = (syntaxItem)=>{
@@ -1410,7 +1415,9 @@ const composeAutoExternalConfig = (options)=>{
         }
     } : {};
 };
-function composeMinifyConfig(minify) {
+function composeMinifyConfig(config) {
+    const minify = config.output?.minify;
+    const format = config.format;
     if (void 0 !== minify) // User's minify configuration will be merged afterwards.
     return {};
     // When minify is not specified, Rslib will use a sane default for minify options.
@@ -1428,7 +1435,8 @@ function composeMinifyConfig(minify) {
                             defaults: false,
                             unused: true,
                             dead_code: true,
-                            toplevel: true
+                            // remoteEntry's global variable will be tree-shaken if `toplevel` is enabled in "mf" format
+                            toplevel: 'mf' !== format
                         },
                         format: {
                             comments: 'all'
@@ -1552,7 +1560,7 @@ async function createConstantRsbuildConfig() {
         }
     });
 }
-const composeFormatConfig = (format)=>{
+const composeFormatConfig = ({ format, bundle = true, umdName, pkgJson })=>{
     const jsParserOptions = {
         cjs: {
             requireResolve: false,
@@ -1623,20 +1631,45 @@ const composeFormatConfig = (format)=>{
                 }
             };
         case 'umd':
+            {
+                if (false === bundle) throw new Error('When using "umd" format, "bundle" must be set to "true". Since the default value for "bundle" is "true", so you can either explicitly set it to "true" or remove the field entirely.');
+                const config = {
+                    tools: {
+                        rspack: {
+                            module: {
+                                parser: {
+                                    javascript: {
+                                        importMeta: false
+                                    }
+                                }
+                            },
+                            output: {
+                                asyncChunks: false,
+                                library: umdName ? {
+                                    type: 'umd',
+                                    name: umdName
+                                } : {
+                                    type: 'umd'
+                                }
+                            }
+                        }
+                    }
+                };
+                return config;
+            }
+        case 'mf':
             return {
                 tools: {
                     rspack: {
-                        module: {
-                            parser: {
-                                javascript: {
-                                    importMeta: false
-                                }
-                            }
-                        },
                         output: {
-                            library: {
-                                type: 'umd'
-                            }
+                            uniqueName: pkgJson.name
+                        },
+                        // TODO when we provide dev mode for rslib mf format, this should be modified to as the same with config.mode
+                        // can not set nodeEnv to false, because mf format should build shared module.
+                        // If nodeEnv is false, the process.env.NODE_ENV in third-party packages's will not be replaced
+                        // now we have not provide dev mode for users, so we can always set nodeEnv as 'production'
+                        optimization: {
+                            nodeEnv: 'production'
                         }
                     }
                 }
@@ -1680,6 +1713,8 @@ const composeShimsConfig = (format, shims)=>{
             };
         case 'umd':
             return {};
+        case 'mf':
+            return {};
         default:
             throw new Error(`Unsupported format: ${format}`);
     }
@@ -1692,12 +1727,14 @@ const composeExternalsConfig = (format, externals)=>{
     const externalsTypeMap = {
         esm: 'module-import',
         cjs: 'commonjs',
-        umd: 'umd'
+        umd: 'umd',
+        mf: 'var'
     };
     switch(format){
         case 'esm':
         case 'cjs':
         case 'umd':
+        case 'mf':
             return {
                 output: externals ? {
                     externals
@@ -1820,7 +1857,7 @@ const composeEntryConfig = async (entries, bundle, root, cssModulesAuto)=>{
         lcp
     };
 };
-const composeBundleConfig = (jsExtension, redirect, cssModulesAuto, bundle = true)=>{
+const composeBundleConfig = (jsExtension, redirect, cssModulesAuto, bundle)=>{
     if (bundle) return {};
     const isStyleRedirect = redirect.style ?? true;
     return {
@@ -1944,17 +1981,23 @@ const composeExternalHelpersConfig = (externalHelpers, pkgJson)=>{
     return defaultConfig;
 };
 async function composeLibRsbuildConfig(config, configPath) {
+    checkMFPlugin(config);
     const rootPath = (0, __WEBPACK_EXTERNAL_MODULE_node_path__.dirname)(configPath);
     const pkgJson = readPackageJson(rootPath);
     const { compilerOptions } = await loadTsconfig(rootPath, config.source?.tsconfigPath);
     const cssModulesAuto = config.output?.cssModules?.auto ?? true;
-    const { format, shims, banner = {}, footer = {}, autoExtension = true, autoExternal = true, externalHelpers = false, redirect = {} } = config;
+    const { format, shims, bundle = true, banner = {}, footer = {}, autoExtension = true, autoExternal = true, externalHelpers = false, redirect = {}, umdName } = config;
     const shimsConfig = composeShimsConfig(format, shims);
-    const formatConfig = composeFormatConfig(format);
+    const formatConfig = composeFormatConfig({
+        format: format,
+        pkgJson: pkgJson,
+        bundle,
+        umdName
+    });
     const externalHelpersConfig = composeExternalHelpersConfig(externalHelpers, pkgJson);
     const externalsConfig = composeExternalsConfig(format, config.output?.externals);
     const { config: autoExtensionConfig, jsExtension, dtsExtension } = composeAutoExtensionConfig(config, autoExtension, pkgJson);
-    const bundleConfig = composeBundleConfig(jsExtension, redirect, cssModulesAuto, config.bundle);
+    const bundleConfig = composeBundleConfig(jsExtension, redirect, cssModulesAuto, bundle);
     const targetConfig = composeTargetConfig(config.output?.target);
     const syntaxConfig = composeSyntaxConfig(config?.syntax, config.output?.target);
     const autoExternalConfig = composeAutoExternalConfig({
@@ -1966,7 +2009,7 @@ async function composeLibRsbuildConfig(config, configPath) {
     const cssConfig = composeCssConfig(lcp, config.bundle);
     const dtsConfig = await composeDtsConfig(config, dtsExtension);
     const externalsWarnConfig = composeExternalsWarnConfig(format, autoExternalConfig?.output?.externals, externalsConfig?.output?.externals);
-    const minifyConfig = composeMinifyConfig(config.output?.minify);
+    const minifyConfig = composeMinifyConfig(config);
     const bannerFooterConfig = composeBannerFooterConfig(banner, footer);
     const decoratorsConfig = composeDecoratorsConfig(compilerOptions, config.source?.decorators?.version);
     return (0, __WEBPACK_EXTERNAL_MODULE__rsbuild_core__.mergeRsbuildConfig)(formatConfig, shimsConfig, externalHelpersConfig, externalsWarnConfig, externalsConfig, autoExternalConfig, autoExtensionConfig, syntaxConfig, bundleConfig, targetConfig, entryConfig, cssConfig, minifyConfig, dtsConfig, bannerFooterConfig, decoratorsConfig);
@@ -1999,19 +2042,20 @@ async function composeCreateRsbuildConfig(rslibConfig, path) {
             // We should state in the document that the built-in configuration should not be changed optionally
             // In compose process of 2, we may read some config from 1, and reassemble the related config,
             // so before final mergeRsbuildConfig, we reset some specified fields
-            config: (0, __WEBPACK_EXTERNAL_MODULE__rsbuild_core__.mergeRsbuildConfig)(constantRsbuildConfig, libRsbuildConfig, omit(userConfig, [
-                'bundle',
-                'format',
-                'autoExtension',
-                'autoExternal',
-                'redirect',
-                'syntax',
-                'externalHelpers',
-                'banner',
-                'footer',
-                'dts',
-                'shims'
-            ]))
+            config: (0, __WEBPACK_EXTERNAL_MODULE__rsbuild_core__.mergeRsbuildConfig)(constantRsbuildConfig, libRsbuildConfig, omit(userConfig, {
+                bundle: true,
+                format: true,
+                autoExtension: true,
+                autoExternal: true,
+                redirect: true,
+                syntax: true,
+                externalHelpers: true,
+                banner: true,
+                footer: true,
+                dts: true,
+                shims: true,
+                umdName: true
+            }))
         };
     });
     const composedRsbuildConfig = await Promise.all(libConfigPromises);
@@ -2027,7 +2071,8 @@ async function initRsbuild(rslibConfig) {
     const formatIndex = {
         esm: 0,
         cjs: 0,
-        umd: 0
+        umd: 0,
+        mf: 0
     };
     for (const { format, config } of rsbuildConfigObject){
         const currentFormatCount = formatCount[format];
@@ -2051,7 +2096,7 @@ const applyCommonOptions = (command)=>{
     command.option('-c --config <config>', 'specify the configuration file, can be a relative or absolute path').option('--env-mode <mode>', 'specify the env mode to load the `.env.[mode]` file');
 };
 function runCli() {
-    __WEBPACK_EXTERNAL_MODULE__compiled_commander_index_js__.program.name('rslib').usage('<command> [options]').version("0.0.12");
+    __WEBPACK_EXTERNAL_MODULE__compiled_commander_index_js__.program.name('rslib').usage('<command> [options]').version("0.0.13");
     const buildCommand = __WEBPACK_EXTERNAL_MODULE__compiled_commander_index_js__.program.command('build');
     const inspectCommand = __WEBPACK_EXTERNAL_MODULE__compiled_commander_index_js__.program.command('inspect');
     [
@@ -2093,6 +2138,6 @@ function runCli() {
     });
     __WEBPACK_EXTERNAL_MODULE__compiled_commander_index_js__.program.parse();
 }
-const src_version = "0.0.12";
+const src_version = "0.0.13";
 var __webpack_exports__logger = __WEBPACK_EXTERNAL_MODULE__compiled_rslog_index_js__.logger;
 export { build, defineConfig, loadConfig, prepareCli, runCli, src_version as version, __webpack_exports__logger as logger };

package/dist-types/config.d.ts

@@ -1,5 +1,5 @@
 import { type RsbuildConfig, type RsbuildInstance } from '@rsbuild/core';
-import type { AutoExternal, BannerAndFooter, Format, PkgJson, RslibConfig, RslibConfigAsyncFn, RslibConfigExport, RslibConfigSyncFn } from './types';
+import type { AutoExternal, BannerAndFooter, Format, LibConfig, PkgJson, RslibConfig, RslibConfigAsyncFn, RslibConfigExport, RslibConfigSyncFn } from './types';
 /**
  * This function helps you to autocomplete configuration types.
  * It accepts a Rslib config object, or a function that returns a config.
@@ -18,7 +18,7 @@ export declare const composeAutoExternalConfig: (options: {
     pkgJson?: PkgJson;
     userExternals?: NonNullable<RsbuildConfig["output"]>["externals"];
 }) => RsbuildConfig;
-export declare function composeMinifyConfig(minify: NonNullable<RsbuildConfig['output']>['minify']): RsbuildConfig;
+export declare function composeMinifyConfig(config: LibConfig): RsbuildConfig;
 export declare function composeBannerFooterConfig(banner: BannerAndFooter, footer: BannerAndFooter): RsbuildConfig;
 export declare function composeDecoratorsConfig(compilerOptions?: Record<string, any>, version?: NonNullable<NonNullable<RsbuildConfig['source']>['decorators']>['version']): RsbuildConfig;
 export declare function createConstantRsbuildConfig(): Promise<RsbuildConfig>;

package/dist-types/types/config/index.d.ts

@@ -1,6 +1,6 @@
 import type { RsbuildConfig } from '@rsbuild/core';
 import type { PluginDtsOptions } from 'rsbuild-plugin-dts';
-export type Format = 'esm' | 'cjs' | 'umd';
+export type Format = 'esm' | 'cjs' | 'umd' | 'mf';
 export type FixedEcmaVersions = 'es5' | 'es6' | 'es2015' | 'es2016' | 'es2017' | 'es2018' | 'es2019' | 'es2020' | 'es2021' | 'es2022' | 'es2023';
 export type LatestEcmaVersions = 'es2024' | 'esnext';
 export type EcmaScriptVersion = FixedEcmaVersions | LatestEcmaVersions;
@@ -45,7 +45,9 @@ export interface LibConfig extends RsbuildConfig {
     footer?: BannerAndFooter;
     shims?: Shims;
     dts?: Dts;
+    umdName?: string;
 }
+export type LibOnlyConfig = Omit<LibConfig, keyof RsbuildConfig>;
 export interface RslibConfig extends RsbuildConfig {
     lib: LibConfig[];
 }

package/dist-types/types/utils.d.ts

@@ -1,4 +1,5 @@
 export type PkgJson = {
+    name: string;
     type?: 'module' | 'commonjs';
     dependencies?: Record<string, string>;
     peerDependencies?: Record<string, string>;

package/dist-types/utils/helper.d.ts

@@ -1,5 +1,5 @@
 import color from 'picocolors';
-import type { PkgJson } from '../types';
+import type { LibConfig, PkgJson } from '../types';
 /**
  * Node.js built-in modules.
  * Copied from https://github.com/webpack/webpack/blob/dd44b206a9c50f4b4cb4d134e1a0bd0387b159a3/lib/node/NodeTargetPlugin.js#L12-L72
@@ -10,5 +10,7 @@ export declare const readPackageJson: (rootPath: string) => undefined | PkgJson;
 export declare const isObject: (obj: unknown) => obj is Record<string, any>;
 export declare const isEmptyObject: (obj: object) => boolean;
 export declare function pick<T, U extends keyof T>(obj: T, keys: ReadonlyArray<U>): Pick<T, U>;
-export declare function omit<T extends object, U extends keyof T>(obj: T, keys: ReadonlyArray<U>): Omit<T, U>;
+export declare function omit<T extends object, U extends keyof T>(obj: T, keysObj: Record<U, boolean>): Omit<T, keyof U>;
+export declare function isPluginIncluded(config: LibConfig, pluginName: string): boolean;
+export declare function checkMFPlugin(config: LibConfig): boolean;
 export { color };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rslib/core",
-  "version": "0.0.12",
+  "version": "0.0.13",
   "description": "The Rspack-based library build tool.",
   "homepage": "https://lib.rsbuild.dev",
   "bugs": {
@@ -33,7 +33,7 @@
   ],
   "dependencies": {
     "@rsbuild/core": "~1.0.14",
-    "rsbuild-plugin-dts": "0.0.12"
+    "rsbuild-plugin-dts": "0.0.13"
   },
   "devDependencies": {
     "@rspack/core": "1.0.8",
@@ -44,7 +44,7 @@
     "memfs": "^4.14.0",
     "picocolors": "1.1.0",
     "prebundle": "1.2.2",
-    "rslib": "npm:@rslib/core@0.0.11",
+    "rslib": "npm:@rslib/core@0.0.12",
     "rslog": "^1.2.3",
     "tsconfck": "3.1.4",
     "typescript": "^5.6.3",