feat(linter): Support no fail on empty lint run

nrwl · Oct 31, 2023 · 0775a70 · 0775a70
1 parent 8ec589d
commit 0775a70
Show file tree

Hide file tree

Showing 5 changed files with 43 additions and 2 deletions.
diff --git a/docs/generated/packages/eslint/executors/lint.json b/docs/generated/packages/eslint/executors/lint.json
@@ -133,6 +133,11 @@
         "type": "string",
         "description": "The equivalent of the `--print-config` flag on the ESLint CLI.",
         "x-completion-type": "file"
+      },
+      "errorOnUnmatchedPattern": {
+        "type": "boolean",
+        "description": "When set to false, equivalent of the `--no-error-on-unmatched-pattern` flag on the ESLint CLI.",
+        "default": true
       }
     },
     "required": ["lintFilePatterns"],

diff --git a/packages/eslint/src/executors/lint/lint.impl.spec.ts b/packages/eslint/src/executors/lint/lint.impl.spec.ts
@@ -70,6 +70,7 @@ function createValidRunBuilderOptions(
     resolvePluginsRelativeTo: null,
     reportUnusedDisableDirectives: null,
     printConfig: null,
+    errorOnUnmatchedPattern: true,
     ...additionalOptions,
   };
 }
@@ -212,6 +213,34 @@ describe('Linter Builder', () => {
     mockIsPathIgnored.mockReturnValue(Promise.resolve(false));
   });
 
+  it('should not throw if no reports generated and errorOnUnmatchedPattern is false', async () => {
+    mockReports = [];
+    setupMocks();
+    const result = lintExecutor(
+      createValidRunBuilderOptions({
+        lintFilePatterns: ['includedFile1'],
+        errorOnUnmatchedPattern: false,
+      }),
+      mockContext
+    );
+    await expect(result).resolves.not.toThrow();
+  });
+
+  it('should not throw if pattern excluded and errorOnUnmatchedPattern is false', async () => {
+    mockReports = [];
+    setupMocks();
+    mockIsPathIgnored.mockReturnValue(Promise.resolve(true));
+    const result = lintExecutor(
+      createValidRunBuilderOptions({
+        lintFilePatterns: ['includedFile1'],
+        errorOnUnmatchedPattern: false,
+      }),
+      mockContext
+    );
+    await expect(result).resolves.not.toThrow();
+    mockIsPathIgnored.mockReturnValue(Promise.resolve(false));
+  });
+
   it('should create a new instance of the formatter with the selected user option', async () => {
     setupMocks();
     await lintExecutor(

diff --git a/packages/eslint/src/executors/lint/lint.impl.ts b/packages/eslint/src/executors/lint/lint.impl.ts
@@ -39,7 +39,8 @@ export default async function run(
     ? joinPathFragments(options.cacheLocation, projectName)
     : undefined;
 
-  const { printConfig, ...normalizedOptions } = options;
+  const { printConfig, errorOnUnmatchedPattern, ...normalizedOptions } =
+    options;
 
   /**
    * Until ESLint v9 is released and the new so called flat config is the default
@@ -119,7 +120,7 @@ Please see https://nx.dev/guides/eslint for full guidance on how to resolve this
     throw err;
   }
 
-  if (lintResults.length === 0) {
+  if (lintResults.length === 0 && errorOnUnmatchedPattern) {
     const ignoredPatterns = (
       await Promise.all(
         normalizedOptions.lintFilePatterns.map(async (pattern) =>

diff --git a/packages/eslint/src/executors/lint/schema.d.ts b/packages/eslint/src/executors/lint/schema.d.ts
@@ -21,6 +21,7 @@ export interface Schema extends JsonObject {
   resolvePluginsRelativeTo: string | null;
   reportUnusedDisableDirectives: Linter.StringSeverity | null;
   printConfig?: string | null;
+  errorOnUnmatchedPattern?: boolean;
 }
 
 type Formatter =

diff --git a/packages/eslint/src/executors/lint/schema.json b/packages/eslint/src/executors/lint/schema.json
@@ -137,6 +137,11 @@
       "type": "string",
       "description": "The equivalent of the `--print-config` flag on the ESLint CLI.",
       "x-completion-type": "file"
+    },
+    "errorOnUnmatchedPattern": {
+      "type": "boolean",
+      "description": "When set to false, equivalent of the `--no-error-on-unmatched-pattern` flag on the ESLint CLI.",
+      "default": true
     }
   },
   "required": ["lintFilePatterns"],