fix: allow name in global ignores, fix --no-ignore for non-global (#18875)

mdjermanovic · web-flow · commit a0dea8ee01cc · 2024-09-12T07:09:55.000+02:00
* fix: allow `name` in global ignores, fix `--no-ignore` for non-global

* enable CI

* pin dev dep to fix CI
diff --git a/lib/config/flat-config-array.js b/lib/config/flat-config-array.js
@@ -19,6 +19,11 @@ const jsPlugin = require("@eslint/js");
 // Helpers
 //-----------------------------------------------------------------------------
 
+/**
+ * Fields that are considered metadata and not part of the config object.
+ */
+const META_FIELDS = new Set(["name"]);
+
 const ruleValidator = new RuleValidator();
 
 /**
@@ -155,15 +160,15 @@ class FlatConfigArray extends ConfigArray {
         }
 
         /*
-         * If `shouldIgnore` is false, we remove any ignore patterns specified
-         * in the config so long as it's not a default config and it doesn't
-         * have a `files` entry.
+         * If a config object has `ignores` and no other non-meta fields, then it's an object
+         * for global ignores. If `shouldIgnore` is false, that object shouldn't apply,
+         * so we'll remove its `ignores`.
          */
         if (
             !this.shouldIgnore &&
             !this[originalBaseConfig].includes(config) &&
             config.ignores &&
-            !config.files
+            Object.keys(config).filter(key => !META_FIELDS.has(key)).length === 1
         ) {
             /* eslint-disable-next-line no-unused-vars -- need to strip off other keys */
             const { ignores, ...otherKeys } = config;
diff --git a/package.json b/package.json
@@ -66,7 +66,7 @@
     "@eslint-community/regexpp": "^4.6.1",
     "@eslint/eslintrc": "^2.1.4",
     "@eslint/js": "8.57.0",
-    "@humanwhocodes/config-array": "^0.11.14",
+    "@humanwhocodes/config-array": "^0.12.3",
     "@humanwhocodes/module-importer": "^1.0.1",
     "@nodelib/fs.walk": "^1.2.8",
     "@ungap/structured-clone": "^1.2.0",
diff --git a/tests/fixtures/eslint.config-with-ignores3.js b/tests/fixtures/eslint.config-with-ignores3.js
@@ -0,0 +1,9 @@
+const eslintConfig = require("./eslint.config.js");
+
+module.exports = [
+    eslintConfig,
+    {
+        name: "Global ignores",
+        ignores: ["**/*.json", "**/*.js"]
+    }
+];
diff --git a/tests/lib/eslint/flat-eslint.js b/tests/lib/eslint/flat-eslint.js
@@ -1549,6 +1549,16 @@ describe("FlatESLint", () => {
                 }, /All files matched by 'tests\/fixtures\/cli-engine\/' are ignored\./u);
             });
 
+            it("should throw an error when all given files are ignored by a config object that has `name`", async () => {
+                eslint = new FlatESLint({
+                    overrideConfigFile: getFixturePath("eslint.config-with-ignores3.js")
+                });
+
+                await assert.rejects(async () => {
+                    await eslint.lintFiles(["tests/fixtures/cli-engine/"]);
+                }, /All files matched by 'tests\/fixtures\/cli-engine\/' are ignored\./u);
+            });
+
             it("should throw an error when all given files are ignored even with a `./` prefix", async () => {
                 eslint = new FlatESLint({
                     overrideConfigFile: getFixturePath("eslint.config_with_ignores.js")
@@ -1682,6 +1692,29 @@ describe("FlatESLint", () => {
                 assert.strictEqual(results[0].suppressedMessages.length, 0);
             });
 
+            it("should return two messages when given a file in excluded files list by a config object that has `name` while ignore is off", async () => {
+                eslint = new FlatESLint({
+                    cwd: getFixturePath(),
+                    ignore: false,
+                    overrideConfigFile: getFixturePath("eslint.config-with-ignores3.js"),
+                    overrideConfig: {
+                        rules: {
+                            "no-undef": 2
+                        }
+                    }
+                });
+                const filePath = fs.realpathSync(getFixturePath("undef.js"));
+                const results = await eslint.lintFiles([filePath]);
+
+                assert.strictEqual(results.length, 1);
+                assert.strictEqual(results[0].filePath, filePath);
+                assert.strictEqual(results[0].messages[0].ruleId, "no-undef");
+                assert.strictEqual(results[0].messages[0].severity, 2);
+                assert.strictEqual(results[0].messages[1].ruleId, "no-undef");
+                assert.strictEqual(results[0].messages[1].severity, 2);
+                assert.strictEqual(results[0].suppressedMessages.length, 0);
+            });
+
             // https://github.com/eslint/eslint/issues/16300
             it("should process ignore patterns relative to basePath not cwd", async () => {
                 eslint = new FlatESLint({
@@ -5724,6 +5757,30 @@ describe("FlatESLint", () => {
                 assert.strictEqual(warnResult.messages[0].ruleId, "no-unused-vars");
                 assert.strictEqual(warnResult.messages[0].severity, 1);
             });
+
+            // https://github.com/eslint/eslint/issues/18261
+            it("should apply to all files except for 'error.js' even with `ignore: false` option", async () => {
+                const engine = new FlatESLint({
+                    cwd,
+                    ignore: false
+                });
+
+                const results = await engine.lintFiles("{error,warn}.js");
+
+                assert.strictEqual(results.length, 2);
+
+                const [errorResult, warnResult] = results;
+
+                assert.strictEqual(errorResult.filePath, path.join(getPath(), "error.js"));
+                assert.strictEqual(errorResult.messages.length, 1);
+                assert.strictEqual(errorResult.messages[0].ruleId, "no-unused-vars");
+                assert.strictEqual(errorResult.messages[0].severity, 2);
+
+                assert.strictEqual(warnResult.filePath, path.join(getPath(), "warn.js"));
+                assert.strictEqual(warnResult.messages.length, 1);
+                assert.strictEqual(warnResult.messages[0].ruleId, "no-unused-vars");
+                assert.strictEqual(warnResult.messages[0].severity, 1);
+            });
         });
 
         describe("config with ignores: ['**/*.json']", () => {
