eslint 9.18.0 → 9.19.0

package/README.md

@@ -1,11 +1,9 @@
 [![npm version](https://img.shields.io/npm/v/eslint.svg)](https://www.npmjs.com/package/eslint)
 [![Downloads](https://img.shields.io/npm/dm/eslint.svg)](https://www.npmjs.com/package/eslint)
 [![Build Status](https://github.com/eslint/eslint/workflows/CI/badge.svg)](https://github.com/eslint/eslint/actions)
-[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bhttps%3A%2F%2Fgithub.com%2Feslint%2Feslint.svg?type=shield)](https://app.fossa.io/projects/git%2Bhttps%3A%2F%2Fgithub.com%2Feslint%2Feslint?ref=badge_shield)
-<br />
+<br>
 [![Open Collective Backers](https://img.shields.io/opencollective/backers/eslint)](https://opencollective.com/eslint)
 [![Open Collective Sponsors](https://img.shields.io/opencollective/sponsors/eslint)](https://opencollective.com/eslint)
-[![Follow us on Twitter](https://img.shields.io/twitter/follow/geteslint?label=Follow&style=social)](https://twitter.com/intent/user?screen_name=geteslint)
 
 # ESLint
 
@@ -17,7 +15,8 @@
 [Code of Conduct](https://eslint.org/conduct) |
 [Twitter](https://twitter.com/geteslint) |
 [Discord](https://eslint.org/chat) |
-[Mastodon](https://fosstodon.org/@eslint)
+[Mastodon](https://fosstodon.org/@eslint) |
+[Bluesky](https://bsky.app/profile/eslint.org)
 
 ESLint is a tool for identifying and reporting on patterns found in ECMAScript/JavaScript code. In many ways, it is similar to JSLint and JSHint with a few exceptions:
 
@@ -203,7 +202,27 @@ This means:
 
 ## License
 
-[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bhttps%3A%2F%2Fgithub.com%2Feslint%2Feslint.svg?type=large)](https://app.fossa.io/projects/git%2Bhttps%3A%2F%2Fgithub.com%2Feslint%2Feslint?ref=badge_large)
+MIT License
+
+Copyright OpenJS Foundation and other contributors, <www.openjsf.org>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.
 
 ## Team
 
@@ -298,9 +317,9 @@ to get your logo on our READMEs and [website](https://eslint.org/sponsors).
 
 <h3>Platinum Sponsors</h3>
 <p><a href="https://automattic.com"><img src="https://images.opencollective.com/automattic/d0ef3e1/logo.png" alt="Automattic" height="128"></a> <a href="https://www.airbnb.com/"><img src="https://images.opencollective.com/airbnb/d327d66/logo.png" alt="Airbnb" height="128"></a></p><h3>Gold Sponsors</h3>
-<p><a href="https://trunk.io/"><img src="https://images.opencollective.com/trunkio/fb92d60/avatar.png" alt="trunk.io" height="96"></a></p><h3>Silver Sponsors</h3>
+<p><a href="https://qlty.sh/"><img src="https://images.opencollective.com/qltysh/33d157d/logo.png" alt="Qlty Software" height="96"></a> <a href="https://trunk.io/"><img src="https://images.opencollective.com/trunkio/fb92d60/avatar.png" alt="trunk.io" height="96"></a></p><h3>Silver Sponsors</h3>
 <p><a href="https://www.serptriumph.com/"><img src="https://images.opencollective.com/serp-triumph5/fea3074/logo.png" alt="SERP Triumph" height="64"></a> <a href="https://www.jetbrains.com/"><img src="https://images.opencollective.com/jetbrains/fe76f99/logo.png" alt="JetBrains" height="64"></a> <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" alt="American Express" height="64"></a></p><h3>Bronze Sponsors</h3>
-<p><a href="https://cybozu.co.jp/"><img src="https://images.opencollective.com/cybozu/933e46d/logo.png" alt="Cybozu" 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://www.gitbook.com"><img src="https://avatars.githubusercontent.com/u/7111340" alt="GitBook" height="32"></a> <a href="https://nx.dev"><img src="https://avatars.githubusercontent.com/u/23692104" alt="Nx" height="32"></a> <a href="https://opensource.mercedes-benz.com/"><img src="https://avatars.githubusercontent.com/u/34240465" alt="Mercedes-Benz Group" height="32"></a> <a href="https://herocoders.com"><img src="https://avatars.githubusercontent.com/u/37549774" alt="HeroCoders" height="32"></a></p>
+<p><a href="https://cybozu.co.jp/"><img src="https://images.opencollective.com/cybozu/933e46d/logo.png" alt="Cybozu" 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://www.gitbook.com"><img src="https://avatars.githubusercontent.com/u/7111340" alt="GitBook" height="32"></a> <a href="https://nolebase.ayaka.io"><img src="https://avatars.githubusercontent.com/u/11081491" alt="Neko" height="32"></a> <a href="https://nx.dev"><img src="https://avatars.githubusercontent.com/u/23692104" alt="Nx" height="32"></a> <a href="https://opensource.mercedes-benz.com/"><img src="https://avatars.githubusercontent.com/u/34240465" alt="Mercedes-Benz Group" height="32"></a> <a href="https://herocoders.com"><img src="https://avatars.githubusercontent.com/u/37549774" alt="HeroCoders" height="32"></a></p>
 <h3>Technology Sponsors</h3>
 Technology sponsors allow us to use their products and services for free as part of a contribution to the open source ecosystem and our work.
 <p><a href="https://netlify.com"><img src="https://raw.githubusercontent.com/eslint/eslint.org/main/src/assets/images/techsponsors/netlify-icon.svg" alt="Netlify" height="32"></a> <a href="https://algolia.com"><img src="https://raw.githubusercontent.com/eslint/eslint.org/main/src/assets/images/techsponsors/algolia-icon.svg" alt="Algolia" height="32"></a> <a href="https://1password.com"><img src="https://raw.githubusercontent.com/eslint/eslint.org/main/src/assets/images/techsponsors/1password-icon.svg" alt="1Password" height="32"></a></p>

package/lib/cli.js

@@ -128,6 +128,7 @@ async function translateOptions({
     quiet,
     reportUnusedDisableDirectives,
     reportUnusedDisableDirectivesSeverity,
+    reportUnusedInlineConfigs,
     resolvePluginsRelativeTo,
     rule,
     rulesdir,
@@ -180,6 +181,13 @@ async function translateOptions({
             };
         }
 
+        if (reportUnusedInlineConfigs !== void 0) {
+            overrideConfig[0].linterOptions = {
+                ...overrideConfig[0].linterOptions,
+                reportUnusedInlineConfigs: normalizeSeverityToString(reportUnusedInlineConfigs)
+            };
+        }
+
         if (plugin) {
             overrideConfig[0].plugins = await loadPlugins(importer, plugin);
         }

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

@@ -304,6 +304,20 @@ const disableDirectiveSeveritySchema = {
     }
 };
 
+/** @type {ObjectPropertySchema} */
+const unusedInlineConfigsSeveritySchema = {
+    merge(first, second) {
+        const value = second === void 0 ? first : second;
+
+        return normalizeSeverityToNumber(value);
+    },
+    validate(value) {
+        if (!ALLOWED_SEVERITIES.has(value)) {
+            throw new TypeError("Expected one of: \"error\", \"warn\", \"off\", 0, 1, or 2.");
+        }
+    }
+};
+
 /** @type {ObjectPropertySchema} */
 const deepObjectAssignSchema = {
     merge(first = {}, second = {}) {
@@ -555,7 +569,8 @@ const flatConfigSchema = {
     linterOptions: {
         schema: {
             noInlineConfig: booleanSchema,
-            reportUnusedDisableDirectives: disableDirectiveSeveritySchema
+            reportUnusedDisableDirectives: disableDirectiveSeveritySchema,
+            reportUnusedInlineConfigs: unusedInlineConfigsSeveritySchema
         }
     },
     language: languageSchema,

package/lib/linter/linter.js

@@ -40,7 +40,7 @@ const { FlatConfigArray } = require("../config/flat-config-array");
 const { startTime, endTime } = require("../shared/stats");
 const { RuleValidator } = require("../config/rule-validator");
 const { assertIsRuleSeverity } = require("../config/flat-config-schema");
-const { normalizeSeverityToString } = require("../shared/severity");
+const { normalizeSeverityToString, normalizeSeverityToNumber } = require("../shared/severity");
 const { deepMergeArrays } = require("../shared/deep-merge-arrays");
 const jslang = require("../languages/js");
 const { activeFlags, inactiveFlags } = require("../shared/flags");
@@ -56,6 +56,7 @@ const { VFile } = require("./vfile");
 const { ParserService } = require("../services/parser-service");
 const { FileContext } = require("./file-context");
 const { ProcessorService } = require("../services/processor-service");
+const { containsDifferentProperty } = require("../shared/option-utils");
 const STEP_KIND_VISIT = 1;
 const STEP_KIND_CALL = 2;
 
@@ -76,6 +77,7 @@ const STEP_KIND_CALL = 2;
 /** @typedef {import("@eslint/core").Language} Language */
 /** @typedef {import("@eslint/core").RuleSeverity} RuleSeverity */
 /** @typedef {import("@eslint/core").RuleConfig} RuleConfig */
+/** @typedef {import("../types").Linter.StringSeverity} StringSeverity */
 
 
 /* eslint-disable jsdoc/valid-types -- https://github.com/jsdoc-type-pratt-parser/jsdoc-type-pratt-parser/issues/4#issuecomment-778805577 */
@@ -141,7 +143,8 @@ const STEP_KIND_CALL = 2;
 /**
  * @typedef {Object} InternalOptions
  * @property {string | null} warnInlineConfig The config name what `noInlineConfig` setting came from. If `noInlineConfig` setting didn't exist, this is null. If this is a config name, then the linter warns directive comments.
- * @property {"off" | "warn" | "error"} reportUnusedDisableDirectives (boolean values were normalized)
+ * @property {StringSeverity} reportUnusedDisableDirectives Severity to report unused disable directives, if not "off" (boolean values were normalized).
+ * @property {StringSeverity} reportUnusedInlineConfigs Severity to report unused inline configs, if not "off".
  */
 
 //------------------------------------------------------------------------------
@@ -314,6 +317,62 @@ function createLintingProblem(options) {
     };
 }
 
+/**
+ * Wraps the value in an Array if it isn't already one.
+ * @template T
+ * @param {T|T[]} value Value to be wrapped.
+ * @returns {Array} The value as an array.
+ */
+function asArray(value) {
+    return Array.isArray(value) ? value : [value];
+}
+
+/**
+ * Pushes a problem to inlineConfigProblems if ruleOptions are redundant.
+ * @param {ConfigData} config Provided config.
+ * @param {Object} loc A line/column location
+ * @param {Array} problems Problems that may be added to.
+ * @param {string} ruleId The rule ID.
+ * @param {Array} ruleOptions The rule options, merged with the config's.
+ * @param {Array} ruleOptionsInline The rule options from the comment.
+ * @param {"error"|"warn"} severity The severity to report.
+ * @returns {void}
+ */
+function addProblemIfSameSeverityAndOptions(config, loc, problems, ruleId, ruleOptions, ruleOptionsInline, severity) {
+    const existingConfigRaw = config.rules?.[ruleId];
+    const existingConfig = existingConfigRaw ? asArray(existingConfigRaw) : ["off"];
+    const existingSeverity = normalizeSeverityToString(existingConfig[0]);
+    const inlineSeverity = normalizeSeverityToString(ruleOptions[0]);
+    const sameSeverity = existingSeverity === inlineSeverity;
+
+    if (!sameSeverity) {
+        return;
+    }
+
+    const alreadyConfigured = existingConfigRaw
+        ? `is already configured to '${existingSeverity}'`
+        : "is not enabled so can't be turned off";
+    let message;
+
+    if ((existingConfig.length === 1 && ruleOptions.length === 1) || existingSeverity === "off") {
+        message = `Unused inline config ('${ruleId}' ${alreadyConfigured}).`;
+    } else if (!containsDifferentProperty(ruleOptions.slice(1), existingConfig.slice(1))) {
+        message = ruleOptionsInline.length === 1
+            ? `Unused inline config ('${ruleId}' ${alreadyConfigured}).`
+            : `Unused inline config ('${ruleId}' ${alreadyConfigured} with the same options).`;
+    }
+
+    if (message) {
+        problems.push(createLintingProblem({
+            ruleId: null,
+            message,
+            loc,
+            language: config.language,
+            severity: normalizeSeverityToNumber(severity)
+        }));
+    }
+}
+
 /**
  * Creates a collection of disable directives from a comment
  * @param {Object} options to create disable directives
@@ -517,7 +576,7 @@ function getDirectiveComments(sourceCode, ruleMapper, warnInlineConfig, config)
                             return;
                         }
 
-                        let ruleOptions = Array.isArray(ruleValue) ? ruleValue : [ruleValue];
+                        let ruleOptions = asArray(ruleValue);
 
                         /*
                          * If the rule was already configured, inline rule configuration that
@@ -555,7 +614,7 @@ function getDirectiveComments(sourceCode, ruleMapper, warnInlineConfig, config)
                              */
                             ruleOptions = [
                                 ruleOptions[0], // severity from the inline config
-                                ...Array.isArray(config.rules[name]) ? config.rules[name].slice(1) : [] // options from the provided config
+                                ...asArray(config.rules[name]).slice(1) // options from the provided config
                             ];
                         }
 
@@ -774,6 +833,8 @@ function normalizeVerifyOptions(providedOptions, config) {
         }
     }
 
+    const reportUnusedInlineConfigs = linterOptions.reportUnusedInlineConfigs === void 0 ? "off" : normalizeSeverityToString(linterOptions.reportUnusedInlineConfigs);
+
     let ruleFilter = providedOptions.ruleFilter;
 
     if (typeof ruleFilter !== "function") {
@@ -787,6 +848,7 @@ function normalizeVerifyOptions(providedOptions, config) {
             ? `your config${configNameOfNoInlineConfig}`
             : null,
         reportUnusedDisableDirectives,
+        reportUnusedInlineConfigs,
         disableFixes: Boolean(providedOptions.disableFixes),
         stats: providedOptions.stats,
         ruleFilter
@@ -1787,7 +1849,8 @@ class Linter {
 
                             try {
 
-                                let ruleOptions = Array.isArray(ruleValue) ? ruleValue : [ruleValue];
+                                const ruleOptionsInline = asArray(ruleValue);
+                                let ruleOptions = ruleOptionsInline;
 
                                 assertIsRuleSeverity(ruleId, ruleOptions[0]);
 
@@ -1850,6 +1913,12 @@ class Linter {
                                     }
                                 }
 
+                                if (options.reportUnusedInlineConfigs !== "off") {
+                                    addProblemIfSameSeverityAndOptions(
+                                        config, loc, inlineConfigProblems, ruleId, ruleOptions, ruleOptionsInline, options.reportUnusedInlineConfigs
+                                    );
+                                }
+
                                 if (shouldValidateOptions) {
                                     ruleValidator.validate({
                                         plugins: config.plugins,

package/lib/options.js

@@ -187,6 +187,18 @@ module.exports = function(usingFlatConfig) {
         };
     }
 
+    let reportUnusedInlineConfigsFlag;
+
+    if (usingFlatConfig) {
+        reportUnusedInlineConfigsFlag = {
+            option: "report-unused-inline-configs",
+            type: "String",
+            default: void 0,
+            description: "Adds reported errors for unused eslint inline config comments",
+            enum: ["off", "warn", "error", "0", "1", "2"]
+        };
+    }
+
     return optionator({
         prepend: "eslint [options] file.js [file.js] [dir]",
         defaults: {
@@ -350,6 +362,7 @@ module.exports = function(usingFlatConfig) {
                 description: "Chooses severity level for reporting unused eslint-disable and eslint-enable directives",
                 enum: ["off", "warn", "error", "0", "1", "2"]
             },
+            reportUnusedInlineConfigsFlag,
             {
                 heading: "Caching"
             },

package/lib/shared/option-utils.js

@@ -0,0 +1,56 @@
+/**
+ * @fileoverview Utilities to operate on option objects.
+ * @author Josh Goldberg
+ */
+
+"use strict";
+
+/**
+ * Determines whether any of input's properties are different
+ * from values that already exist in original.
+ * @template T
+ * @param {Partial<T>} input New value.
+ * @param {T} original Original value.
+ * @returns {boolean} Whether input includes an explicit difference.
+ */
+function containsDifferentProperty(input, original) {
+    if (input === original) {
+        return false;
+    }
+
+    if (
+        typeof input !== typeof original ||
+        Array.isArray(input) !== Array.isArray(original)
+    ) {
+        return true;
+    }
+
+    if (Array.isArray(input)) {
+        return (
+            input.length !== original.length ||
+            input.some((value, i) =>
+                containsDifferentProperty(value, original[i]))
+        );
+    }
+
+    if (typeof input === "object") {
+        if (input === null || original === null) {
+            return true;
+        }
+
+        const inputKeys = Object.keys(input);
+        const originalKeys = Object.keys(original);
+
+        return inputKeys.length !== originalKeys.length || inputKeys.some(
+            inputKey =>
+                !Object.hasOwn(original, inputKey) ||
+                containsDifferentProperty(input[inputKey], original[inputKey])
+        );
+    }
+
+    return true;
+}
+
+module.exports = {
+    containsDifferentProperty
+};

package/lib/types/index.d.ts

@@ -1371,6 +1371,12 @@ export namespace Linter {
          * tracked and reported.
          */
         reportUnusedDisableDirectives?: Severity | StringSeverity | boolean;
+
+        /**
+         * A severity value indicating if and how unused inline configs should be
+         * tracked and reported.
+         */
+        reportUnusedInlineConfigs?: Severity | StringSeverity;
     }
 
     interface Stats {