eslint - npm Package Compare versions

Comparing version 8.55.0 to 8.56.0

lib/cli-engine/cli-engine.js

@@ -86,3 +86,3 @@ /**
  * @property {string[]} [rulePaths] An array of directories to load custom rules from.
- * @property {boolean} [reportUnusedDisableDirectives] `true` adds reports for unused eslint-disable directives
+ * @property {boolean|string} [reportUnusedDisableDirectives] `true`, `"error"` or '"warn"' adds reports for unused eslint-disable directives
  * @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.
@@ -228,3 +228,3 @@ * @property {string} [resolvePluginsRelativeTo] The folder where plugins should be resolved from, defaulting to the CWD
  * @param {boolean} config.allowInlineConfig If `true` then it uses directive comments.
- * @param {boolean} config.reportUnusedDisableDirectives If `true` then it reports unused `eslint-disable` comments.
+ * @param {boolean|string} config.reportUnusedDisableDirectives If `true`, `"error"` or '"warn"', then it reports unused `eslint-disable` comments.
  * @param {FileEnumerator} config.fileEnumerator The file enumerator to check if a path is a target or not.
@@ -231,0 +231,0 @@ * @param {Linter} config.linter The linter instance to verify.

lib/cli.js

@@ -25,3 +25,4 @@ /**
     log = require("./shared/logging"),
-    RuntimeInfo = require("./shared/runtime-info");
+    RuntimeInfo = require("./shared/runtime-info"),
+    { normalizeSeverityToString } = require("./shared/severity");
 const { Legacy: { naming } } = require("@eslint/eslintrc");
@@ -93,2 +94,3 @@ const { ModuleImporter } = require("@humanwhocodes/module-importer");
     reportUnusedDisableDirectives,
+    reportUnusedDisableDirectivesSeverity,
     resolvePluginsRelativeTo,
@@ -130,2 +132,10 @@ rule,
 
+        if (reportUnusedDisableDirectives || reportUnusedDisableDirectivesSeverity !== void 0) {
+            overrideConfig[0].linterOptions = {
+                reportUnusedDisableDirectives: reportUnusedDisableDirectives
+                    ? "error"
+                    : normalizeSeverityToString(reportUnusedDisableDirectivesSeverity)
+            };
+        }
+
         if (parser) {
@@ -183,4 +193,3 @@ overrideConfig[0].languageOptions.parser = await importer.import(parser);
         overrideConfig,
-        overrideConfigFile,
-        reportUnusedDisableDirectives: reportUnusedDisableDirectives ? "error" : void 0
+        overrideConfigFile
     };
@@ -197,2 +206,7 @@
         options.ignorePath = ignorePath;
+        if (reportUnusedDisableDirectives || reportUnusedDisableDirectivesSeverity !== void 0) {
+            options.reportUnusedDisableDirectives = reportUnusedDisableDirectives
+                ? "error"
+                : normalizeSeverityToString(reportUnusedDisableDirectivesSeverity);
+        }
     }
@@ -394,2 +408,7 @@
 
+        if (options.reportUnusedDisableDirectives && options.reportUnusedDisableDirectivesSeverity !== void 0) {
+            log.error("The --report-unused-disable-directives option and the --report-unused-disable-directives-severity option cannot be used together.");
+            return 2;
+        }
+
         const ActiveESLint = usingFlatConfig ? FlatESLint : ESLint;
@@ -396,0 +415,0 @@

lib/config/flat-config-schema.js

@@ -17,2 +17,3 @@ /**
 const structuredClone = require("@ungap/structured-clone").default;
+const { normalizeSeverityToNumber } = require("../shared/severity");
 
@@ -266,3 +267,23 @@ //-----------------------------------------------------------------------------
 
+const ALLOWED_SEVERITIES = new Set(["error", "warn", "off", 2, 1, 0]);
+
 /** @type {ObjectPropertySchema} */
+const disableDirectiveSeveritySchema = {
+    merge(first, second) {
+        const value = second === void 0 ? first : second;
+
+        if (typeof value === "boolean") {
+            return value ? "warn" : "off";
+        }
+
+        return normalizeSeverityToNumber(value);
+    },
+    validate(value) {
+        if (!(ALLOWED_SEVERITIES.has(value) || typeof value === "boolean")) {
+            throw new TypeError("Expected one of: \"error\", \"warn\", \"off\", 0, 1, 2, or a boolean.");
+        }
+    }
+};
+
+/** @type {ObjectPropertySchema} */
 const deepObjectAssignSchema = {
@@ -539,3 +560,3 @@ merge(first = {}, second = {}) {
             noInlineConfig: booleanSchema,
-            reportUnusedDisableDirectives: booleanSchema
+            reportUnusedDisableDirectives: disableDirectiveSeveritySchema
         }
@@ -542,0 +563,0 @@ },

lib/eslint/eslint-helpers.js

@@ -678,3 +678,2 @@ /**
     plugins = {},
-    reportUnusedDisableDirectives = null, // ← should be null by default because if it's a string then it overrides the 'reportUnusedDisableDirectives' setting in config files. And we cannot use `overrideConfig.reportUnusedDisableDirectives` instead because we cannot configure the `error` severity with that.
     warnIgnored = true,
@@ -724,2 +723,5 @@ ...unknownOptions
         }
+        if (unknownOptionKeys.includes("reportUnusedDisableDirectives")) {
+            errors.push("'reportUnusedDisableDirectives' has been removed. Please use the 'overrideConfig.linterOptions.reportUnusedDisableDirectives' option instead.");
+        }
     }
@@ -779,10 +781,2 @@ if (typeof allowInlineConfig !== "boolean") {
     }
-    if (
-        reportUnusedDisableDirectives !== "error" &&
-        reportUnusedDisableDirectives !== "warn" &&
-        reportUnusedDisableDirectives !== "off" &&
-        reportUnusedDisableDirectives !== null
-    ) {
-        errors.push("'reportUnusedDisableDirectives' must be any of \"error\", \"warn\", \"off\", and null.");
-    }
     if (typeof warnIgnored !== "boolean") {
@@ -812,3 +806,2 @@ errors.push("'warnIgnored' must be a boolean.");
         ignorePatterns,
-        reportUnusedDisableDirectives,
         warnIgnored
@@ -815,0 +808,0 @@ };

lib/eslint/flat-eslint.js

@@ -14,2 +14,3 @@ /**
 const fs = require("fs").promises;
+const { existsSync } = require("fs");
 const path = require("path");
@@ -87,3 +88,2 @@ const findUp = require("find-up");
  * @property {Record<string,Plugin>} [plugins] An array of plugin implementations.
- * @property {"error" | "warn" | "off"} [reportUnusedDisableDirectives] the severity to report unused eslint-disable directives.
  * @property {boolean} warnIgnored Show warnings when the file list includes ignored files
@@ -453,3 +453,2 @@ */
  * @param {boolean} config.allowInlineConfig If `true` then it uses directive comments.
- * @param {boolean} config.reportUnusedDisableDirectives If `true` then it reports unused `eslint-disable` comments.
  * @param {Linter} config.linter The linter instance to verify.
@@ -466,3 +465,2 @@ * @returns {LintResult} The result of linting.
     allowInlineConfig,
-    reportUnusedDisableDirectives,
     linter
@@ -487,3 +485,2 @@ }) {
             fix,
-            reportUnusedDisableDirectives,
 
@@ -756,3 +753,2 @@ /**
             fixTypes,
-            reportUnusedDisableDirectives,
             globInputPaths,
@@ -775,3 +771,3 @@ errorOnUnmatchedPattern,
                 // Ignore errors when no such file exists or file system is read only (and cache file does not exist)
-                if (errorCode !== "ENOENT" && !(errorCode === "EROFS" && !(await fs.exists(cacheFilePath)))) {
+                if (errorCode !== "ENOENT" && !(errorCode === "EROFS" && !existsSync(cacheFilePath))) {
                     throw error;
@@ -868,3 +864,2 @@ }
                             allowInlineConfig,
-                            reportUnusedDisableDirectives,
                             linter
@@ -954,3 +949,2 @@ });
             fix,
-            reportUnusedDisableDirectives,
             warnIgnored: constructorWarnIgnored
@@ -979,3 +973,2 @@ } = eslintOptions;
                 allowInlineConfig,
-                reportUnusedDisableDirectives,
                 linter
@@ -982,0 +975,0 @@ }));

lib/linter/config-comment-parser.js

@@ -18,3 +18,6 @@ /**
         }
-    } = require("@eslint/eslintrc/universal");
+    } = require("@eslint/eslintrc/universal"),
+    {
+        directivesPattern
+    } = require("../shared/directives");
 
@@ -152,2 +155,33 @@ const debug = require("debug")("eslint:config-comment-parser");
 
+    /**
+     * Extract the directive and the justification from a given directive comment and trim them.
+     * @param {string} value The comment text to extract.
+     * @returns {{directivePart: string, justificationPart: string}} The extracted directive and justification.
+     */
+    extractDirectiveComment(value) {
+        const match = /\s-{2,}\s/u.exec(value);
+
+        if (!match) {
+            return { directivePart: value.trim(), justificationPart: "" };
+        }
+
+        const directive = value.slice(0, match.index).trim();
+        const justification = value.slice(match.index + match[0].length).trim();
+
+        return { directivePart: directive, justificationPart: justification };
+    }
+
+    /**
+     * Parses a directive comment into directive text and value.
+     * @param {Comment} comment The comment node with the directive to be parsed.
+     * @returns {{directiveText: string, directiveValue: string}} The directive text and value.
+     */
+    parseDirective(comment) {
+        const { directivePart } = this.extractDirectiveComment(comment.value);
+        const match = directivesPattern.exec(directivePart);
+        const directiveText = match[1];
+        const directiveValue = directivePart.slice(match.index + directiveText.length);
+
+        return { directiveText, directiveValue };
+    }
 };

lib/options.js

@@ -51,2 +51,3 @@ /**
  * @property {boolean | undefined} reportUnusedDisableDirectives Adds reported errors for unused eslint-disable and eslint-enable directives
+ * @property {string | undefined} reportUnusedDisableDirectivesSeverity A severity string indicating if and how unused disable and enable directives should be tracked and reported.
  * @property {string} [resolvePluginsRelativeTo] A folder where plugins should be resolved from, CWD by default
@@ -311,2 +312,9 @@ * @property {Object} [rule] Specify rules
             {
+                option: "report-unused-disable-directives-severity",
+                type: "String",
+                default: void 0,
+                description: "Chooses severity level for reporting unused eslint-disable and eslint-enable directives",
+                enum: ["off", "warn", "error", "0", "1", "2"]
+            },
+            {
                 heading: "Caching"
@@ -313,0 +321,0 @@ },

lib/rules/no-invalid-this.js

@@ -99,3 +99,3 @@ /**
                     const scope = sourceCode.getScope(node);
-                    const features = context.parserOptions.ecmaFeatures || {};
+                    const features = context.languageOptions.parserOptions.ecmaFeatures || {};
 
@@ -102,0 +102,0 @@ // `this` at the top level of scripts always refers to the global object

lib/rules/no-promise-executor-return.js

@@ -212,8 +212,11 @@ /**
 
-                    suggest.push({
-                        messageId: "wrapBraces",
-                        fix(fixer) {
-                            return curlyWrapFixer(sourceCode, node, fixer);
-                        }
-                    });
+                    // Do not suggest wrapping an unnamed FunctionExpression in braces as that would be invalid syntax.
+                    if (!(node.body.type === "FunctionExpression" && !node.body.id)) {
+                        suggest.push({
+                            messageId: "wrapBraces",
+                            fix(fixer) {
+                                return curlyWrapFixer(sourceCode, node, fixer);
+                            }
+                        });
+                    }
 
@@ -220,0 +223,0 @@ context.report({

lib/rules/no-restricted-properties.js

@@ -145,19 +145,2 @@ /**
 
-        /**
-         * Checks property accesses in a destructuring assignment expression, e.g. `var foo; ({foo} = bar);`
-         * @param {ASTNode} node An AssignmentExpression or AssignmentPattern node
-         * @returns {undefined}
-         */
-        function checkDestructuringAssignment(node) {
-            if (node.right.type === "Identifier") {
-                const objectName = node.right.name;
-
-                if (node.left.type === "ObjectPattern") {
-                    node.left.properties.forEach(property => {
-                        checkPropertyAccess(node.left, objectName, astUtils.getStaticPropertyName(property));
-                    });
-                }
-            }
-        }
-
         return {
@@ -167,17 +150,21 @@ MemberExpression(node) {
             },
-            VariableDeclarator(node) {
-                if (node.init && node.init.type === "Identifier") {
-                    const objectName = node.init.name;
+            ObjectPattern(node) {
+                let objectName = null;
 
-                    if (node.id.type === "ObjectPattern") {
-                        node.id.properties.forEach(property => {
-                            checkPropertyAccess(node.id, objectName, astUtils.getStaticPropertyName(property));
-                        });
+                if (node.parent.type === "VariableDeclarator") {
+                    if (node.parent.init && node.parent.init.type === "Identifier") {
+                        objectName = node.parent.init.name;
                     }
+                } else if (node.parent.type === "AssignmentExpression" || node.parent.type === "AssignmentPattern") {
+                    if (node.parent.right.type === "Identifier") {
+                        objectName = node.parent.right.name;
+                    }
                 }
-            },
-            AssignmentExpression: checkDestructuringAssignment,
-            AssignmentPattern: checkDestructuringAssignment
+
+                node.properties.forEach(property => {
+                    checkPropertyAccess(node, objectName, astUtils.getStaticPropertyName(property));
+                });
+            }
         };
     }
 };

lib/source-code/source-code.js

@@ -216,20 +216,2 @@ /**
 /**
- * Extract the directive and the justification from a given directive comment and trim them.
- * @param {string} value The comment text to extract.
- * @returns {{directivePart: string, justificationPart: string}} The extracted directive and justification.
- */
-function extractDirectiveComment(value) {
-    const match = /\s-{2,}\s/u.exec(value);
-
-    if (!match) {
-        return { directivePart: value.trim(), justificationPart: "" };
-    }
-
-    const directive = value.slice(0, match.index).trim();
-    const justification = value.slice(match.index + match[0].length).trim();
-
-    return { directivePart: directive, justificationPart: justification };
-}
-
-/**
  * Ensures that variables representing built-in properties of the Global Object,
@@ -925,3 +907,3 @@ * and any globals declared by special block comments, are present in the global
 
-            const { directivePart } = extractDirectiveComment(comment.value);
+            const { directivePart } = commentParser.extractDirectiveComment(comment.value);
 
@@ -982,6 +964,3 @@ const directiveMatch = directivesPattern.exec(directivePart);
 
-            const { directivePart } = extractDirectiveComment(comment.value);
-            const match = directivesPattern.exec(directivePart);
-            const directiveText = match[1];
-            const directiveValue = directivePart.slice(match.index + directiveText.length);
+            const { directiveText, directiveValue } = commentParser.parseDirective(comment);
 
@@ -988,0 +967,0 @@ switch (directiveText) {

package.json

 {
   "name": "eslint",
-  "version": "8.55.0",
+  "version": "8.56.0",
   "author": "Nicholas C. Zakas <[e-mail]>",
@@ -68,3 +68,3 @@ "description": "An AST-based pattern checker for JavaScript.",
     "@eslint/eslintrc": "^2.1.4",
-    "@eslint/js": "8.55.0",
+    "@eslint/js": "8.56.0",
     "@humanwhocodes/config-array": "^0.11.13",
@@ -123,7 +123,7 @@ "@humanwhocodes/module-importer": "^1.0.1",
     "eslint-plugin-eslint-comments": "^3.2.0",
-    "eslint-plugin-eslint-plugin": "^5.1.0",
+    "eslint-plugin-eslint-plugin": "^5.2.1",
     "eslint-plugin-internal-rules": "file:tools/internal-rules",
     "eslint-plugin-jsdoc": "^46.2.5",
-    "eslint-plugin-n": "^16.0.0",
-    "eslint-plugin-unicorn": "^42.0.0",
+    "eslint-plugin-n": "^16.4.0",
+    "eslint-plugin-unicorn": "^49.0.0",
     "eslint-release": "^3.2.0",
@@ -141,3 +141,3 @@ "eslump": "^3.0.0",
     "markdown-it-container": "^3.0.0",
-    "markdownlint": "^0.31.1",
+    "markdownlint": "^0.32.0",
     "markdownlint-cli": "^0.37.0",
@@ -144,0 +144,0 @@ "marked": "^4.0.8",

README.md

@@ -106,3 +106,3 @@ [![npm version](https://img.shields.io/npm/v/eslint.svg)](https://www.npmjs.com/package/eslint)
 
-No, ESLint does both traditional linting (looking for problematic patterns) and style checking (enforcement of conventions). You can use ESLint for everything, or you can combine both using Prettier to format your code and ESLint to catch possible errors.
+No, ESLint and Prettier have diffent jobs: ESLint is a linter (looking for problematic patterns) and Prettier is a code formatter. Using both tools is common, refer to [Prettier's documentation](https://prettier.io/docs/en/install#eslint-and-other-linters) to learn how to configure them to work well with each other.
 
@@ -213,3 +213,3 @@ ### Why can't ESLint find my plugins?
 <a href="https://github.com/nzakas">
-<img src="https://github.com/nzakas.png?s=75" width="75" height="75"><br />
+<img src="https://github.com/nzakas.png?s=75" width="75" height="75" alt="Nicholas C. Zakas's Avatar"><br />
 Nicholas C. Zakas
@@ -219,3 +219,3 @@ </a>
 <a href="https://github.com/mdjermanovic">
-<img src="https://github.com/mdjermanovic.png?s=75" width="75" height="75"><br />
+<img src="https://github.com/mdjermanovic.png?s=75" width="75" height="75" alt="Milos Djermanovic's Avatar"><br />
 Milos Djermanovic
@@ -231,3 +231,3 @@ </a>
 <a href="https://github.com/aladdin-add">
-<img src="https://github.com/aladdin-add.png?s=75" width="75" height="75"><br />
+<img src="https://github.com/aladdin-add.png?s=75" width="75" height="75" alt="唯然's Avatar"><br />
 唯然
@@ -237,3 +237,3 @@ </a>
 <a href="https://github.com/snitin315">
-<img src="https://github.com/snitin315.png?s=75" width="75" height="75"><br />
+<img src="https://github.com/snitin315.png?s=75" width="75" height="75" alt="Nitin Kumar's Avatar"><br />
 Nitin Kumar
@@ -249,3 +249,3 @@ </a>
 <a href="https://github.com/bmish">
-<img src="https://github.com/bmish.png?s=75" width="75" height="75"><br />
+<img src="https://github.com/bmish.png?s=75" width="75" height="75" alt="Bryan Mishkin's Avatar"><br />
 Bryan Mishkin
@@ -255,3 +255,3 @@ </a>
 <a href="https://github.com/fasttime">
-<img src="https://github.com/fasttime.png?s=75" width="75" height="75"><br />
+<img src="https://github.com/fasttime.png?s=75" width="75" height="75" alt="Francesco Trotta's Avatar"><br />
 Francesco Trotta
@@ -261,3 +261,3 @@ </a>
 <a href="https://github.com/ota-meshi">
-<img src="https://github.com/ota-meshi.png?s=75" width="75" height="75"><br />
+<img src="https://github.com/ota-meshi.png?s=75" width="75" height="75" alt="Yosuke Ota's Avatar"><br />
 Yosuke Ota
@@ -267,3 +267,3 @@ </a>
 <a href="https://github.com/Tanujkanti4441">
-<img src="https://github.com/Tanujkanti4441.png?s=75" width="75" height="75"><br />
+<img src="https://github.com/Tanujkanti4441.png?s=75" width="75" height="75" alt="Tanuj Kanti's Avatar"><br />
 Tanuj Kanti
@@ -279,3 +279,3 @@ </a>
 <a href="https://github.com/amareshsm">
-<img src="https://github.com/amareshsm.png?s=75" width="75" height="75"><br />
+<img src="https://github.com/amareshsm.png?s=75" width="75" height="75" alt="Amaresh  S M's Avatar"><br />
 Amaresh  S M
@@ -285,3 +285,3 @@ </a>
 <a href="https://github.com/harish-sethuraman">
-<img src="https://github.com/harish-sethuraman.png?s=75" width="75" height="75"><br />
+<img src="https://github.com/harish-sethuraman.png?s=75" width="75" height="75" alt="Strek's Avatar"><br />
 Strek
@@ -291,3 +291,3 @@ </a>
 <a href="https://github.com/kecrily">
-<img src="https://github.com/kecrily.png?s=75" width="75" height="75"><br />
+<img src="https://github.com/kecrily.png?s=75" width="75" height="75" alt="Percy Ma's Avatar"><br />
 Percy Ma
@@ -308,4 +308,4 @@ </a>
 <p><a href="https://engineering.salesforce.com"><img src="https://images.opencollective.com/salesforce/ca8f997/logo.png" alt="Salesforce" height="96"></a> <a href="https://www.airbnb.com/"><img src="https://images.opencollective.com/airbnb/d327d66/logo.png" alt="Airbnb" height="96"></a></p><h3>Silver Sponsors</h3>
-<p><a href="https://liftoff.io/"><img src="https://images.opencollective.com/liftoff/5c4fa84/logo.png" alt="Liftoff" height="64"></a> <a href="https://americanexpress.io"><img src="https://avatars.githubusercontent.com/u/3853301?v=4" alt="American Express" height="64"></a></p><h3>Bronze Sponsors</h3>
-<p><a href="https://themeisle.com"><img src="https://images.opencollective.com/themeisle/d5592fe/logo.png" alt="ThemeIsle" height="32"></a> <a href="https://www.crosswordsolver.org/anagram-solver/"><img src="https://images.opencollective.com/anagram-solver/2666271/logo.png" alt="Anagram Solver" height="32"></a> <a href="https://icons8.com/"><img src="https://images.opencollective.com/icons8/7fa1641/logo.png" alt="Icons8" height="32"></a> <a href="https://discord.com"><img src="https://images.opencollective.com/discordapp/f9645d9/logo.png" alt="Discord" height="32"></a> <a href="https://transloadit.com/"><img src="https://avatars.githubusercontent.com/u/125754?v=4" alt="Transloadit" height="32"></a> <a href="https://www.ignitionapp.com"><img src="https://avatars.githubusercontent.com/u/5753491?v=4" alt="Ignition" height="32"></a> <a href="https://herocoders.com"><img src="https://avatars.githubusercontent.com/u/37549774?v=4" alt="HeroCoders" height="32"></a></p>
+<p><a href="https://liftoff.io/"><img src="https://images.opencollective.com/liftoff/5c4fa84/logo.png" alt="Liftoff" height="64"></a> <a href="https://americanexpress.io"><img src="https://avatars.githubusercontent.com/u/3853301?v=4" alt="American Express" height="64"></a> <a href="https://www.workleap.com"><img src="https://avatars.githubusercontent.com/u/53535748?u=d1e55d7661d724bf2281c1bfd33cb8f99fe2465f&v=4" alt="Workleap" height="64"></a></p><h3>Bronze Sponsors</h3>
+<p><a href="https://themeisle.com"><img src="https://images.opencollective.com/themeisle/d5592fe/logo.png" alt="ThemeIsle" height="32"></a> <a href="https://www.crosswordsolver.org/anagram-solver/"><img src="https://images.opencollective.com/anagram-solver/2666271/logo.png" alt="Anagram Solver" height="32"></a> <a href="https://icons8.com/"><img src="https://images.opencollective.com/icons8/7fa1641/logo.png" alt="Icons8" height="32"></a> <a href="https://discord.com"><img src="https://images.opencollective.com/discordapp/f9645d9/logo.png" alt="Discord" height="32"></a> <a href="https://transloadit.com/"><img src="https://avatars.githubusercontent.com/u/125754?v=4" alt="Transloadit" height="32"></a> <a href="https://www.ignitionapp.com"><img src="https://avatars.githubusercontent.com/u/5753491?v=4" alt="Ignition" height="32"></a> <a href="https://nx.dev"><img src="https://avatars.githubusercontent.com/u/23692104?v=4" alt="Nx" height="32"></a> <a href="https://herocoders.com"><img src="https://avatars.githubusercontent.com/u/37549774?v=4" alt="HeroCoders" height="32"></a></p>
 <!--sponsorsend-->
@@ -312,0 +312,0 @@

No alert changes

Improved metrics

Total package byte prevSize

3034634

increased by0.11%

Number of package files

408

increased by0.25%

Lines of code

71543

increased by0.09%

Worsened metrics

Number of low supply chain risk alerts

16

increased by6.67%

Dependency changes

• + Added@eslint/js@8.56.0(transitive)

• - Removed@eslint/js@8.55.0(transitive)

• Updated@eslint/js@8.56.0