fix: validate entry correctness in bundle mode (#659)

Author: fi3ework

packages/core/src/cli/commands.ts

@@ -80,7 +80,13 @@ export function runCli(): void {
         await cliBuild();
       } catch (err) {
         logger.error('Failed to build.');
-        logger.error(err);
+        if (err instanceof AggregateError) {
+          for (const error of err.errors) {
+            logger.error(error);
+          }
+        } else {
+          logger.error(err);
+        }
         process.exit(1);
       }
     });

packages/core/src/config.ts

@@ -899,22 +899,40 @@ const composeEntryConfig = async (
   }
 
   if (bundle !== false) {
-    let isFileEntry = false;
+    const entryErrorReasons: string[] = [];
     traverseEntryQuery(entries, (entry) => {
       const entryAbsPath = path.isAbsolute(entry)
         ? entry
         : path.resolve(root, entry);
+      const isDirLike = path.extname(entryAbsPath) === '';
+      const dirError = `Glob pattern ${color.cyan(`"${entry}"`)} is not supported when "bundle" is "true", considering "bundle" to "false" to use bundleless mode, or specify a file entry to bundle. See ${color.green('https://lib.rsbuild.dev/guide/basic/output-structure')} for more details.`;
+
       if (fs.existsSync(entryAbsPath)) {
         const stats = fs.statSync(entryAbsPath);
-        isFileEntry = stats.isFile();
+        if (!stats.isFile()) {
+          // Existed dir.
+          entryErrorReasons.push(dirError);
+        } else {
+          // Existed file.
+        }
+      } else {
+        if (isDirLike) {
+          // Non-existed dir.
+          entryErrorReasons.push(dirError);
+        } else {
+          // Non-existed file.
+          entryErrorReasons.push(
+            `Can't resolve the entry ${color.cyan(`"${entry}"`)} at the location ${color.cyan(`${entryAbsPath}`)}. Please ensure that the file exists.`,
+          );
+        }
       }
 
       return entry;
     });
 
-    if (!isFileEntry) {
-      throw new Error(
-        `Glob pattern is not supported when "bundle" is "true", considering ${color.green('set "bundle" to "false"')} to use bundleless mode. See ${color.green('https://lib.rsbuild.dev/guide/basic/output-structure')} for more details.`,
+    if (entryErrorReasons.length) {
+      throw new AggregateError(
+        entryErrorReasons.map((reason) => new Error(reason)),
       );
     }
 

pnpm-lock.yaml

@@ -124,16 +124,34 @@ test('glob entry bundleless', async () => {
   `);
 });
 
-test('glob entry bundle', async () => {
-  const fixturePath = join(__dirname, 'glob-bundle');
+test('validate entry and throw errors', async () => {
+  const fixturePath = join(__dirname, 'validate');
   let errMsg = '';
   try {
-    await buildAndGetResults({ fixturePath });
+    await buildAndGetResults({
+      fixturePath,
+      configPath: 'bundleWithGlob.config.ts',
+    });
   } catch (e) {
-    errMsg = (e as Error).message;
+    errMsg = (e as AggregateError).errors.join('\n\n');
+  }
+
+  expect(stripAnsi(errMsg)).toMatchInlineSnapshot(`
+    "Error: Glob pattern "./src" is not supported when "bundle" is "true", considering "bundle" to "false" to use bundleless mode, or specify a file entry to bundle. See https://lib.rsbuild.dev/guide/basic/output-structure for more details.
+
+    Error: Glob pattern "!./src/ignored" is not supported when "bundle" is "true", considering "bundle" to "false" to use bundleless mode, or specify a file entry to bundle. See https://lib.rsbuild.dev/guide/basic/output-structure for more details."
+  `);
+
+  try {
+    await buildAndGetResults({
+      fixturePath,
+      configPath: 'nonExistingFile.config.ts',
+    });
+  } catch (e) {
+    errMsg = (e as AggregateError).errors.join('\n\n');
   }
 
   expect(stripAnsi(errMsg)).toMatchInlineSnapshot(
-    `"Glob pattern is not supported when "bundle" is "true", considering set "bundle" to "false" to use bundleless mode. See https://lib.rsbuild.dev/guide/basic/output-structure for more details."`,
+    `"Error: Can't resolve the entry "./src/main.ts" at the location <ROOT>/tests/integration/entry/validate/src/main.ts. Please ensure that the file exists."`,
   );
 });

tests/integration/entry/glob-bundle/rslib.config.ts

@@ -0,0 +1,14 @@
+import { defineConfig } from '@rslib/core';
+import { generateBundleEsmConfig } from 'test-helper';
+
+export default defineConfig({
+  lib: [
+    generateBundleEsmConfig({
+      source: {
+        entry: {
+          index: ['./src', '!./src/ignored'],
+        },
+      },
+    }),
+  ],
+});

tests/integration/entry/index.test.ts

@@ -0,0 +1,14 @@
+import { defineConfig } from '@rslib/core';
+import { generateBundleEsmConfig } from 'test-helper';
+
+export default defineConfig({
+  lib: [
+    generateBundleEsmConfig({
+      source: {
+        entry: {
+          index: ['./src/main.ts'],
+        },
+      },
+    }),
+  ],
+});

tests/integration/entry/validate/bundleWithGlob.config.ts

@@ -1,5 +1,5 @@
 {
-  "name": "entry-glob-bundle-test",
+  "name": "entry-validate-test",
   "version": "1.0.0",
   "private": true,
   "type": "module"