feat: remove support for ignore files in FlatESLint (#16355)

mdjermanovic · web-flow · commit 6964cb1e0f07 · 2022-10-03T16:10:33.000-07:00
* do not use `gitignoreToMinimatch` on `--ignore-pattern`

* remove .eslintignore lookup

* remove flat-eslint tests that assume .eslintignore lookup

* remove --ignore-path CLI option

* remove ignorePath contructor option

* update docs and jsdoc

* do not use gitIgnoreToMinimatch on ignorePatterns constructor option
diff --git a/Makefile.js b/Makefile.js
@@ -518,11 +518,11 @@ target.lint = function([fix = false] = []) {
      * when analyzing `require()` calls from CJS modules in the `docs` directory. Since our release process does not run `npm install`
      * in the `docs` directory, linting would fail and break the release. Also, working on the main `eslint` package does not require
      * installing dependencies declared in `docs/package.json`, so most contributors will not have `docs/node_modules` locally.
-     * Therefore, we add `--ignore-pattern docs` to exclude linting the `docs` directory from this command.
+     * Therefore, we add `--ignore-pattern "docs/**"` to exclude linting the `docs` directory from this command.
      * There is a separate command `target.lintDocsJS` for linting JavaScript files in the `docs` directory.
      */
     echo("Validating JavaScript files");
-    lastReturn = exec(`${ESLINT}${fix ? "--fix" : ""} . --ignore-pattern docs`);
+    lastReturn = exec(`${ESLINT}${fix ? "--fix" : ""} . --ignore-pattern "docs/**"`);
     if (lastReturn.code !== 0) {
         errors++;
     }
diff --git a/docs/src/user-guide/configuring/configuration-files-new.md b/docs/src/user-guide/configuring/configuration-files-new.md
@@ -132,7 +132,7 @@ This configuration object applies to all files except those ending with `.config
 
 #### Globally ignoring files with `ignores`
 
-If `ignores` is used without any other keys in the configuration object, then the patterns act as additional global ignores, similar to those found in `.eslintignore`. Here's an example:
+If `ignores` is used without any other keys in the configuration object, then the patterns act as global ignores. Here's an example:
 
 ```js
 export default [
@@ -142,7 +142,7 @@ export default [
 ];
 ```
 
-This configuration specifies that all of the files in the `.config` directory should be ignored. This pattern is added after the patterns found in `.eslintignore`.
+This configuration specifies that all of the files in the `.config` directory should be ignored. This pattern is added after the default patterns, which are `["**/node_modules/**", ".git/**"]`.
 
 #### Cascading configuration objects
 
diff --git a/eslint.config.js b/eslint.config.js
@@ -78,6 +78,23 @@ function createInternalFilesPatterns(pattern = null) {
 
 module.exports = [
     ...compat.extends("eslint"),
+    {
+        ignores: [
+            "build/**",
+            "coverage/**",
+            "docs/**",
+            "!docs/.eleventy.js",
+            "jsdoc/**",
+            "templates/**",
+            "tests/bench/**",
+            "tests/fixtures/**",
+            "tests/performance/**",
+            "tmp/**",
+            "tools/internal-rules/node_modules/**",
+            "**/test.js",
+            "!**/.eslintrc.js"
+        ]
+    },
     {
         plugins: {
             "internal-rules": internalPlugin,
diff --git a/lib/cli.js b/lib/cli.js
@@ -25,7 +25,6 @@ const fs = require("fs"),
     RuntimeInfo = require("./shared/runtime-info");
 const { Legacy: { naming } } = require("@eslint/eslintrc");
 const { findFlatConfigFile } = require("./eslint/flat-eslint");
-const { gitignoreToMinimatch } = require("@humanwhocodes/gitignore-to-minimatch");
 const { ModuleImporter } = require("@humanwhocodes/module-importer");
 
 const debug = require("debug")("eslint:cli");
@@ -145,7 +144,7 @@ async function translateOptions({
 
         if (ignorePattern) {
             overrideConfig.push({
-                ignores: ignorePattern.map(gitignoreToMinimatch)
+                ignores: ignorePattern
             });
         }
 
@@ -182,7 +181,6 @@ async function translateOptions({
         fix: (fix || fixDryRun) && (quiet ? quietFixPredicate : true),
         fixTypes: fixType,
         ignore,
-        ignorePath,
         overrideConfig,
         overrideConfigFile,
         reportUnusedDisableDirectives: reportUnusedDisableDirectives ? "error" : void 0
@@ -193,6 +191,7 @@ async function translateOptions({
         options.rulePaths = rulesdir;
         options.useEslintrc = eslintrc;
         options.extensions = ext;
+        options.ignorePath = ignorePath;
     }
 
     return options;
diff --git a/lib/eslint/eslint-helpers.js b/lib/eslint/eslint-helpers.js
@@ -410,7 +410,6 @@ function processOptions({
     fixTypes = null, // ← should be null by default because if it's an array then it suppresses rules that don't have the `meta.type` property.
     globInputPaths = true,
     ignore = true,
-    ignorePath = null, // ← should be null by default because if it's a string then it may throw ENOENT.
     ignorePatterns = null,
     overrideConfig = null,
     overrideConfigFile = null,
@@ -441,6 +440,9 @@ function processOptions({
         if (unknownOptionKeys.includes("globals")) {
             errors.push("'globals' has been removed. Please use the 'overrideConfig.languageOptions.globals' option instead.");
         }
+        if (unknownOptionKeys.includes("ignorePath")) {
+            errors.push("'ignorePath' has been removed.");
+        }
         if (unknownOptionKeys.includes("ignorePattern")) {
             errors.push("'ignorePattern' has been removed. Please use the 'overrideConfig.ignorePatterns' option instead.");
         }
@@ -493,9 +495,6 @@ function processOptions({
     if (typeof ignore !== "boolean") {
         errors.push("'ignore' must be a boolean.");
     }
-    if (!isNonEmptyString(ignorePath) && ignorePath !== null) {
-        errors.push("'ignorePath' must be a non-empty string or null.");
-    }
     if (typeof overrideConfig !== "object") {
         errors.push("'overrideConfig' must be an object or null.");
     }
@@ -538,7 +537,6 @@ function processOptions({
         fixTypes,
         globInputPaths,
         ignore,
-        ignorePath,
         ignorePatterns,
         reportUnusedDisableDirectives
     };
diff --git a/lib/eslint/flat-eslint.js b/lib/eslint/flat-eslint.js
@@ -16,7 +16,6 @@ const findUp = require("find-up");
 const { version } = require("../../package.json");
 const { Linter } = require("../linter");
 const { getRuleFromConfig } = require("../config/flat-config-helpers");
-const { gitignoreToMinimatch } = require("@humanwhocodes/gitignore-to-minimatch");
 const {
     Legacy: {
         ConfigOps: {
@@ -28,7 +27,6 @@ const {
 } = require("@eslint/eslintrc");
 
 const {
-    fileExists,
     findFiles,
     getCacheFile,
 
@@ -76,9 +74,8 @@ const LintResultCache = require("../cli-engine/lint-result-cache");
  * @property {boolean|Function} [fix] Execute in autofix mode. If a function, should return a boolean.
  * @property {string[]} [fixTypes] Array of rule types to apply fixes for.
  * @property {boolean} [globInputPaths] Set to false to skip glob resolution of input file paths to lint (default: true). If false, each input file paths is assumed to be a non-glob path to an existing file.
- * @property {boolean} [ignore] False disables use of .eslintignore.
- * @property {string} [ignorePath] The ignore file to use instead of .eslintignore.
- * @property {string[]} [ignorePatterns] Ignore file patterns to use in addition to .eslintignore.
+ * @property {boolean} [ignore] False disables all ignore patterns except for the default ones.
+ * @property {string[]} [ignorePatterns] Ignore file patterns to use in addition to config ignores.
  * @property {ConfigData} [overrideConfig] Override config object, overrides all configs used with this instance
  * @property {boolean|string} [overrideConfigFile] Searches for default config file when falsy;
  *      doesn't do any config file lookup when `true`; considered to be a config filename
@@ -151,30 +148,6 @@ function calculateStatsPerRun(results) {
     });
 }
 
-/**
- * Loads global ignore patterns from an ignore file (usually .eslintignore).
- * @param {string} filePath The filename to load.
- * @returns {ignore} A function encapsulating the ignore patterns.
- * @throws {Error} If the file cannot be read.
- * @private
- */
-async function loadIgnoreFilePatterns(filePath) {
-    debug(`Loading ignore file: ${filePath}`);
-
-    try {
-        const ignoreFileText = await fs.readFile(filePath, { encoding: "utf8" });
-
-        return ignoreFileText
-            .split(/\r?\n/gu)
-            .filter(line => line.trim() !== "" && !line.startsWith("#"));
-
-    } catch (e) {
-        debug(`Error reading ignore file: ${filePath}`);
-        e.message = `Cannot read ignore file: ${filePath}\nError: ${e.message}`;
-        throw e;
-    }
-}
-
 /**
  * Create rulesMeta object.
  * @param {Map<string,Rule>} rules a map of rules from which to generate the object.
@@ -319,7 +292,6 @@ async function calculateConfigArray(eslint, {
     overrideConfig,
     configFile,
     ignore: shouldIgnore,
-    ignorePath,
     ignorePatterns
 }) {
 
@@ -364,22 +336,6 @@ async function calculateConfigArray(eslint, {
     configs.push(...slots.defaultConfigs);
 
     let allIgnorePatterns = [];
-    let ignoreFilePath;
-
-    // load ignore file if necessary
-    if (shouldIgnore) {
-        if (ignorePath) {
-            ignoreFilePath = path.resolve(cwd, ignorePath);
-            allIgnorePatterns = await loadIgnoreFilePatterns(ignoreFilePath);
-        } else {
-            ignoreFilePath = path.resolve(cwd, ".eslintignore");
-
-            // no error if .eslintignore doesn't exist`
-            if (fileExists(ignoreFilePath)) {
-                allIgnorePatterns = await loadIgnoreFilePatterns(ignoreFilePath);
-            }
-        }
-    }
 
     // append command line ignore patterns
     if (ignorePatterns) {
@@ -428,7 +384,7 @@ async function calculateConfigArray(eslint, {
          * so they can override default ignores.
          */
         configs.push({
-            ignores: allIgnorePatterns.map(gitignoreToMinimatch)
+            ignores: allIgnorePatterns
         });
     }
 
diff --git a/lib/options.js b/lib/options.js
@@ -129,6 +129,16 @@ module.exports = function(usingFlatConfig) {
         };
     }
 
+    let ignorePathFlag;
+
+    if (!usingFlatConfig) {
+        ignorePathFlag = {
+            option: "ignore-path",
+            type: "path::String",
+            description: "Specify path of ignore file"
+        };
+    }
+
     return optionator({
         prepend: "eslint [options] file.js [file.js] [dir]",
         defaults: {
@@ -203,11 +213,7 @@ module.exports = function(usingFlatConfig) {
             {
                 heading: "Ignoring files"
             },
-            {
-                option: "ignore-path",
-                type: "path::String",
-                description: "Specify path of ignore file"
-            },
+            ignorePathFlag,
             {
                 option: "ignore",
                 type: "Boolean",
diff --git a/package.json b/package.json
@@ -57,7 +57,6 @@
   "dependencies": {
     "@eslint/eslintrc": "^1.3.2",
     "@humanwhocodes/config-array": "^0.10.5",
-    "@humanwhocodes/gitignore-to-minimatch": "^1.0.2",
     "@humanwhocodes/module-importer": "^1.0.1",
     "ajv": "^6.10.0",
     "chalk": "^4.0.0",
diff --git a/tests/fixtures/.eslintignore_empty b/tests/fixtures/.eslintignore_empty
diff --git a/tests/fixtures/cli-engine/eslint.config_with_ignores2.js b/tests/fixtures/cli-engine/eslint.config_with_ignores2.js
@@ -0,0 +1,3 @@
+module.exports = [{
+    ignores: ["**/fixtures/**"]
+}];
diff --git a/tests/fixtures/eslint.config_with_ignores.js b/tests/fixtures/eslint.config_with_ignores.js
@@ -0,0 +1,8 @@
+const eslintConfig = require("./eslint.config.js");
+
+module.exports = [
+    eslintConfig,
+    {
+        ignores: ["**/*.json", "**/*.js"]
+    }
+];
diff --git a/tests/fixtures/eslint.config_with_ignores2.js b/tests/fixtures/eslint.config_with_ignores2.js
@@ -0,0 +1,8 @@
+const eslintConfig = require("./eslint.config.js");
+
+module.exports = [
+    eslintConfig,
+    {
+        ignores: ["**/undef.js", "undef2.js", "**/undef3.js"]
+    }
+];
diff --git a/tests/lib/cli.js b/tests/lib/cli.js
@@ -658,33 +658,39 @@ describe("cli", () => {
 
                 describe("when given a directory with eslint excluded files in the directory", () => {
                     it(`should throw an error and not process any files with configType:${configType}`, async () => {
-                        const ignorePath = getFixturePath(".eslintignore");
+                        const options = useFlatConfig
+                            ? `--config ${getFixturePath("eslint.config_with_ignores.js")}`
+                            : `--ignore-path ${getFixturePath(".eslintignore")}`;
                         const filePath = getFixturePath("cli");
                         const expectedMessage = useFlatConfig
                             ? `All files matched by '${filePath.replace(/\\/gu, "/")}/**/*.js' are ignored.`
                             : `All files matched by '${filePath}' are ignored.`;
 
                         await stdAssert.rejects(async () => {
-                            await cli.execute(`--ignore-path ${ignorePath} ${filePath}`, null, useFlatConfig);
+                            await cli.execute(`${options} ${filePath}`, null, useFlatConfig);
                         }, new Error(expectedMessage));
                     });
                 });
 
                 describe("when given a file in excluded files list", () => {
                     it(`should not process the file with configType:${configType}`, async () => {
-                        const ignorePath = getFixturePath(".eslintignore");
+                        const options = useFlatConfig
+                            ? `--config ${getFixturePath("eslint.config_with_ignores.js")}`
+                            : `--ignore-path ${getFixturePath(".eslintignore")}`;
                         const filePath = getFixturePath("passing.js");
-                        const exit = await cli.execute(`--ignore-path ${ignorePath} ${filePath}`, null, useFlatConfig);
+                        const exit = await cli.execute(`${options} ${filePath}`, null, useFlatConfig);
 
                         // a warning about the ignored file
                         assert.isTrue(log.info.called);
                         assert.strictEqual(exit, 0);
                     });
 
                     it(`should process the file when forced with configType:${configType}`, async () => {
-                        const ignorePath = getFixturePath(".eslintignore");
+                        const options = useFlatConfig
+                            ? `--config ${getFixturePath("eslint.config_with_ignores.js")}`
+                            : `--ignore-path ${getFixturePath(".eslintignore")}`;
                         const filePath = getFixturePath("passing.js");
-                        const exit = await cli.execute(`--ignore-path ${ignorePath} --no-ignore ${filePath}`, null, useFlatConfig);
+                        const exit = await cli.execute(`${options} --no-ignore ${filePath}`, null, useFlatConfig);
 
                         // no warnings
                         assert.isFalse(log.info.called);
@@ -695,13 +701,39 @@ describe("cli", () => {
                 describe("when given a pattern to ignore", () => {
                     it(`should not process any files with configType:${configType}`, async () => {
                         const ignoredFile = getFixturePath("cli/syntax-error.js");
+                        const ignorePathOption = useFlatConfig
+                            ? ""
+                            : "--ignore-path .eslintignore_empty";
                         const filePath = getFixturePath("cli/passing.js");
-                        const exit = await cli.execute(`--ignore-pattern cli/ ${ignoredFile} ${filePath}`, null, useFlatConfig);
+                        const ignorePattern = useFlatConfig ? "cli/**" : "cli/";
+                        const exit = await cli.execute(
+                            `--ignore-pattern ${ignorePattern} ${ignorePathOption} ${ignoredFile} ${filePath}`, null, useFlatConfig
+                        );
 
                         // warnings about the ignored files
                         assert.isTrue(log.info.called);
                         assert.strictEqual(exit, 0);
                     });
+
+                    if (useFlatConfig) {
+                        it("should not ignore files if the pattern is a path to a directory (with trailing slash)", async () => {
+                            const filePath = getFixturePath("cli/syntax-error.js");
+                            const exit = await cli.execute(`--ignore-pattern cli/ ${filePath}`, null, true);
+
+                            // parsing error causes exit code 1
+                            assert.isTrue(log.info.called);
+                            assert.strictEqual(exit, 1);
+                        });
+
+                        it("should not ignore files if the pattern is a path to a directory (without trailing slash)", async () => {
+                            const filePath = getFixturePath("cli/syntax-error.js");
+                            const exit = await cli.execute(`--ignore-pattern cli ${filePath}`, null, true);
+
+                            // parsing error causes exit code 1
+                            assert.isTrue(log.info.called);
+                            assert.strictEqual(exit, 1);
+                        });
+                    }
                 });
 
             });
diff --git a/tests/lib/eslint/flat-eslint.js b/tests/lib/eslint/flat-eslint.js
diff --git a/tests/lib/options.js b/tests/lib/options.js

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+module.exports = [{`
	`2`	`+ ignores: ["/fixtures/"]`
	`3`	`+}];`