feat: support option.excludeOutput (#7)

Co-authored-by: neverland <[email protected]>

Author: spencerHT

README.md

@@ -148,6 +148,23 @@ pluginCheckSyntax({
 });
 ```
 
+### excludeOutput
+
+- **Type:** `RegExp | RegExp[]`
+- **Default:** `undefined`
+
+`excludeOutput` is used to exclude a portion of output files before detection. You can pass in one or more regular expressions to match the paths of output files. Files that match the regular expression will be ignored and will not trigger syntax checking.
+
+- **Example:**
+
+For example, to ignore files under the `dist/js` directory:
+
+```ts
+pluginCheckSyntax({
+  excludeOutput: /dist\/js/,
+});
+```
+
 ## Limitations
 
 1. Check Syntax plugin only checks incompatible syntax in the outputs and cannot detect missing polyfills.

src/CheckSyntaxPlugin.ts

@@ -13,7 +13,7 @@ import type {
   ECMASyntaxError,
   EcmaVersion,
 } from './types.js';
-import { checkIsExcludeSource } from './utils.js';
+import { checkIsExclude } from './utils.js';
 
 type Compiler = Rspack.Compiler;
 type Compilation = Rspack.Compilation;
@@ -32,6 +32,8 @@ export class CheckSyntaxPlugin {
 
   exclude: CheckSyntaxExclude | undefined;
 
+  excludeOutput: CheckSyntaxExclude | undefined;
+
   constructor(
     options: CheckSyntaxOptions &
       Required<Pick<CheckSyntaxOptions, 'targets'>> & {
@@ -40,6 +42,7 @@ export class CheckSyntaxPlugin {
   ) {
     this.targets = options.targets;
     this.exclude = options.exclude;
+    this.excludeOutput = options.excludeOutput;
     this.rootPath = options.rootPath;
     this.ecmaVersion =
       options.ecmaVersion || browserslistToESVersion(this.targets);
@@ -58,7 +61,11 @@ export class CheckSyntaxPlugin {
           .map((a) => {
             // remove query from name
             const resourcePath = a.name.split('?')[0];
-            return resolve(outputPath, resourcePath);
+            const file = resolve(outputPath, resourcePath);
+            if (!checkIsExclude(file, this.excludeOutput)) {
+              return file;
+            }
+            return '';
           });
 
         const files = emittedAssets.filter(
@@ -80,7 +87,7 @@ export class CheckSyntaxPlugin {
       const htmlScripts = await generateHtmlScripts(filepath);
       await Promise.all(
         htmlScripts.map(async (script) => {
-          if (!checkIsExcludeSource(filepath, this.exclude)) {
+          if (!checkIsExclude(filepath, this.exclude)) {
             await this.tryParse(filepath, script);
           }
         }),

src/generateError.ts

@@ -6,7 +6,7 @@ import {
   type CheckSyntaxExclude,
   ECMASyntaxError,
 } from './types.js';
-import { checkIsExcludeSource } from './utils.js';
+import { checkIsExclude } from './utils.js';
 
 export function displayCodePointer(code: string, pos: number) {
   const SUB_LEN = 80;
@@ -48,7 +48,7 @@ export async function generateError({
     });
   }
 
-  if (checkIsExcludeSource(error.source.path, exclude)) {
+  if (checkIsExclude(error.source.path, exclude)) {
     return null;
   }
 

src/types.ts

@@ -2,26 +2,31 @@ import type { ecmaVersion as EcmaVersion } from 'acorn';
 
 export type { EcmaVersion };
 
+export type CheckSyntaxExclude = RegExp | RegExp[];
+
 export type CheckSyntaxOptions = {
   /**
    * The target browser range of the project.
    * Its value is a standard browserslist array.
    */
   targets?: string[];
   /**
-   * The minimum ECMAScript syntax version that can be used in the build artifact.
-   * The priority of `ecmaVersion` is higher than `targets`.
+   * Used to exclude a portion of source files during detection.
+   * You can pass in one or more regular expressions to match the paths of source files.
    */
-  exclude?: RegExp | RegExp[];
+  exclude?: CheckSyntaxExclude;
   /**
-   * Used to exclude a portion of files during detection.
+   * Used to exclude files by output path before detection.
    * You can pass in one or more regular expressions to match the paths of source files.
    */
+  excludeOutput?: CheckSyntaxExclude;
+  /**
+   * The minimum ECMAScript syntax version that can be used in the build artifact.
+   * The priority of `ecmaVersion` is higher than `targets`.
+   */
   ecmaVersion?: EcmaVersion;
 };
 
-export type CheckSyntaxExclude = NonNullable<CheckSyntaxOptions['exclude']>;
-
 export interface Location {
   line: number;
   column: number;

src/utils.ts

@@ -1,6 +1,6 @@
 import type { CheckSyntaxExclude } from './types.js';
 
-export function checkIsExcludeSource(
+export function checkIsExclude(
   path: string,
   exclude?: CheckSyntaxExclude,
 ): boolean {