eslint 8.24.0 → 8.25.0

package/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");
@@ -38,6 +37,7 @@ const debug = require("debug")("eslint:cli");
 /** @typedef {import("./eslint/eslint").LintMessage} LintMessage */
 /** @typedef {import("./eslint/eslint").LintResult} LintResult */
 /** @typedef {import("./options").ParsedCLIOptions} ParsedCLIOptions */
+/** @typedef {import("./shared/types").ResultsMeta} ResultsMeta */
 
 //------------------------------------------------------------------------------
 // Helpers
@@ -145,7 +145,7 @@ async function translateOptions({
 
         if (ignorePattern) {
             overrideConfig.push({
-                ignores: ignorePattern.map(gitignoreToMinimatch)
+                ignores: ignorePattern
             });
         }
 
@@ -182,7 +182,6 @@ async function translateOptions({
         fix: (fix || fixDryRun) && (quiet ? quietFixPredicate : true),
         fixTypes: fixType,
         ignore,
-        ignorePath,
         overrideConfig,
         overrideConfigFile,
         reportUnusedDisableDirectives: reportUnusedDisableDirectives ? "error" : void 0
@@ -193,6 +192,7 @@ async function translateOptions({
         options.rulePaths = rulesdir;
         options.useEslintrc = eslintrc;
         options.extensions = ext;
+        options.ignorePath = ignorePath;
     }
 
     return options;
@@ -201,7 +201,7 @@ async function translateOptions({
 /**
  * Count error messages.
  * @param {LintResult[]} results The lint results.
- * @returns {{errorCount:number;warningCount:number}} The number of error messages.
+ * @returns {{errorCount:number;fatalErrorCount:number,warningCount:number}} The number of error messages.
  */
 function countErrors(results) {
     let errorCount = 0;
@@ -239,10 +239,11 @@ async function isDirectory(filePath) {
  * @param {LintResult[]} results The results to print.
  * @param {string} format The name of the formatter to use or the path to the formatter.
  * @param {string} outputFile The path for the output file.
+ * @param {ResultsMeta} resultsMeta Warning count and max threshold.
  * @returns {Promise<boolean>} True if the printing succeeds, false if not.
  * @private
  */
-async function printResults(engine, results, format, outputFile) {
+async function printResults(engine, results, format, outputFile, resultsMeta) {
     let formatter;
 
     try {
@@ -252,7 +253,7 @@ async function printResults(engine, results, format, outputFile) {
         return false;
     }
 
-    const output = await formatter.format(results);
+    const output = await formatter.format(results, resultsMeta);
 
     if (output) {
         if (outputFile) {
@@ -407,17 +408,24 @@ const cli = {
             resultsToPrint = ActiveESLint.getErrorResults(resultsToPrint);
         }
 
-        if (await printResults(engine, resultsToPrint, options.format, options.outputFile)) {
+        const resultCounts = countErrors(results);
+        const tooManyWarnings = options.maxWarnings >= 0 && resultCounts.warningCount > options.maxWarnings;
+        const resultsMeta = tooManyWarnings
+            ? {
+                maxWarningsExceeded: {
+                    maxWarnings: options.maxWarnings,
+                    foundWarnings: resultCounts.warningCount
+                }
+            }
+            : {};
 
-            // Errors and warnings from the original unfiltered results should determine the exit code
-            const { errorCount, fatalErrorCount, warningCount } = countErrors(results);
+        if (await printResults(engine, resultsToPrint, options.format, options.outputFile, resultsMeta)) {
 
-            const tooManyWarnings =
-                options.maxWarnings >= 0 && warningCount > options.maxWarnings;
+            // Errors and warnings from the original unfiltered results should determine the exit code
             const shouldExitForFatalErrors =
-                options.exitOnFatalError && fatalErrorCount > 0;
+                options.exitOnFatalError && resultCounts.fatalErrorCount > 0;
 
-            if (!errorCount && tooManyWarnings) {
+            if (!resultCounts.errorCount && tooManyWarnings) {
                 log.error(
                     "ESLint found too many warnings (maximum: %s).",
                     options.maxWarnings
@@ -428,7 +436,7 @@ const cli = {
                 return 2;
             }
 
-            return (errorCount || tooManyWarnings) ? 1 : 0;
+            return (resultCounts.errorCount || tooManyWarnings) ? 1 : 0;
         }
 
         return 2;

package/lib/config/flat-config-array.js

@@ -70,7 +70,7 @@ class FlatConfigArray extends ConfigArray {
         }
 
         /**
-         * The baes config used to build the config array.
+         * The base config used to build the config array.
          * @type {Array<FlatConfig>}
          */
         this[originalBaseConfig] = baseConfig;

package/lib/eslint/eslint-helpers.js

@@ -67,9 +67,9 @@ function isNonEmptyString(x) {
 }
 
 /**
- * Check if a given value is an array of non-empty stringss or not.
+ * Check if a given value is an array of non-empty strings or not.
  * @param {any} x The value to check.
- * @returns {boolean} `true` if `x` is an array of non-empty stringss.
+ * @returns {boolean} `true` if `x` is an array of non-empty strings.
  */
 function isArrayOfNonEmptyString(x) {
     return Array.isArray(x) && x.every(isNonEmptyString);
@@ -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
     };

package/lib/eslint/eslint.js

@@ -36,11 +36,12 @@ const { version } = require("../../package.json");
 /** @typedef {import("../shared/types").Plugin} Plugin */
 /** @typedef {import("../shared/types").Rule} Rule */
 /** @typedef {import("../shared/types").LintResult} LintResult */
+/** @typedef {import("../shared/types").ResultsMeta} ResultsMeta */
 
 /**
  * The main formatter object.
  * @typedef LoadedFormatter
- * @property {function(LintResult[]): string | Promise<string>} format format function.
+ * @property {(results: LintResult[], resultsMeta: ResultsMeta) => string | Promise<string>} format format function.
  */
 
 /**
@@ -625,14 +626,16 @@ class ESLint {
             /**
              * The main formatter method.
              * @param {LintResult[]} results The lint results to format.
+             * @param {ResultsMeta} resultsMeta Warning count and max threshold.
              * @returns {string | Promise<string>} The formatted lint results.
              */
-            format(results) {
+            format(results, resultsMeta) {
                 let rulesMeta = null;
 
                 results.sort(compareResultsByFilePath);
 
                 return formatter(results, {
+                    ...resultsMeta,
                     get cwd() {
                         return options.cwd;
                     },

package/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,
 
@@ -59,6 +57,7 @@ const LintResultCache = require("../cli-engine/lint-result-cache");
 /** @typedef {import("../shared/types").LintMessage} LintMessage */
 /** @typedef {import("../shared/types").ParserOptions} ParserOptions */
 /** @typedef {import("../shared/types").Plugin} Plugin */
+/** @typedef {import("../shared/types").ResultsMeta} ResultsMeta */
 /** @typedef {import("../shared/types").RuleConf} RuleConf */
 /** @typedef {import("../shared/types").Rule} Rule */
 /** @typedef {ReturnType<ConfigArray.extractConfig>} ExtractedConfig */
@@ -76,9 +75,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 +149,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 +293,6 @@ async function calculateConfigArray(eslint, {
     overrideConfig,
     configFile,
     ignore: shouldIgnore,
-    ignorePath,
     ignorePatterns
 }) {
 
@@ -364,22 +337,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 +385,7 @@ async function calculateConfigArray(eslint, {
          * so they can override default ignores.
          */
         configs.push({
-            ignores: allIgnorePatterns.map(gitignoreToMinimatch)
+            ignores: allIgnorePatterns
         });
     }
 
@@ -872,7 +829,7 @@ class FlatESLint {
                 }
 
 
-                // set up fixer for fixtypes if necessary
+                // set up fixer for fixTypes if necessary
                 let fixer = fix;
 
                 if (fix && fixTypesSet) {
@@ -1048,7 +1005,7 @@ class FlatESLint {
      * The following values are allowed:
      * - `undefined` ... Load `stylish` builtin formatter.
      * - A builtin formatter name ... Load the builtin formatter.
-     * - A thirdparty formatter name:
+     * - A third-party formatter name:
      *   - `foo` → `eslint-formatter-foo`
      *   - `@foo` → `@foo/eslint-formatter`
      *   - `@foo/bar` → `@foo/eslint-formatter-bar`
@@ -1114,14 +1071,16 @@ class FlatESLint {
             /**
              * The main formatter method.
              * @param {LintResults[]} results The lint results to format.
+             * @param {ResultsMeta} resultsMeta Warning count and max threshold.
              * @returns {string} The formatted lint results.
              */
-            format(results) {
+            format(results, resultsMeta) {
                 let rulesMeta = null;
 
                 results.sort(compareResultsByFilePath);
 
                 return formatter(results, {
+                    ...resultsMeta,
                     cwd,
                     get rulesMeta() {
                         if (!rulesMeta) {

package/lib/options.js

@@ -67,7 +67,7 @@ const optionator = require("optionator");
 /**
  * Creates the CLI options for ESLint.
  * @param {boolean} usingFlatConfig Indicates if flat config is being used.
- * @returns {Object} The opinionator instance.
+ * @returns {Object} The optionator instance.
  */
 module.exports = function(usingFlatConfig) {
 
@@ -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",

package/lib/rules/id-length.js

@@ -6,6 +6,45 @@
 
 "use strict";
 
+//------------------------------------------------------------------------------
+// Requirements
+//------------------------------------------------------------------------------
+const GraphemeSplitter = require("grapheme-splitter");
+
+//------------------------------------------------------------------------------
+// Helpers
+//------------------------------------------------------------------------------
+
+/**
+ * Checks if the string given as argument is ASCII or not.
+ * @param {string} value A string that you want to know if it is ASCII or not.
+ * @returns {boolean} `true` if `value` is ASCII string.
+ */
+function isASCII(value) {
+    if (typeof value !== "string") {
+        return false;
+    }
+    return /^[\u0020-\u007f]*$/u.test(value);
+}
+
+/** @type {GraphemeSplitter | undefined} */
+let splitter;
+
+/**
+ * Gets the length of the string. If the string is not in ASCII, counts graphemes.
+ * @param {string} value A string that you want to get the length.
+ * @returns {number} The length of `value`.
+ */
+function getStringLength(value) {
+    if (isASCII(value)) {
+        return value.length;
+    }
+    if (!splitter) {
+        splitter = new GraphemeSplitter();
+    }
+    return splitter.countGraphemes(value);
+}
+
 //------------------------------------------------------------------------------
 // Rule Definition
 //------------------------------------------------------------------------------
@@ -130,8 +169,10 @@ module.exports = {
                 const name = node.name;
                 const parent = node.parent;
 
-                const isShort = name.length < minLength;
-                const isLong = name.length > maxLength;
+                const nameLength = getStringLength(name);
+
+                const isShort = nameLength < minLength;
+                const isLong = nameLength > maxLength;
 
                 if (!(isShort || isLong) || exceptions.has(name) || matchesExceptionPattern(name)) {
                     return; // Nothing to report

package/lib/rules/lines-around-comment.js

@@ -15,7 +15,7 @@ const astUtils = require("./utils/ast-utils");
 //------------------------------------------------------------------------------
 
 /**
- * Return an array with with any line numbers that are empty.
+ * Return an array with any line numbers that are empty.
  * @param {Array} lines An array of each line of the file.
  * @returns {Array} An array of line numbers.
  */
@@ -29,7 +29,7 @@ function getEmptyLineNums(lines) {
 }
 
 /**
- * Return an array with with any line numbers that contain comments.
+ * Return an array with any line numbers that contain comments.
  * @param {Array} comments An array of comment tokens.
  * @returns {Array} An array of line numbers.
  */

package/lib/rules/no-loss-of-precision.js

@@ -105,7 +105,7 @@ module.exports = {
         }
 
         /**
-         * Converts an integer to to an object containing the integer's coefficient and order of magnitude
+         * Converts an integer to an object containing the integer's coefficient and order of magnitude
          * @param {string} stringInteger the string representation of the integer being converted
          * @returns {Object} the object containing the integer's coefficient and order of magnitude
          */
@@ -120,7 +120,7 @@ module.exports = {
 
         /**
          *
-         * Converts a float to to an object containing the floats's coefficient and order of magnitude
+         * Converts a float to an object containing the floats's coefficient and order of magnitude
          * @param {string} stringFloat the string representation of the float being converted
          * @returns {Object} the object containing the integer's coefficient and order of magnitude
          */

package/lib/rules/no-use-before-define.js

@@ -68,7 +68,7 @@ function isInClassStaticInitializerRange(node, location) {
 }
 
 /**
- * Checks whether a given scope is the scope of a a class static initializer.
+ * Checks whether a given scope is the scope of a class static initializer.
  * Static initializers are static blocks and initializers of static fields.
  * @param {eslint-scope.Scope} scope A scope to check.
  * @returns {boolean} `true` if the scope is a class static initializer scope.

package/lib/shared/traverser.js

@@ -74,7 +74,7 @@ class Traverser {
     }
 
     /**
-     * Gives a a copy of the ancestor nodes.
+     * Gives a copy of the ancestor nodes.
      * @returns {ASTNode[]} The ancestor nodes.
      */
     parents() {

package/lib/shared/types.js

@@ -190,10 +190,23 @@ module.exports = {};
  * @property {DeprecatedRuleInfo[]} usedDeprecatedRules The list of used deprecated rules.
  */
 
+/**
+ * Information provided when the maximum warning threshold is exceeded.
+ * @typedef {Object} MaxWarningsExceeded
+ * @property {number} maxWarnings Number of warnings to trigger nonzero exit code.
+ * @property {number} foundWarnings Number of warnings found while linting.
+ */
+
+/**
+ * Metadata about results for formatters.
+ * @typedef {Object} ResultsMeta
+ * @property {MaxWarningsExceeded} [maxWarningsExceeded] Present if the maxWarnings threshold was exceeded.
+ */
+
 /**
  * A formatter function.
  * @callback FormatterFunction
  * @param {LintResult[]} results The list of linting results.
- * @param {{cwd: string, rulesMeta: Record<string, RuleMeta>}} [context] A context object.
+ * @param {{cwd: string, maxWarningsExceeded?: MaxWarningsExceeded, rulesMeta: Record<string, RuleMeta>}} [context] A context object.
  * @returns {string | Promise<string>} Formatted text.
  */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "eslint",
-  "version": "8.24.0",
+  "version": "8.25.0",
   "author": "Nicholas C. Zakas <nicholas+npm@nczconsulting.com>",
   "description": "An AST-based pattern checker for JavaScript.",
   "bin": {
@@ -55,9 +55,8 @@
   "homepage": "https://eslint.org",
   "bugs": "https://github.com/eslint/eslint/issues/",
   "dependencies": {
-    "@eslint/eslintrc": "^1.3.2",
+    "@eslint/eslintrc": "^1.3.3",
     "@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",
@@ -121,7 +120,6 @@
     "glob": "^7.1.6",
     "got": "^11.8.3",
     "gray-matter": "^4.0.3",
-    "jsdoc": "^3.5.5",
     "karma": "^6.1.1",
     "karma-chrome-launcher": "^3.1.0",
     "karma-mocha": "^2.0.1",