cr

Author: fi3ework

packages/core/src/cli/commands.ts

@@ -1,7 +1,7 @@
 import type { LogLevel, RsbuildMode } from '@rsbuild/core';
 import cac, { type CAC } from 'cac';
 import type { ConfigLoader } from '../config';
-import type { Format } from '../types/config';
+import type { Format, Syntax } from '../types/config';
 import { logger } from '../utils/logger';
 import { build } from './build';
 import { initConfig } from './initConfig';
@@ -17,11 +17,15 @@ export type CommonOptions = {
   lib?: string[];
   configLoader?: ConfigLoader;
   logLevel?: LogLevel;
+};
+
+export type BuildOptions = CommonOptions & {
+  watch?: boolean;
   format?: Format;
   entry?: string[];
   distPath?: string;
   bundle?: boolean;
-  syntax?: string;
+  syntax?: Syntax;
   target?: string;
   dts?: boolean;
   externals?: string[];
@@ -32,10 +36,6 @@ export type CommonOptions = {
   tsconfig?: string;
 };
 
-export type BuildOptions = CommonOptions & {
-  watch?: boolean;
-};
-
 export type InspectOptions = CommonOptions & {
   mode?: RsbuildMode;
   output?: string;

packages/core/src/cli/initConfig.ts

@@ -2,15 +2,10 @@ import path from 'node:path';
 import util from 'node:util';
 import { loadEnv, type RsbuildEntry } from '@rsbuild/core';
 import { loadConfig } from '../config';
-import type {
-  EcmaScriptVersion,
-  RsbuildConfigOutputTarget,
-  RslibConfig,
-  Syntax,
-} from '../types';
+import type { RsbuildConfigOutputTarget, RslibConfig } from '../types';
 import { getAbsolutePath } from '../utils/helper';
 import { logger } from '../utils/logger';
-import type { CommonOptions } from './commands';
+import type { BuildOptions, CommonOptions } from './commands';
 import { onBeforeRestart } from './restart';
 
 const getEnvDir = (cwd: string, envDir?: string) => {
@@ -54,36 +49,9 @@ export const parseEntryOption = (
   return Object.keys(parsed).length === 0 ? undefined : parsed;
 };
 
-// export const parseSyntaxOption = (syntax?: string): Syntax | undefined => {
-//   if (!syntax) {
-//     return undefined;
-//   }
-
-//   const trimmed = syntax.trim();
-//   if (!trimmed) {
-//     return undefined;
-//   }
-
-//   if (trimmed.startsWith('[')) {
-//     try {
-//       const parsed = JSON.parse(trimmed);
-//       if (Array.isArray(parsed)) {
-//         return parsed;
-//       }
-//     } catch (e) {
-//       const reason = e instanceof Error ? e.message : String(e);
-//       throw new Error(
-//         `Failed to parse --syntax option "${trimmed}" as JSON array: ${reason}`,
-//       );
-//     }
-//   }
-
-//   return trimmed as EcmaScriptVersion;
-// };
-
 export const applyCliOptions = (
   config: RslibConfig,
-  options: CommonOptions,
+  options: BuildOptions,
   root: string,
 ): void => {
   if (options.root) config.root = root;
@@ -101,7 +69,7 @@ export const applyCliOptions = (
       lib.source ||= {};
       lib.source.entry = entry as RsbuildEntry;
     }
-    const syntax = options.syntax as Syntax | undefined;
+    const syntax = options.syntax;
     if (syntax !== undefined) lib.syntax = syntax;
     if (options.dts !== undefined) lib.dts = options.dts;
     if (options.autoExtension !== undefined)

packages/core/tests/cli.test.ts

@@ -1,10 +1,6 @@
 import { describe, expect, test } from '@rstest/core';
 import type { CommonOptions } from '../src/cli/commands';
-import {
-  applyCliOptions,
-  parseEntryOption,
-  parseSyntaxOption,
-} from '../src/cli/initConfig';
+import { applyCliOptions, parseEntryOption } from '../src/cli/initConfig';
 import type { RslibConfig } from '../src/types';
 
 describe('parseEntryOption', () => {
@@ -31,32 +27,6 @@ describe('parseEntryOption', () => {
   });
 });
 
-describe('parseSyntaxOption', () => {
-  test('returns undefined for missing or whitespace values', () => {
-    expect(parseSyntaxOption()).toBeUndefined();
-    expect(parseSyntaxOption('')).toBeUndefined();
-    expect(parseSyntaxOption('    ')).toBeUndefined();
-  });
-
-  test('returns the trimmed ECMAScript version when not a JSON array', () => {
-    expect(parseSyntaxOption(' es2020 ')).toBe('es2020');
-  });
-
-  test('parses JSON array syntax', () => {
-    expect(parseSyntaxOption('["chrome 120", "firefox 115"]')).toEqual([
-      'chrome 120',
-      'firefox 115',
-    ]);
-  });
-
-  test('throws descriptive error when JSON parsing fails', () => {
-    const parseInvalidSyntax = () => parseSyntaxOption('[invalid');
-    expect(parseInvalidSyntax).toThrowError(
-      /Failed to parse --syntax option "\[inv.*JSON array/,
-    );
-  });
-});
-
 describe('applyCliOptions', () => {
   test('applies CLI flags to the config and its libraries', () => {
     const config = {
@@ -98,7 +68,7 @@ describe('applyCliOptions', () => {
       bundle: false,
       tsconfig: './tsconfig.build.json',
       entry: [' main=src/main.ts ', ' src/utils.ts ', 'src/extra.ts'],
-      syntax: '["node 18"]',
+      syntax: ['node 18'],
       dts: true,
       autoExtension: false,
       autoExternal: false,

packages/core/tests/config.test.ts

@@ -2,6 +2,7 @@ import { join } from 'node:path';
 import { pluginModuleFederation } from '@module-federation/rsbuild-plugin';
 import { inspect } from '@rslib/core';
 import { describe, expect, rs, test } from '@rstest/core';
+import type { BuildOptions } from '../src/cli/commands';
 import { initConfig } from '../src/cli/initConfig';
 import {
   composeCreateRsbuildConfig,
@@ -155,7 +156,7 @@ describe('CLI options', () => {
     const fixtureDir = join(__dirname, 'fixtures/config/cli-options');
     const configFilePath = join(fixtureDir, 'rslib.config.ts');
 
-    const { config } = await initConfig({
+    const options: BuildOptions = {
       config: configFilePath,
       entry: ['index=src/main.ts', 'utils=src/utils.ts'],
       distPath: 'build',
@@ -169,8 +170,9 @@ describe('CLI options', () => {
       autoExtension: false,
       autoExternal: false,
       tsconfig: 'tsconfig.build.json',
-    });
+    };
 
+    const { config } = await initConfig(options);
     expect(config).toMatchInlineSnapshot(`
       {
         "_privateMeta": {

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

@@ -1,4 +1,3 @@
-import os from 'node:os';
 import path from 'node:path';
 import { stripVTControlCharacters as stripAnsi } from 'node:util';
 import { describe, expect, test } from '@rstest/core';

tests/integration/preserve-jsx/index.test.ts

@@ -1,4 +1,5 @@
 import { join } from 'node:path';
+import { stripVTControlCharacters as stripAnsi } from 'node:util';
 import { expect, test } from '@rstest/core';
 import { buildAndGetResults, proxyConsole, queryContent } from 'test-helper';
 
@@ -48,7 +49,7 @@ test('throw error when preserve JSX with bundle mode', async () => {
   try {
     await buildAndGetResults({ fixturePath });
   } catch {
-    expect(logs).toMatchInlineSnapshot(`
+    expect(logs.map((l) => stripAnsi(l))).toMatchInlineSnapshot(`
       [
         "error   Bundle mode does not support preserving JSX syntax. Set "bundle" to "false" or change the JSX runtime to \`automatic\` or \`classic\`. Check out https://rslib.rs/guide/solution/react#jsx-transform for more details.",
       ]

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

@@ -46,7 +46,20 @@ Usage:
   $ rslib build
 
 Options:
-  -w --watch            turn on watch mode, watch for changes and rebuild
+  -w, --watch            turn on watch mode, watch for changes and rebuild
+  --entry <entry>        set entry file or pattern (repeatable)
+  --dist-path <dir>      set output directory
+  --bundle               enable bundle mode (use --no-bundle to disable)
+  --format <format>      specify the output format (esm | cjs | umd | mf | iife)
+  --syntax <syntax>      set build syntax target (repeatable)
+  --target <target>      set runtime target (web | node)
+  --dts                  emit declaration files (use --no-dts to disable)
+  --externals <pkg>      add package to externals (repeatable)
+  --minify               minify output (use --no-minify to disable)
+  --clean                clean output directory before build (use --no-clean to disable)
+  --auto-extension       control automatic extension redirect (use --no-auto-extension to disable)
+  --auto-external        control automatic dependency externalization (use --no-auto-external to disable)
+  --tsconfig <path>      use specific tsconfig (relative to project root)
 ```
 
 ### Environment variables

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

@@ -46,7 +46,20 @@ Usage:
   $ rslib build
 
 Options:
-  -w --watch            开启 watch 模式, 监听文件变更并重新构建
+  -w, --watch            开启 watch 模式，监听文件变更并重新构建
+  --entry <entry>        设置入口文件或匹配模式（可重复传递）
+  --dist-path <dir>      设置输出目录
+  --bundle               启用 bundle 模式（使用 --no-bundle 禁用）
+  --format <format>      指定输出格式（esm | cjs | umd | mf | iife）
+  --syntax <syntax>      指定构建语法目标（可重复传递）
+  --target <target>      指定运行时目标（web | node）
+  --dts                  生成声明文件（使用 --no-dts 禁用）
+  --externals <pkg>      将依赖加入 externals（可重复传递）
+  --minify               压缩输出（使用 --no-minify 禁用）
+  --clean                构建前清理输出目录（使用 --no-clean 禁用）
+  --auto-extension       控制自动补全扩展名重定向（使用 --no-auto-extension 禁用）
+  --auto-external        控制自动外部化依赖（使用 --no-auto-external 禁用）
+  --tsconfig <path>      使用指定的 tsconfig（相对于项目根目录）
 ```
 
 ### 环境变量