@rslib/core 0.0.15 → 0.0.17

package/README.md

@@ -4,7 +4,7 @@
 
 # Rslib
 
-Rslib is a library build tool powered by [Rsbuild](https://rsbuild.dev). It allows library developers to leverage the knowledge and ecosystem of webpack and Rspack.
+Rslib is a library development tool powered by [Rsbuild](https://rsbuild.dev). It allows library developers to leverage the knowledge and ecosystem of webpack and Rspack.
 
 ## Documentation
 

package/bin/rslib.js

@@ -1,7 +1,19 @@
 #!/usr/bin/env node
-import { logger, prepareCli, runCli } from '../dist/index.js';
+import nodeModule from 'node:module';
+
+// enable on-disk code caching of all modules loaded by Node.js
+// requires Nodejs >= 22.8.0
+const { enableCompileCache } = nodeModule;
+if (enableCompileCache) {
+  try {
+    enableCompileCache();
+  } catch {
+    // ignore errors
+  }
+}
 
 async function main() {
+  const { logger, prepareCli, runCli } = await import('../dist/index.js');
   prepareCli();
 
   try {

package/dist/index.js

@@ -3,8 +3,8 @@ import * as __WEBPACK_EXTERNAL_MODULE_node_fs__ from "node:fs";
 import * as __WEBPACK_EXTERNAL_MODULE_node_fs_promises__ from "node:fs/promises";
 import * as __WEBPACK_EXTERNAL_MODULE_node_path__ from "node:path";
 import * as __WEBPACK_EXTERNAL_MODULE__compiled_picocolors_index_js__ from "../compiled/picocolors/index.js";
-import * as __WEBPACK_EXTERNAL_MODULE__compiled_commander_index_js__ from "../compiled/commander/index.js";
 import * as __WEBPACK_EXTERNAL_MODULE__rsbuild_core__ from "@rsbuild/core";
+import * as __WEBPACK_EXTERNAL_MODULE__compiled_commander_index_js__ from "../compiled/commander/index.js";
 import * as __WEBPACK_EXTERNAL_MODULE_tinyglobby__ from "tinyglobby";
 import * as __WEBPACK_EXTERNAL_MODULE_node_module__ from "node:module";
 import * as __WEBPACK_EXTERNAL_MODULE_module__ from "module";
@@ -150,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.15\n`);
+    __WEBPACK_EXTERNAL_MODULE__compiled_rslog_index_js__.logger.greet(`  Rslib v0.0.17\n`);
 }
 const DEFAULT_CONFIG_NAME = 'rslib.config';
 const DEFAULT_CONFIG_EXTENSIONS = [
@@ -392,10 +392,6 @@ const LATEST_TARGET_VERSIONS = {
     }
 };
 const calcEsnextBrowserslistByTarget = (target)=>{
-    if (!target) return [
-        ...LATEST_TARGET_VERSIONS.node,
-        ...LATEST_TARGET_VERSIONS.web
-    ];
     if ('node' === target) return LATEST_TARGET_VERSIONS.node;
     return LATEST_TARGET_VERSIONS.web;
 };
@@ -1565,6 +1561,7 @@ async function createConstantRsbuildConfig() {
             }
         },
         output: {
+            target: 'node',
             filenameHash: false,
             distPath: {
                 js: './'
@@ -1783,7 +1780,7 @@ const composeAutoExtensionConfig = (config, autoExtension, pkgJson)=>{
         dtsExtension
     };
 };
-const composeSyntaxConfig = (syntax, target)=>{
+const composeSyntaxConfig = (target, syntax)=>{
     // Defaults to ESNext, Rslib will assume all of the latest JavaScript and CSS features are supported.
     if (syntax) return {
         tools: {
@@ -1923,6 +1920,7 @@ const composeDtsConfig = async (libConfig, dtsExtension)=>{
                 // Only setting ⁠dts.bundle to true will generate the bundled d.ts.
                 bundle: dts?.bundle ?? false,
                 distPath: dts?.distPath ?? output?.distPath?.root ?? './dist',
+                build: dts?.build ?? false,
                 abortOnError: dts?.abortOnError ?? true,
                 dtsExtension: dts?.autoExtension ? dtsExtension : '.d.ts',
                 autoExternal,
@@ -1932,34 +1930,40 @@ const composeDtsConfig = async (libConfig, dtsExtension)=>{
         ]
     };
 };
-const composeTargetConfig = (target = 'web')=>{
+const composeTargetConfig = (target = 'node')=>{
     switch(target){
         case 'web':
             return {
-                tools: {
-                    rspack: {
-                        target: [
-                            'web'
-                        ]
+                config: {
+                    tools: {
+                        rspack: {
+                            target: [
+                                'web'
+                            ]
+                        }
                     }
-                }
+                },
+                target: 'web'
             };
         case 'node':
             return {
-                tools: {
-                    rspack: {
-                        target: [
-                            'node'
-                        ]
+                config: {
+                    tools: {
+                        rspack: {
+                            target: [
+                                'node'
+                            ]
+                        }
+                    },
+                    output: {
+                        // When output.target is 'node', Node.js's built-in will be treated as externals of type `node-commonjs`.
+                        // Simply override the built-in modules to make them external.
+                        // https://github.com/webpack/webpack/blob/dd44b206a9c50f4b4cb4d134e1a0bd0387b159a3/lib/node/NodeTargetPlugin.js#L81
+                        externals: nodeBuiltInModules,
+                        target: 'node'
                     }
                 },
-                output: {
-                    // When output.target is 'node', Node.js's built-in will be treated as externals of type `node-commonjs`.
-                    // Simply override the built-in modules to make them external.
-                    // https://github.com/webpack/webpack/blob/dd44b206a9c50f4b4cb4d134e1a0bd0387b159a3/lib/node/NodeTargetPlugin.js#L81
-                    externals: nodeBuiltInModules,
-                    target: 'node'
-                }
+                target: 'node'
             };
         // TODO: Support `neutral` target, however Rsbuild don't list it as an option in the target field.
         // case 'neutral':
@@ -2020,8 +2024,8 @@ async function composeLibRsbuildConfig(config, configPath) {
     const externalsConfig = composeExternalsConfig(format, config.output?.externals);
     const { config: autoExtensionConfig, jsExtension, dtsExtension } = composeAutoExtensionConfig(config, autoExtension, pkgJson);
     const bundleConfig = composeBundleConfig(jsExtension, redirect, cssModulesAuto, bundle);
-    const targetConfig = composeTargetConfig(config.output?.target);
-    const syntaxConfig = composeSyntaxConfig(config?.syntax, config.output?.target);
+    const { config: targetConfig, target } = composeTargetConfig(config.output?.target);
+    const syntaxConfig = composeSyntaxConfig(target, config?.syntax);
     const autoExternalConfig = composeAutoExternalConfig({
         autoExternal,
         pkgJson,
@@ -2083,7 +2087,7 @@ async function composeCreateRsbuildConfig(rslibConfig, path) {
     const composedRsbuildConfig = await Promise.all(libConfigPromises);
     return composedRsbuildConfig;
 }
-async function initRsbuild(rslibConfig) {
+async function composeRsbuildEnvironments(rslibConfig) {
     const rsbuildConfigObject = await composeCreateRsbuildConfig(rslibConfig);
     const environments = {};
     const formatCount = rsbuildConfigObject.reduce((acc, { format })=>{
@@ -2101,31 +2105,72 @@ async function initRsbuild(rslibConfig) {
         const currentFormatIndex = formatIndex[format]++;
         environments[1 === currentFormatCount ? format : `${format}${currentFormatIndex}`] = config;
     }
-    return (0, __WEBPACK_EXTERNAL_MODULE__rsbuild_core__.createRsbuild)({
+    return environments;
+}
+const pruneEnvironments = (environments, libs)=>{
+    if (!libs) return environments;
+    return Object.fromEntries(Object.entries(environments).filter(([name])=>libs.includes(name)));
+};
+async function build(config, options) {
+    const environments = await composeRsbuildEnvironments(config);
+    const rsbuildInstance = await (0, __WEBPACK_EXTERNAL_MODULE__rsbuild_core__.createRsbuild)({
         rsbuildConfig: {
-            environments
+            environments: pruneEnvironments(environments, options?.lib)
         }
     });
-}
-async function build(config, options) {
-    const rsbuildInstance = await initRsbuild(config);
     await rsbuildInstance.build({
         watch: options?.watch
     });
     return rsbuildInstance;
 }
+async function startMFDevServer(config) {
+    const rsbuildInstance = await initMFRsbuild(config);
+    return rsbuildInstance;
+}
+async function initMFRsbuild(rslibConfig) {
+    const rsbuildConfigObject = await composeCreateRsbuildConfig(rslibConfig);
+    const mfRsbuildConfig = rsbuildConfigObject.find((config)=>'mf' === config.format);
+    if (!mfRsbuildConfig) // no mf format, return.
+    return;
+    mfRsbuildConfig.config = changeEnvToDev(mfRsbuildConfig.config);
+    const rsbuildInstance = await (0, __WEBPACK_EXTERNAL_MODULE__rsbuild_core__.createRsbuild)({
+        rsbuildConfig: mfRsbuildConfig.config
+    });
+    await rsbuildInstance.startDevServer();
+    return rsbuildInstance;
+}
+function changeEnvToDev(rsbuildConfig) {
+    return (0, __WEBPACK_EXTERNAL_MODULE__rsbuild_core__.mergeRsbuildConfig)(rsbuildConfig, {
+        mode: 'development',
+        dev: {
+            writeToDisk: true
+        },
+        tools: {
+            rspack: {
+                optimization: {
+                    nodeEnv: 'development'
+                }
+            }
+        }
+    });
+}
 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');
 };
+const repeatableOption = (value, previous)=>(previous ?? []).concat([
+        value
+    ]);
 function runCli() {
-    __WEBPACK_EXTERNAL_MODULE__compiled_commander_index_js__.program.name('rslib').usage('<command> [options]').version("0.0.15");
+    __WEBPACK_EXTERNAL_MODULE__compiled_commander_index_js__.program.name('rslib').usage('<command> [options]').version("0.0.17");
     const buildCommand = __WEBPACK_EXTERNAL_MODULE__compiled_commander_index_js__.program.command('build');
     const inspectCommand = __WEBPACK_EXTERNAL_MODULE__compiled_commander_index_js__.program.command('inspect');
+    const mfDevCommand = __WEBPACK_EXTERNAL_MODULE__compiled_commander_index_js__.program.command('mf dev');
     [
         buildCommand,
-        inspectCommand
+        inspectCommand,
+        mfDevCommand
     ].forEach(applyCommonOptions);
-    buildCommand.option('-w --watch', 'turn on watch mode, watch for changes and rebuild').description('build the library for production').action(async (options)=>{
+    buildCommand.option('--lib <name>', 'build the specified library (may be repeated)', repeatableOption).option('-w --watch', 'turn on watch mode, watch for changes and rebuild').description('build the library for production').action(async (options)=>{
         try {
             const rslibConfig = await loadConfig({
                 path: options.config,
@@ -2138,14 +2183,19 @@ function runCli() {
             process.exit(1);
         }
     });
-    inspectCommand.description('inspect the Rslib / Rsbuild / Rspack configs').option('--env <env>', 'specify env mode', 'development').option('--output <output>', 'specify inspect content output path', './').option('--verbose', 'show full function definitions in output').action(async (options)=>{
+    inspectCommand.description('inspect the Rsbuild / Rspack configs of Rslib projects').option('--lib <name>', 'inspect the specified library (may be repeated)', repeatableOption).option('--output <output>', 'specify inspect content output path', '.rsbuild').option('--verbose', 'show full function definitions in output').action(async (options)=>{
         try {
             // TODO: inspect should output Rslib's config
             const rslibConfig = await loadConfig({
                 path: options.config,
                 envMode: options.envMode
             });
-            const rsbuildInstance = await initRsbuild(rslibConfig);
+            const environments = await composeRsbuildEnvironments(rslibConfig);
+            const rsbuildInstance = await (0, __WEBPACK_EXTERNAL_MODULE__rsbuild_core__.createRsbuild)({
+                rsbuildConfig: {
+                    environments: pruneEnvironments(environments, options.lib)
+                }
+            });
             await rsbuildInstance.inspectConfig({
                 mode: options.mode,
                 verbose: options.verbose,
@@ -2158,8 +2208,21 @@ function runCli() {
             process.exit(1);
         }
     });
+    mfDevCommand.description('start Rsbuild dev server of Module Federation format').action(async (options)=>{
+        try {
+            const rslibConfig = await loadConfig({
+                path: options.config,
+                envMode: options.envMode
+            });
+            await startMFDevServer(rslibConfig);
+        } catch (err) {
+            __WEBPACK_EXTERNAL_MODULE__compiled_rslog_index_js__.logger.error('Failed to start mf dev.');
+            __WEBPACK_EXTERNAL_MODULE__compiled_rslog_index_js__.logger.error(err);
+            process.exit(1);
+        }
+    });
     __WEBPACK_EXTERNAL_MODULE__compiled_commander_index_js__.program.parse();
 }
-const src_version = "0.0.15";
+const src_version = "0.0.17";
 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 };
+export { build, defineConfig, loadConfig, prepareCli, runCli, composeCreateRsbuildConfig as unstable_composeCreateRsbuildConfig, src_version as version, __webpack_exports__logger as logger };

package/dist-types/build.d.ts

@@ -1,4 +1,4 @@
-import type { RsbuildInstance } from '@rsbuild/core';
+import { type RsbuildInstance } from '@rsbuild/core';
 import type { BuildOptions } from './cli/commands';
 import type { RslibConfig } from './types/config';
 export declare function build(config: RslibConfig, options?: BuildOptions): Promise<RsbuildInstance>;

package/dist-types/cli/commands.d.ts

@@ -1,7 +1,8 @@
-import type { RsbuildMode } from '@rsbuild/core';
+import { type RsbuildMode } from '@rsbuild/core';
 export type CommonOptions = {
     config?: string;
     envMode?: string;
+    lib?: string[];
 };
 export type BuildOptions = CommonOptions & {
     watch?: boolean;

package/dist-types/config.d.ts

@@ -1,4 +1,4 @@
-import { type RsbuildConfig, type RsbuildInstance } from '@rsbuild/core';
+import { type EnvironmentConfig, type RsbuildConfig } from '@rsbuild/core';
 import type { AutoExternal, BannerAndFooter, Format, LibConfig, PkgJson, RslibConfig, RslibConfigAsyncFn, RslibConfigExport, RslibConfigSyncFn } from './types';
 /**
  * This function helps you to autocomplete configuration types.
@@ -27,4 +27,5 @@ export declare function composeCreateRsbuildConfig(rslibConfig: RslibConfig, pat
     format: Format;
     config: RsbuildConfig;
 }[]>;
-export declare function initRsbuild(rslibConfig: RslibConfig): Promise<RsbuildInstance>;
+export declare function composeRsbuildEnvironments(rslibConfig: RslibConfig): Promise<Record<string, EnvironmentConfig>>;
+export declare const pruneEnvironments: (environments: Record<string, EnvironmentConfig>, libs?: string[]) => Record<string, EnvironmentConfig>;

package/dist-types/index.d.ts

@@ -1,6 +1,6 @@
 export { prepareCli } from './cli/prepare';
 export { runCli } from './cli/commands';
-export { defineConfig, loadConfig } from './config';
+export { defineConfig, loadConfig, composeCreateRsbuildConfig as unstable_composeCreateRsbuildConfig, } from './config';
 export { build } from './build';
 export { logger } from './utils/logger';
 export type * from './types';

package/dist-types/mf.d.ts

@@ -0,0 +1,3 @@
+import type { RsbuildInstance } from '@rsbuild/core';
+import type { RslibConfig } from './types';
+export declare function startMFDevServer(config: RslibConfig): Promise<RsbuildInstance | undefined>;

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

@@ -6,11 +6,12 @@ export type LatestEcmaVersions = 'es2024' | 'esnext';
 export type EcmaScriptVersion = FixedEcmaVersions | LatestEcmaVersions;
 export type RsbuildConfigOutputTarget = NonNullable<RsbuildConfig['output']>['target'];
 export type Syntax = EcmaScriptVersion | string[];
-export type Dts = (Pick<PluginDtsOptions, 'bundle' | 'distPath' | 'abortOnError'> & {
+export type Dts = (Pick<PluginDtsOptions, 'bundle' | 'distPath' | 'abortOnError' | 'build'> & {
     autoExtension?: boolean;
 }) | boolean;
 export type AutoExternal = boolean | {
     dependencies?: boolean;
+    optionalDependencies?: boolean;
     devDependencies?: boolean;
     peerDependencies?: boolean;
 };
@@ -33,18 +34,79 @@ export type Redirect = {
     style?: boolean;
 };
 export interface LibConfig extends RsbuildConfig {
-    bundle?: boolean;
+    /**
+     * Output format for the generated JavaScript files.
+     * @default undefined
+     */
     format?: Format;
+    /**
+     * Whether to bundle the library.
+     * @default true
+     */
+    bundle?: boolean;
+    /**
+     * Whether to automatically set the file extension based on the `format` option in the JavaScript output files.
+     * @default true
+     */
     autoExtension?: boolean;
+    /**
+     * Whether to automatically externalize dependencies of different dependency types and do not bundle them.
+     * @default true
+     */
     autoExternal?: AutoExternal;
+    /**
+     * Configure the redirect of the import paths, applicable when `bundle: false`.
+     * @default {}
+     */
     redirect?: Redirect;
-    /** Support esX and browserslist query */
+    /**
+     * Configure the syntax to which JavaScript and CSS will be downgraded.
+     * Support ECMAScript version and browserslist query.
+     * @default 'esnext'
+     */
     syntax?: Syntax;
+    /**
+     * Whether to import SWC helper functions from `@swc/helpers` instead of inlining them.
+     * @default false
+     */
     externalHelpers?: boolean;
+    /**
+     * Inject content into the top of each JS, CSS or DTS file.
+     * @default {}
+     */
     banner?: BannerAndFooter;
+    /**
+     * Inject content into the bottom of each JS, CSS or DTS file.
+     * @default {}
+     */
     footer?: BannerAndFooter;
+    /**
+     * Configure the shims for CommonJS and ESM output.
+     *
+     * @default
+     * ```js
+     * const defaultShims = {
+     *   cjs: {
+     *     'import.meta.url': true,
+     *   },
+     *   esm: {
+     *     __filename: false,
+     *     __dirname: false,
+     *     require: false,
+     *   },
+     * };
+     * ```
+     */
     shims?: Shims;
+    /**
+     * Configure the generation of the TypeScript declaration files.
+     * @default false
+     */
     dts?: Dts;
+    /**
+     * The export name of the UMD bundle.
+     * @default undefined
+     */
     umdName?: string;
 }
 export type LibOnlyConfig = Omit<LibConfig, keyof RsbuildConfig>;

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

@@ -10,4 +10,4 @@ export declare const LATEST_TARGET_VERSIONS: Record<NonNullable<RsbuildConfigOut
  */
 export declare const ESX_TO_BROWSERSLIST: Record<FixedEcmaVersions, Record<string, string | string[]>> & Record<LatestEcmaVersions, (target: RsbuildConfigOutputTarget) => string[]>;
 export declare function transformSyntaxToRspackTarget(syntax: Syntax): Rspack.Configuration['target'];
-export declare function transformSyntaxToBrowserslist(syntax: Syntax, target?: NonNullable<RsbuildConfig['output']>['target']): NonNullable<NonNullable<RsbuildConfig['output']>['overrideBrowserslist']>;
+export declare function transformSyntaxToBrowserslist(syntax: Syntax, target: NonNullable<RsbuildConfig['output']>['target']): NonNullable<NonNullable<RsbuildConfig['output']>['overrideBrowserslist']>;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@rslib/core",
-  "version": "0.0.15",
-  "description": "The Rspack-based library build tool.",
+  "version": "0.0.17",
+  "description": "The Rsbuild-based library development tool.",
   "homepage": "https://lib.rsbuild.dev",
   "bugs": {
     "url": "https://github.com/web-infra-dev/rslib/issues"
@@ -32,9 +32,9 @@
     "compiled"
   ],
   "dependencies": {
-    "@rsbuild/core": "~1.0.18",
+    "@rsbuild/core": "~1.1.0",
     "tinyglobby": "^0.2.10",
-    "rsbuild-plugin-dts": "0.0.15"
+    "rsbuild-plugin-dts": "0.0.17"
   },
   "devDependencies": {
     "@rspack/core": "1.0.8",
@@ -43,8 +43,8 @@
     "fs-extra": "^11.2.0",
     "memfs": "^4.14.0",
     "picocolors": "1.1.1",
-    "prebundle": "1.2.2",
-    "rslib": "npm:@rslib/core@0.0.14",
+    "prebundle": "1.2.5",
+    "rslib": "npm:@rslib/core@0.0.16",
     "rslog": "^1.2.3",
     "tsconfck": "3.1.4",
     "typescript": "^5.6.3",