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) => {
@@ -23,67 +18,50 @@ const getEnvDir = (cwd: string, envDir?: string) => {
 export const parseEntryOption = (
   entries?: string[],
 ): Record<string, string> | undefined => {
-  if (!entries || entries.length === 0) {
-    return undefined;
-  }
+  if (!entries?.length) return undefined;
 
-  const parsed: Record<string, string> = {};
-  let unnamedIndex = 0;
+  const entryList: Array<{ key: string; value: string; explicit: boolean }> =
+    [];
 
   for (const rawEntry of entries) {
     const value = rawEntry?.trim();
-    if (!value) {
-      continue;
-    }
+    if (!value) continue;
 
     const equalIndex = value.indexOf('=');
     if (equalIndex > -1) {
       const name = value.slice(0, equalIndex).trim();
       const entryPath = value.slice(equalIndex + 1).trim();
       if (name && entryPath) {
-        parsed[name] = entryPath;
+        entryList.push({ key: name, value: entryPath, explicit: true });
         continue;
       }
     }
 
-    unnamedIndex += 1;
-    const key = unnamedIndex === 1 ? 'index' : `entry${unnamedIndex}`;
-    parsed[key] = value;
+    const basename = path.basename(value, path.extname(value));
+    entryList.push({ key: basename, value, explicit: false });
   }
 
-  return Object.keys(parsed).length === 0 ? undefined : parsed;
-};
+  const keyCount: Record<string, number> = {};
+  for (const { key, explicit } of entryList) {
+    if (!explicit) keyCount[key] = (keyCount[key] ?? 0) + 1;
+  }
 
-// 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;
-// };
+  const keyIndex: Record<string, number> = {};
+  const parsed: Record<string, string> = {};
+
+  for (const { key, value, explicit } of entryList) {
+    const needsIndex = !explicit && keyCount[key] > 1;
+    const finalKey = needsIndex ? `${key}${keyIndex[key] ?? 0}` : key;
+    if (needsIndex) keyIndex[key] = (keyIndex[key] ?? 0) + 1;
+    parsed[finalKey] = value;
+  }
+
+  return Object.keys(parsed).length ? parsed : undefined;
+};
 
 export const applyCliOptions = (
   config: RslibConfig,
-  options: CommonOptions,
+  options: BuildOptions,
   root: string,
 ): void => {
   if (options.root) config.root = root;
@@ -101,7 +79,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', () => {
@@ -14,46 +10,58 @@ describe('parseEntryOption', () => {
     expect(parseEntryOption(['', '   '])).toBeUndefined();
   });
 
-  test('parses named and positional entries with trimming', () => {
+  test('parses named entries with explicit keys', () => {
     const result = parseEntryOption([
       ' main = ./src/main.ts ',
-      ' ./src/utils.ts ',
       'entry=./src/entry.ts',
-      './src/extra.ts',
     ]);
 
     expect(result).toEqual({
       main: './src/main.ts',
-      index: './src/utils.ts',
       entry: './src/entry.ts',
-      entry2: './src/extra.ts',
     });
   });
-});
 
-describe('parseSyntaxOption', () => {
-  test('returns undefined for missing or whitespace values', () => {
-    expect(parseSyntaxOption()).toBeUndefined();
-    expect(parseSyntaxOption('')).toBeUndefined();
-    expect(parseSyntaxOption('    ')).toBeUndefined();
-  });
+  test('uses basename as key and handles conflicts with index suffix', () => {
+    const result = parseEntryOption([
+      './src/utils.ts', // unique basename
+      './src/extra.js', // unique basename
+      './components/Button.tsx', // unique basename
+      './src/index.ts', // conflicts with other index files
+      './pages/index.tsx', // conflicts with other index files
+      './lib/index.js', // conflicts with other index files
+      './src/home.ts', // conflicts with other home file
+      'custom=./pages/custom.tsx', // explicit key (not affected by conflicts)
+      './lib/home.js', // conflicts with other home file
+    ]);
 
-  test('returns the trimmed ECMAScript version when not a JSON array', () => {
-    expect(parseSyntaxOption(' es2020 ')).toBe('es2020');
+    expect(result).toEqual({
+      utils: './src/utils.ts',
+      extra: './src/extra.js',
+      Button: './components/Button.tsx',
+      index0: './src/index.ts',
+      index1: './pages/index.tsx',
+      index2: './lib/index.js',
+      home0: './src/home.ts',
+      custom: './pages/custom.tsx',
+      home1: './lib/home.js',
+    });
   });
 
-  test('parses JSON array syntax', () => {
-    expect(parseSyntaxOption('["chrome 120", "firefox 115"]')).toEqual([
-      'chrome 120',
-      'firefox 115',
+  test('mixed named and unnamed entries with trimming', () => {
+    const result = parseEntryOption([
+      ' main = ./src/main.ts ',
+      ' ./src/utils.ts ',
+      'entry=./src/entry.ts',
+      './src/extra.ts',
     ]);
-  });
 
-  test('throws descriptive error when JSON parsing fails', () => {
-    const parseInvalidSyntax = () => parseSyntaxOption('[invalid');
-    expect(parseInvalidSyntax).toThrowError(
-      /Failed to parse --syntax option "\[inv.*JSON array/,
-    );
+    expect(result).toEqual({
+      main: './src/main.ts',
+      utils: './src/utils.ts',
+      entry: './src/entry.ts',
+      extra: './src/extra.ts',
+    });
   });
 });
 
@@ -98,7 +106,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,
@@ -127,8 +135,8 @@ describe('applyCliOptions', () => {
     expect(lib.source?.tsconfigPath).toBe('./tsconfig.build.json');
     expect(lib.source?.entry).toEqual({
       main: 'src/main.ts',
-      index: 'src/utils.ts',
-      entry2: 'src/extra.ts',
+      utils: 'src/utils.ts',
+      extra: 'src/extra.ts',
     });
 
     expect(lib.output).toBe(outputBefore);

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';
@@ -186,7 +185,7 @@ describe('build command', async () => {
         lib: [
           {
             bundle: false,
-            source: { entry: { index: './src/*' } },
+            source: { entry: { '*': './src/*' } },
             format: 'esm',
             output: {
               distPath: { root: 'dist/ok' },

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/config/rsbuild/source.mdx

@@ -21,7 +21,11 @@ Replaces variables in your code with other values or expressions at compile time
 
 ## source.entry <RsbuildDocBadge path="/config/source/entry" text="source.entry" />
 
-- **CLI:** `--entry <path>` (repeatable, e.g. `--entry index=src/index.ts` or `--entry src/index.ts`)
+- **CLI:** `--entry <path>`. Can be repeated, e.g., `--entry index=src/index.ts` or `--entry src/index.ts`.
+
+  The CLI argument supports two formats:
+  1. `key=value`: Explicitly specify the entry name, e.g., `--entry main=src/main.ts`
+  2. `value`: Only specify the path, in which case the basename of the file (without extension) will be automatically used as the entry name. For example, `--entry src/index.ts` will generate an entry named `index`. If there are name conflicts, numeric suffixes (starting from 0) will be added to all conflicting entries, e.g., `index0`, `index1`.
 
 Used to set the entry modules for building.
 
@@ -44,7 +48,6 @@ const defaultEntry = {
 };
 ```
 
-When no name is provided, the CLI assigns placeholders such as `index`, `entry2`, etc. automatically.
 :::info
 Check out the [lib.bundle](/config/lib/bundle#set-entry) to learn more about how to set entry for bundle and bundleless project.
 :::

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/config/rsbuild/source.mdx

@@ -20,7 +20,11 @@ import { RsbuildDocBadge } from '@components/RsbuildDocBadge';
 
 ## source.entry <RsbuildDocBadge path="/config/source/entry" text="source.entry" />
 
-- **命令行：** `--entry <path>`（可重复，例如 `--entry index=src/index.ts` 或 `--entry src/index.ts`）
+- **命令行：** `--entry <path>`。可重复，例如 `--entry index=src/index.ts` 或 `--entry src/index.ts`。
+
+  命令行参数支持两种格式：
+  1. `key=value`：显式指定入口名称，例如 `--entry main=src/main.ts`
+  2. `value`：仅指定路径，此时会自动使用文件的 basename（不含扩展名）作为入口名称。例如 `--entry src/index.ts` 会生成名为 `index` 的入口。如果存在同名冲突，则会为所有冲突的入口添加数字后缀（从 0 开始），例如 `index0`、`index1`。
 
 用于设置构建的入口模块。
 
@@ -43,8 +47,6 @@ const defaultEntry = {
 };
 ```
 
-当未显式指定名称时，CLI 会自动使用 `index`、`entry2` 等占位名称。
-
 :::info
 参考 [lib.bundle](/config/lib/bundle#set-entry) 进一步了解如何为 bundle 和 bundleless 项目设置入口。
 :::