fix: improve error logs

Author: chenjiahan

README.md

@@ -41,7 +41,7 @@ When Rsbuild detects incompatible advanced syntax in the build artifacts, it wil
 The format of the error logs is as follows, including the source file, artifact location, error reason, and source code:
 
 ```bash
-error   [Syntax Checker] Find some syntax that does not match "ecmaVersion <= 2015":
+error   [@rsbuild/plugin-check-syntax] Find some syntax that does not match "ecmaVersion <= 2015":
 
   Error 1
   source:  /node_modules/foo/index.js:1:0
@@ -80,9 +80,9 @@ export default {
 
 If a syntax error is detected, you can handle it in the following ways:
 
-- If you want to downgrade this syntax to ensure good code compatibility, you can compile the corresponding module through the `source.include` config.
+- If you want to downgrade this syntax to ensure good code compatibility, you can compile the specified module through the `source.include` config.
 - If you don't want to downgrade the syntax, you can adjust the project's browserslist to match the syntax.
-- If you do not want to check the syntax of specific files, you can use the `checkSyntax.exclude` configuration to exclude the files to be checked.
+- If you don't want to check the syntax of specified files, you can use the `exclude` option to exclude the files to be checked.
 
 ## Options
 

playground/rsbuild.config.ts

@@ -1,6 +1,16 @@
+import path from 'node:path';
 import { defineConfig } from '@rsbuild/core';
 import { pluginCheckSyntax } from '../src';
 
 export default defineConfig({
+  source: {
+    exclude: [path.resolve(__dirname, './src/test.js')],
+  },
+  output: {
+    sourceMap: {
+      js: 'source-map',
+    },
+    overrideBrowserslist: ['ie 11'],
+  },
   plugins: [pluginCheckSyntax()],
 });

playground/src/index.css

@@ -1,8 +1,3 @@
-import './index.css';
+import { printLog } from './test';
 
-document.querySelector('#root').innerHTML = `
-<div class="content">
-  <h1>Vanilla Rsbuild</h1>
-  <p>Start building amazing things with Rsbuild.</p>
-</div>
-`;
+printLog();

playground/src/index.js

@@ -0,0 +1,4 @@
+export const printLog = () => {
+  const arr = [1, 2, 3, 4, [5, 6, [7, 8]]];
+  console.log(arr, arr.flat());
+};

playground/src/test.js

@@ -14,7 +14,7 @@ export function printErrors(
   ecmaVersion: EcmaVersion,
 ): void {
   if (errors.length === 0) {
-    logger.success('The syntax check success.');
+    logger.success('[@rsbuild/plugin-check-syntax] Syntax check passed.');
     return;
   }
 
@@ -31,7 +31,7 @@ export function printErrors(
 
   const expectedVersion = color.yellow(`ecmaVersion <= ${ecmaVersion}`);
   logger.error(
-    `[Syntax Checker] Find some syntax that does not match "${expectedVersion}":\n`,
+    `[@rsbuild/plugin-check-syntax] Find some syntax that does not match "${expectedVersion}":\n`,
   );
 
   errs.forEach((err, index) => {
@@ -40,10 +40,11 @@ export function printErrors(
   });
 
   throw new Error(
-    `[Syntax Checker] The current build fails due to an incompatible syntax, which can be fixed in the following ways:
+    `[@rsbuild/plugin-check-syntax] The current build fails due to an incompatible syntax, which can be fixed in the following ways:
 
-  - If you want to downgrade the syntax, you can compile the corresponding module through the \`source.include\` config.
-  - If you don't want to downgrade the syntax, you can adjust the project's browserslist to match the syntax.`,
+  - If you want to downgrade the syntax, you can compile the specified module through the \`source.include\` config.
+  - If you don't want to downgrade the syntax, you can adjust the project's browserslist to match the syntax.
+  - If you don't want to check the syntax of specified files, you can use the \`exclude\` option to exclude the files to be checked.`,
   );
 }