eslint 9.9.1 → 9.11.0

package/lib/types/rules/variables.d.ts

@@ -0,0 +1,221 @@
+/**
+ * @fileoverview This file contains the rule types for ESLint. It was initially extracted
+ * from the `@types/eslint` package.
+ */
+
+/*
+ * MIT License
+ * Copyright (c) Microsoft Corporation.
+ *
+ * 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
+ */
+
+import { Linter } from "../index";
+
+export interface Variables extends Linter.RulesRecord {
+    /**
+     * Rule to require or disallow initialization in variable declarations.
+     *
+     * @since 1.0.0-rc-1
+     * @see https://eslint.org/docs/rules/init-declarations
+     */
+    "init-declarations":
+        | Linter.RuleEntry<["always"]>
+        | Linter.RuleEntry<
+            [
+                "never",
+                Partial<{
+                    ignoreForLoopInit: boolean;
+                }>,
+            ]
+        >;
+
+    /**
+     * Rule to disallow deleting variables.
+     *
+     * @remarks
+     * Recommended by ESLint, the rule was enabled in `eslint:recommended`.
+     *
+     * @since 0.0.9
+     * @see https://eslint.org/docs/rules/no-delete-var
+     */
+    "no-delete-var": Linter.RuleEntry<[]>;
+
+    /**
+     * Rule to disallow labels that share a name with a variable.
+     *
+     * @since 0.0.9
+     * @see https://eslint.org/docs/rules/no-label-var
+     */
+    "no-label-var": Linter.RuleEntry<[]>;
+
+    /**
+     * Rule to disallow specified global variables.
+     *
+     * @since 2.3.0
+     * @see https://eslint.org/docs/rules/no-restricted-globals
+     */
+    "no-restricted-globals": Linter.RuleEntry<
+        [
+            ...Array<
+                | string
+                | {
+                    name: string;
+                    message?: string | undefined;
+                }
+            >,
+        ]
+    >;
+
+    /**
+     * Rule to disallow variable declarations from shadowing variables declared in the outer scope.
+     *
+     * @since 0.0.9
+     * @see https://eslint.org/docs/rules/no-shadow
+     */
+    "no-shadow": Linter.RuleEntry<
+        [
+            Partial<{
+                /**
+                 * @default false
+                 */
+                builtinGlobals: boolean;
+                /**
+                 * @default 'functions'
+                 */
+                hoist: "functions" | "all" | "never";
+                allow: string[];
+            }>,
+        ]
+    >;
+
+    /**
+     * Rule to disallow identifiers from shadowing restricted names.
+     *
+     * @remarks
+     * Recommended by ESLint, the rule was enabled in `eslint:recommended`.
+     *
+     * @since 0.1.4
+     * @see https://eslint.org/docs/rules/no-shadow-restricted-names
+     */
+    "no-shadow-restricted-names": Linter.RuleEntry<[]>;
+
+    /**
+     * Rule to disallow the use of undeclared variables unless mentioned in `global` comments.
+     *
+     * @remarks
+     * Recommended by ESLint, the rule was enabled in `eslint:recommended`.
+     *
+     * @since 0.0.9
+     * @see https://eslint.org/docs/rules/no-undef
+     */
+    "no-undef": Linter.RuleEntry<
+        [
+            Partial<{
+                /**
+                 * @default false
+                 */
+                typeof: boolean;
+            }>,
+        ]
+    >;
+
+    /**
+     * Rule to disallow initializing variables to `undefined`.
+     *
+     * @since 0.0.6
+     * @see https://eslint.org/docs/rules/no-undef-init
+     */
+    "no-undef-init": Linter.RuleEntry<[]>;
+
+    /**
+     * Rule to disallow the use of `undefined` as an identifier.
+     *
+     * @since 0.7.1
+     * @see https://eslint.org/docs/rules/no-undefined
+     */
+    "no-undefined": Linter.RuleEntry<[]>;
+
+    /**
+     * Rule to disallow unused variables.
+     *
+     * @remarks
+     * Recommended by ESLint, the rule was enabled in `eslint:recommended`.
+     *
+     * @since 0.0.9
+     * @see https://eslint.org/docs/rules/no-unused-vars
+     */
+    "no-unused-vars": Linter.RuleEntry<
+        [
+            | "all"
+            | "local"
+            | Partial<{
+                /**
+                 * @default 'all'
+                 */
+                vars: "all" | "local";
+                varsIgnorePattern: string;
+                /**
+                 * @default 'after-used'
+                 */
+                args: "after-used" | "all" | "none";
+                /**
+                 * @default false
+                 */
+                ignoreRestSiblings: boolean;
+                argsIgnorePattern: string;
+                /**
+                 * @default 'none'
+                 */
+                caughtErrors: "none" | "all";
+                caughtErrorsIgnorePattern: string;
+                destructuredArrayIgnorePattern: string;
+            }>,
+        ]
+    >;
+
+    /**
+     * Rule to disallow the use of variables before they are defined.
+     *
+     * @since 0.0.9
+     * @see https://eslint.org/docs/rules/no-use-before-define
+     */
+    "no-use-before-define": Linter.RuleEntry<
+        [
+            | Partial<{
+                /**
+                 * @default true
+                 */
+                functions: boolean;
+                /**
+                 * @default true
+                 */
+                classes: boolean;
+                /**
+                 * @default true
+                 */
+                variables: boolean;
+                /**
+                 * @default false
+                 */
+                allowNamedExports: boolean;
+            }>
+            | "nofunc",
+        ]
+    >;
+}

package/lib/types/universal.d.ts

@@ -0,0 +1,6 @@
+/**
+ * @fileoverview typings for "eslint/universal" module
+ * @author 唯然<weiran.zsd@outlook.com>
+ */
+
+export { Linter } from "./index";

package/lib/types/use-at-your-own-risk.d.ts

@@ -0,0 +1,85 @@
+/**
+ * @fileoverview This file contains the types for the use-at-your-own-risk
+ * entrypoint. It was initially extracted from the `@types/eslint` package.
+ */
+
+/*
+ * MIT License
+ * Copyright (c) Microsoft Corporation.
+ *
+ * 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
+ */
+
+
+import { ESLint, Rule } from "./index.js";
+
+/** @deprecated */
+export const builtinRules: Map<string, Rule.RuleModule>;
+
+/** @deprecated */
+export class FileEnumerator {
+    constructor(
+        params?: {
+            cwd?: string;
+            configArrayFactory?: any;
+            extensions?: any;
+            globInputPaths?: boolean;
+            errorOnUnmatchedPattern?: boolean;
+            ignore?: boolean;
+        },
+    );
+    isTargetPath(filePath: string, providedConfig?: any): boolean;
+    iterateFiles(
+        patternOrPatterns: string | string[],
+    ): IterableIterator<{ config: any; filePath: string; ignored: boolean }>;
+}
+
+export { /** @deprecated */ ESLint as FlatESLint };
+
+/** @deprecated */
+export class LegacyESLint {
+    static configType: "eslintrc";
+
+    static readonly version: string;
+
+    static outputFixes(results: ESLint.LintResult[]): Promise<void>;
+
+    static getErrorResults(results: ESLint.LintResult[]): ESLint.LintResult[];
+
+    constructor(options?: ESLint.LegacyOptions);
+
+    lintFiles(patterns: string | string[]): Promise<ESLint.LintResult[]>;
+
+    lintText(
+        code: string,
+        options?: { filePath?: string | undefined; warnIgnored?: boolean | undefined },
+    ): Promise<ESLint.LintResult[]>;
+
+    getRulesMetaForResults(results: ESLint.LintResult[]): ESLint.LintResultData["rulesMeta"];
+
+    hasFlag(flag: string): false;
+
+    calculateConfigForFile(filePath: string): Promise<any>;
+
+    isPathIgnored(filePath: string): Promise<boolean>;
+
+    loadFormatter(nameOrPath?: string): Promise<ESLint.Formatter>;
+}
+
+/** @deprecated */
+export function shouldUseFlatConfig(): Promise<boolean>;

package/lib/universal.js

@@ -0,0 +1,10 @@
+/**
+ * @fileoverview exports for browsers
+ * @author 唯然<weiran.zsd@outlook.com>
+ */
+
+"use strict";
+
+const { Linter } = require("./linter/linter");
+
+module.exports = { Linter };

package/package.json

@@ -1,16 +1,30 @@
 {
   "name": "eslint",
-  "version": "9.9.1",
+  "version": "9.11.0",
   "author": "Nicholas C. Zakas <nicholas+npm@nczconsulting.com>",
   "description": "An AST-based pattern checker for JavaScript.",
   "bin": {
     "eslint": "./bin/eslint.js"
   },
   "main": "./lib/api.js",
+  "types": "./lib/types/index.d.ts",
   "exports": {
+    ".": {
+      "types": "./lib/types/index.d.ts",
+      "default": "./lib/api.js"
+    },
     "./package.json": "./package.json",
-    ".": "./lib/api.js",
-    "./use-at-your-own-risk": "./lib/unsupported-api.js"
+    "./use-at-your-own-risk": {
+      "types": "./lib/types/use-at-your-own-risk.d.ts",
+      "default": "./lib/unsupported-api.js"
+    },
+    "./rules": {
+      "types": "./lib/types/rules/index.d.ts"
+    },
+    "./universal": {
+      "types": "./lib/types/universal.d.ts",
+      "default": "./lib/universal.js"
+    }
   },
   "scripts": {
     "build:docs:update-links": "node tools/fetch-docs-links.js",
@@ -26,7 +40,8 @@
     "lint:fix:docs:js": "trunk check -y --ignore=** --ignore=!docs/**/*.js -a --flter=eslint && trunk check -y --ignore=** --ignore=!docs/**/*.js",
     "release:generate:alpha": "node Makefile.js generatePrerelease -- alpha",
     "release:generate:beta": "node Makefile.js generatePrerelease -- beta",
-    "release:generate:latest": "node Makefile.js generateRelease",
+    "release:generate:latest": "node Makefile.js generateRelease -- latest",
+    "release:generate:maintenance": "node Makefile.js generateRelease -- maintenance",
     "release:generate:rc": "node Makefile.js generatePrerelease -- rc",
     "release:publish": "node Makefile.js publishRelease",
     "test": "node Makefile.js test",
@@ -34,7 +49,8 @@
     "test:cli": "mocha",
     "test:fuzz": "node Makefile.js fuzz",
     "test:performance": "node Makefile.js perf",
-    "test:emfile": "node tools/check-emfile-handling.js"
+    "test:emfile": "node tools/check-emfile-handling.js",
+    "test:types": "tsc -p tests/lib/types/tsconfig.json"
   },
   "gitHooks": {
     "pre-commit": "lint-staged"
@@ -70,7 +86,8 @@
     "@eslint-community/regexpp": "^4.11.0",
     "@eslint/config-array": "^0.18.0",
     "@eslint/eslintrc": "^3.1.0",
-    "@eslint/js": "9.9.1",
+    "@eslint/js": "9.11.0",
+    "@eslint/plugin-kit": "^0.2.0",
     "@humanwhocodes/module-importer": "^1.0.1",
     "@humanwhocodes/retry": "^0.3.0",
     "@nodelib/fs.walk": "^1.2.8",
@@ -93,7 +110,6 @@
     "is-glob": "^4.0.0",
     "is-path-inside": "^3.0.3",
     "json-stable-stringify-without-jsonify": "^1.0.1",
-    "levn": "^0.4.1",
     "lodash.merge": "^4.6.2",
     "minimatch": "^3.1.2",
     "natural-compare": "^1.4.0",
@@ -104,11 +120,13 @@
   "devDependencies": {
     "@babel/core": "^7.4.3",
     "@babel/preset-env": "^7.4.3",
-    "@eslint/core": "^0.4.0",
-    "@eslint/json": "^0.3.0",
+    "@eslint/core": "^0.6.0",
+    "@eslint/json": "^0.4.0",
     "@trunkio/launcher": "^1.3.0",
     "@types/estree": "^1.0.5",
+    "@types/json-schema": "^7.0.15",
     "@types/node": "^20.11.5",
+    "@typescript-eslint/parser": "^8.4.0",
     "@wdio/browser-runner": "^9.0.5",
     "@wdio/cli": "^9.0.5",
     "@wdio/concise-reporter": "^9.0.4",
@@ -123,8 +141,9 @@
     "eslint": "file:.",
     "eslint-config-eslint": "file:packages/eslint-config-eslint",
     "eslint-plugin-eslint-plugin": "^6.0.0",
+    "eslint-plugin-expect-type": "^0.4.0",
     "eslint-plugin-yml": "^1.14.0",
-    "eslint-release": "^3.2.2",
+    "eslint-release": "^3.3.0",
     "eslint-rule-composer": "^0.3.0",
     "eslump": "^3.0.0",
     "esprima": "^4.0.1",

package/lib/linter/config-comment-parser.js

@@ -1,169 +0,0 @@
-/**
- * @fileoverview Config Comment Parser
- * @author Nicholas C. Zakas
- */
-
-/* eslint class-methods-use-this: off -- Methods desired on instance */
-"use strict";
-
-//------------------------------------------------------------------------------
-// Requirements
-//------------------------------------------------------------------------------
-
-const levn = require("levn"),
-    {
-        Legacy: {
-            ConfigOps
-        }
-    } = require("@eslint/eslintrc/universal"),
-    {
-        directivesPattern
-    } = require("../shared/directives");
-
-const debug = require("debug")("eslint:config-comment-parser");
-
-//------------------------------------------------------------------------------
-// Public Interface
-//------------------------------------------------------------------------------
-
-/**
- * Object to parse ESLint configuration comments inside JavaScript files.
- * @name ConfigCommentParser
- */
-module.exports = class ConfigCommentParser {
-
-    /**
-     * Parses a list of "name:string_value" or/and "name" options divided by comma or
-     * whitespace. Used for "global" comments.
-     * @param {string} string The string to parse.
-     * @param {Comment} comment The comment node which has the string.
-     * @returns {Object} Result map object of names and string values, or null values if no value was provided
-     */
-    parseStringConfig(string, comment) {
-        debug("Parsing String config");
-
-        const items = {};
-
-        // Collapse whitespace around `:` and `,` to make parsing easier
-        const trimmedString = string.replace(/\s*([:,])\s*/gu, "$1");
-
-        trimmedString.split(/\s|,+/u).forEach(name => {
-            if (!name) {
-                return;
-            }
-
-            // value defaults to null (if not provided), e.g: "foo" => ["foo", null]
-            const [key, value = null] = name.split(":");
-
-            items[key] = { value, comment };
-        });
-        return items;
-    }
-
-    /**
-     * Parses a JSON-like config.
-     * @param {string} string The string to parse.
-     * @returns {({success: true, config: Object}|{success: false, error: {message: string}})} Result map object
-     */
-    parseJsonConfig(string) {
-        debug("Parsing JSON config");
-
-        // Parses a JSON-like comment by the same way as parsing CLI option.
-        try {
-            const items = levn.parse("Object", string) || {};
-
-            // Some tests say that it should ignore invalid comments such as `/*eslint no-alert:abc*/`.
-            // Also, commaless notations have invalid severity:
-            //     "no-alert: 2 no-console: 2" --> {"no-alert": "2 no-console: 2"}
-            // Should ignore that case as well.
-            if (ConfigOps.isEverySeverityValid(items)) {
-                return {
-                    success: true,
-                    config: items
-                };
-            }
-        } catch {
-
-            debug("Levn parsing failed; falling back to manual parsing.");
-
-            // ignore to parse the string by a fallback.
-        }
-
-        /*
-         * Optionator cannot parse commaless notations.
-         * But we are supporting that. So this is a fallback for that.
-         */
-        const normalizedString = string.replace(/([-a-zA-Z0-9/]+):/gu, "\"$1\":").replace(/(\]|[0-9])\s+(?=")/u, "$1,");
-
-        try {
-            const items = JSON.parse(`{${normalizedString}}`);
-
-            return {
-                success: true,
-                config: items
-            };
-        } catch (ex) {
-            debug("Manual parsing failed.");
-
-            return {
-                success: false,
-                error: {
-                    message: `Failed to parse JSON from '${normalizedString}': ${ex.message}`
-                }
-            };
-
-        }
-    }
-
-    /**
-     * Parses a config of values separated by comma.
-     * @param {string} string The string to parse.
-     * @returns {Object} Result map of values and true values
-     */
-    parseListConfig(string) {
-        debug("Parsing list config");
-
-        const items = {};
-
-        string.split(",").forEach(name => {
-            const trimmedName = name.trim().replace(/^(?<quote>['"]?)(?<ruleId>.*)\k<quote>$/us, "$<ruleId>");
-
-            if (trimmedName) {
-                items[trimmedName] = true;
-            }
-        });
-        return items;
-    }
-
-    /**
-     * 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 };
-    }
-};