feat(CLI): add --config-loader option (#1225)

Author: chenjiahan

packages/core/src/cli/commands.ts

@@ -1,5 +1,6 @@
 import type { RsbuildMode } from '@rsbuild/core';
 import cac, { type CAC } from 'cac';
+import type { ConfigLoader } from '../config';
 import { logger } from '../utils/logger';
 import { build } from './build';
 import { init } from './init';
@@ -13,6 +14,7 @@ export type CommonOptions = {
   envDir?: string;
   envMode?: string;
   lib?: string[];
+  configLoader?: ConfigLoader;
 };
 
 export type BuildOptions = CommonOptions & {
@@ -39,6 +41,13 @@ const applyCommonOptions = (cli: CAC) => {
       '--env-mode <mode>',
       'specify the env mode to load the `.env.[mode]` file',
     )
+    .option(
+      '--config-loader <loader>',
+      'Set the config file loader (jiti | native)',
+      {
+        default: 'jiti',
+      },
+    )
     .option('--env-dir <dir>', 'specify the directory to load `.env` files')
     .option(
       '--lib <id>',

packages/core/src/cli/init.ts

@@ -31,6 +31,7 @@ export async function init(options: CommonOptions): Promise<{
     cwd: root,
     path: options.config,
     envMode: options.envMode,
+    loader: options.configLoader,
   });
 
   config.source ||= {};

packages/core/src/config.ts

@@ -119,14 +119,18 @@ const resolveConfigPath = (root: string, customConfig?: string): string => {
   throw new Error(`${DEFAULT_CONFIG_NAME} not found in ${root}`);
 };
 
+export type ConfigLoader = 'jiti' | 'native';
+
 export async function loadConfig({
   cwd = process.cwd(),
   path,
   envMode,
+  loader,
 }: {
   cwd?: string;
   path?: string;
   envMode?: string;
+  loader?: ConfigLoader;
 }): Promise<{
   content: RslibConfig;
   filePath: string;
@@ -136,6 +140,7 @@ export async function loadConfig({
     cwd: dirname(configFilePath),
     path: configFilePath,
     envMode,
+    loader,
   });
 
   return { content: content as RslibConfig, filePath: configFilePath };

tests/integration/cli/build/build.test.ts

@@ -82,6 +82,27 @@ describe('build command', async () => {
     `);
   });
 
+  test('--config-loader', async () => {
+    // Skip Node.js <= 22.18
+    if (!process.features.typescript) {
+      return;
+    }
+
+    await fse.remove(path.join(__dirname, 'dist'));
+    runCliSync('build --config-loader native', {
+      cwd: __dirname,
+    });
+
+    const files = await globContentJSON(path.join(__dirname, 'dist'));
+    const fileNames = Object.keys(files).sort();
+    expect(fileNames).toMatchInlineSnapshot(`
+      [
+        "<ROOT>/tests/integration/cli/build/dist/cjs/index.cjs",
+        "<ROOT>/tests/integration/cli/build/dist/esm/index.js",
+      ]
+    `);
+  });
+
   test('--root', async () => {
     await fse.remove(path.join(__dirname, 'dist'));
     runCliSync('build --root custom-root', {

tests/scripts/index.ts

@@ -1,2 +1,2 @@
-export * from './helper';
-export * from './shared';
+export * from './helper.ts';
+export * from './shared.ts';

tests/scripts/rstest.ts

@@ -1,6 +1,6 @@
 // This file can only be imported by @rstest/core test files
 import { expect } from '@rstest/core';
-import { getFileBySuffix } from './shared';
+import { getFileBySuffix } from './shared.ts';
 
 export function expectFileContainContent(
   files: Record<string, string>,

tests/scripts/shared.ts

@@ -15,7 +15,7 @@ import {
 } from '@rsbuild/core';
 import type { Format, LibConfig, RslibConfig } from '@rslib/core';
 import { build, loadConfig } from '@rslib/core';
-import { globContentJSON } from './helper';
+import { globContentJSON } from './helper.ts';
 
 const __filename = fileURLToPath(import.meta.url);
 const __dirname = dirname(__filename);

tests/scripts/tsconfig.json

@@ -0,0 +1,9 @@
+{
+  "extends": "../tsconfig.json",
+  "compilerOptions": {
+    "module": "nodenext",
+    "moduleResolution": "nodenext"
+  },
+  "include": ["./*.ts"],
+  "exclude": ["**/node_modules", "**/.*/"]
+}

tests/tsconfig.json

@@ -3,16 +3,16 @@
   "compilerOptions": {
     "noEmit": true,
     "composite": true,
-    "allowJs": true
+    "allowJs": true,
+    "allowImportingTsExtensions": true
   },
   "include": [
     "e2e/**/*.ts",
     "integration/**/**.test.ts",
     "integration/**/rslib.config.ts",
     "integration/**/rslib.config.js",
     "benchmark/**/*.ts",
-    "playwright.config.ts",
-    "scripts"
+    "playwright.config.ts"
   ],
   "exclude": ["**/node_modules", "**/.*/"],
   "references": [

website/docs/en/guide/basic/cli.mdx

@@ -26,14 +26,15 @@ Commands:
 
 Rslib CLI provides several common flags that can be used with all commands:
 
-| Flag                    | Description                                                                                                                                                 |
-| ----------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| `-c, --config <config>` | Specify the configuration file, can be a relative or absolute path, see [Specify config file](/guide/basic/configure-rslib#specify-config-file)             |
-| `--env-dir <dir>`       | Specify the directory to load `.env` files, see [Rsbuild - Env directory](https://rsbuild.rs/guide/advanced/env-vars#env-directory)                         |
-| `--env-mode <mode>`     | Specify the env mode to load the `.env.[mode]` file, see [Rsbuild - Env mode](https://rsbuild.rs/guide/advanced/env-vars#env-mode)                          |
-| `-h, --help`            | Display help for command                                                                                                                                    |
-| `--lib <id>`            | Specify the library to run commands (repeatable, e.g. `--lib esm --lib cjs`), see [lib.id](/config/lib/id) to learn how to get or set the ID of the library |
-| `-r, --root <root>`     | Specify the project root directory, can be an absolute path or a path relative to cwd                                                                       |
+| Flag                       | Description                                                                                                                                                 |
+| -------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `-c, --config <config>`    | Specify the configuration file, can be a relative or absolute path, see [Specify config file](/guide/basic/configure-rslib#specify-config-file)             |
+| `--config-loader <loader>` | Set the config file loader (`jiti` \| `native`), see [Specify config loader](/guide/basic/configure-rslib#specify-config-loader)                            |
+| `--env-dir <dir>`          | Specify the directory to load `.env` files, see [Rsbuild - Env directory](https://rsbuild.rs/guide/advanced/env-vars#env-directory)                         |
+| `--env-mode <mode>`        | Specify the env mode to load the `.env.[mode]` file, see [Rsbuild - Env mode](https://rsbuild.rs/guide/advanced/env-vars#env-mode)                          |
+| `-h, --help`               | Display help for command                                                                                                                                    |
+| `--lib <id>`               | Specify the library to run commands (repeatable, e.g. `--lib esm --lib cjs`), see [lib.id](/config/lib/id) to learn how to get or set the ID of the library |
+| `-r, --root <root>`        | Specify the project root directory, can be an absolute path or a path relative to cwd                                                                       |
 
 ## rslib build