eslint 8.57.1 → 9.39.1

package/lib/shared/config-validator.js

@@ -1,347 +0,0 @@
-/*
- * STOP!!! DO NOT MODIFY.
- *
- * This file is part of the ongoing work to move the eslintrc-style config
- * system into the @eslint/eslintrc package. This file needs to remain
- * unchanged in order for this work to proceed.
- *
- * If you think you need to change this file, please contact @nzakas first.
- *
- * Thanks in advance for your cooperation.
- */
-
-/**
- * @fileoverview Validates configs.
- * @author Brandon Mills
- */
-
-"use strict";
-
-//------------------------------------------------------------------------------
-// Requirements
-//------------------------------------------------------------------------------
-
-const
-    util = require("util"),
-    configSchema = require("../../conf/config-schema"),
-    BuiltInRules = require("../rules"),
-    {
-        Legacy: {
-            ConfigOps,
-            environments: BuiltInEnvironments
-        }
-    } = require("@eslint/eslintrc"),
-    { emitDeprecationWarning } = require("./deprecation-warnings");
-
-const ajv = require("./ajv")();
-const ruleValidators = new WeakMap();
-const noop = Function.prototype;
-
-//------------------------------------------------------------------------------
-// Private
-//------------------------------------------------------------------------------
-let validateSchema;
-const severityMap = {
-    error: 2,
-    warn: 1,
-    off: 0
-};
-
-/**
- * Gets a complete options schema for a rule.
- * @param {{create: Function, schema: (Array|null)}} rule A new-style rule object
- * @returns {Object} JSON Schema for the rule's options.
- */
-function getRuleOptionsSchema(rule) {
-    if (!rule) {
-        return null;
-    }
-
-    const schema = rule.schema || rule.meta && rule.meta.schema;
-
-    // Given a tuple of schemas, insert warning level at the beginning
-    if (Array.isArray(schema)) {
-        if (schema.length) {
-            return {
-                type: "array",
-                items: schema,
-                minItems: 0,
-                maxItems: schema.length
-            };
-        }
-        return {
-            type: "array",
-            minItems: 0,
-            maxItems: 0
-        };
-
-    }
-
-    // Given a full schema, leave it alone
-    return schema || null;
-}
-
-/**
- * Validates a rule's severity and returns the severity value. Throws an error if the severity is invalid.
- * @param {options} options The given options for the rule.
- * @throws {Error} Wrong severity value.
- * @returns {number|string} The rule's severity value
- */
-function validateRuleSeverity(options) {
-    const severity = Array.isArray(options) ? options[0] : options;
-    const normSeverity = typeof severity === "string" ? severityMap[severity.toLowerCase()] : severity;
-
-    if (normSeverity === 0 || normSeverity === 1 || normSeverity === 2) {
-        return normSeverity;
-    }
-
-    throw new Error(`\tSeverity should be one of the following: 0 = off, 1 = warn, 2 = error (you passed '${util.inspect(severity).replace(/'/gu, "\"").replace(/\n/gu, "")}').\n`);
-
-}
-
-/**
- * Validates the non-severity options passed to a rule, based on its schema.
- * @param {{create: Function}} rule The rule to validate
- * @param {Array} localOptions The options for the rule, excluding severity
- * @throws {Error} Any rule validation errors.
- * @returns {void}
- */
-function validateRuleSchema(rule, localOptions) {
-    if (!ruleValidators.has(rule)) {
-        const schema = getRuleOptionsSchema(rule);
-
-        if (schema) {
-            ruleValidators.set(rule, ajv.compile(schema));
-        }
-    }
-
-    const validateRule = ruleValidators.get(rule);
-
-    if (validateRule) {
-        validateRule(localOptions);
-        if (validateRule.errors) {
-            throw new Error(validateRule.errors.map(
-                error => `\tValue ${JSON.stringify(error.data)} ${error.message}.\n`
-            ).join(""));
-        }
-    }
-}
-
-/**
- * Validates a rule's options against its schema.
- * @param {{create: Function}|null} rule The rule that the config is being validated for
- * @param {string} ruleId The rule's unique name.
- * @param {Array|number} options The given options for the rule.
- * @param {string|null} source The name of the configuration source to report in any errors. If null or undefined,
- * no source is prepended to the message.
- * @throws {Error} Upon any bad rule configuration.
- * @returns {void}
- */
-function validateRuleOptions(rule, ruleId, options, source = null) {
-    try {
-        const severity = validateRuleSeverity(options);
-
-        if (severity !== 0) {
-            validateRuleSchema(rule, Array.isArray(options) ? options.slice(1) : []);
-        }
-    } catch (err) {
-        const enhancedMessage = `Configuration for rule "${ruleId}" is invalid:\n${err.message}`;
-
-        if (typeof source === "string") {
-            throw new Error(`${source}:\n\t${enhancedMessage}`);
-        } else {
-            throw new Error(enhancedMessage);
-        }
-    }
-}
-
-/**
- * Validates an environment object
- * @param {Object} environment The environment config object to validate.
- * @param {string} source The name of the configuration source to report in any errors.
- * @param {(envId:string) => Object} [getAdditionalEnv] A map from strings to loaded environments.
- * @returns {void}
- */
-function validateEnvironment(
-    environment,
-    source,
-    getAdditionalEnv = noop
-) {
-
-    // not having an environment is ok
-    if (!environment) {
-        return;
-    }
-
-    Object.keys(environment).forEach(id => {
-        const env = getAdditionalEnv(id) || BuiltInEnvironments.get(id) || null;
-
-        if (!env) {
-            const message = `${source}:\n\tEnvironment key "${id}" is unknown\n`;
-
-            throw new Error(message);
-        }
-    });
-}
-
-/**
- * Validates a rules config object
- * @param {Object} rulesConfig The rules config object to validate.
- * @param {string} source The name of the configuration source to report in any errors.
- * @param {(ruleId:string) => Object} getAdditionalRule A map from strings to loaded rules
- * @returns {void}
- */
-function validateRules(
-    rulesConfig,
-    source,
-    getAdditionalRule = noop
-) {
-    if (!rulesConfig) {
-        return;
-    }
-
-    Object.keys(rulesConfig).forEach(id => {
-        const rule = getAdditionalRule(id) || BuiltInRules.get(id) || null;
-
-        validateRuleOptions(rule, id, rulesConfig[id], source);
-    });
-}
-
-/**
- * Validates a `globals` section of a config file
- * @param {Object} globalsConfig The `globals` section
- * @param {string|null} source The name of the configuration source to report in the event of an error.
- * @returns {void}
- */
-function validateGlobals(globalsConfig, source = null) {
-    if (!globalsConfig) {
-        return;
-    }
-
-    Object.entries(globalsConfig)
-        .forEach(([configuredGlobal, configuredValue]) => {
-            try {
-                ConfigOps.normalizeConfigGlobal(configuredValue);
-            } catch (err) {
-                throw new Error(`ESLint configuration of global '${configuredGlobal}' in ${source} is invalid:\n${err.message}`);
-            }
-        });
-}
-
-/**
- * Validate `processor` configuration.
- * @param {string|undefined} processorName The processor name.
- * @param {string} source The name of config file.
- * @param {(id:string) => Processor} getProcessor The getter of defined processors.
- * @throws {Error} For invalid processor configuration.
- * @returns {void}
- */
-function validateProcessor(processorName, source, getProcessor) {
-    if (processorName && !getProcessor(processorName)) {
-        throw new Error(`ESLint configuration of processor in '${source}' is invalid: '${processorName}' was not found.`);
-    }
-}
-
-/**
- * Formats an array of schema validation errors.
- * @param {Array} errors An array of error messages to format.
- * @returns {string} Formatted error message
- */
-function formatErrors(errors) {
-    return errors.map(error => {
-        if (error.keyword === "additionalProperties") {
-            const formattedPropertyPath = error.dataPath.length ? `${error.dataPath.slice(1)}.${error.params.additionalProperty}` : error.params.additionalProperty;
-
-            return `Unexpected top-level property "${formattedPropertyPath}"`;
-        }
-        if (error.keyword === "type") {
-            const formattedField = error.dataPath.slice(1);
-            const formattedExpectedType = Array.isArray(error.schema) ? error.schema.join("/") : error.schema;
-            const formattedValue = JSON.stringify(error.data);
-
-            return `Property "${formattedField}" is the wrong type (expected ${formattedExpectedType} but got \`${formattedValue}\`)`;
-        }
-
-        const field = error.dataPath[0] === "." ? error.dataPath.slice(1) : error.dataPath;
-
-        return `"${field}" ${error.message}. Value: ${JSON.stringify(error.data)}`;
-    }).map(message => `\t- ${message}.\n`).join("");
-}
-
-/**
- * Validates the top level properties of the config object.
- * @param {Object} config The config object to validate.
- * @param {string} source The name of the configuration source to report in any errors.
- * @throws {Error} For any config invalid per the schema.
- * @returns {void}
- */
-function validateConfigSchema(config, source = null) {
-    validateSchema = validateSchema || ajv.compile(configSchema);
-
-    if (!validateSchema(config)) {
-        throw new Error(`ESLint configuration in ${source} is invalid:\n${formatErrors(validateSchema.errors)}`);
-    }
-
-    if (Object.hasOwnProperty.call(config, "ecmaFeatures")) {
-        emitDeprecationWarning(source, "ESLINT_LEGACY_ECMAFEATURES");
-    }
-}
-
-/**
- * Validates an entire config object.
- * @param {Object} config The config object to validate.
- * @param {string} source The name of the configuration source to report in any errors.
- * @param {(ruleId:string) => Object} [getAdditionalRule] A map from strings to loaded rules.
- * @param {(envId:string) => Object} [getAdditionalEnv] A map from strings to loaded envs.
- * @returns {void}
- */
-function validate(config, source, getAdditionalRule, getAdditionalEnv) {
-    validateConfigSchema(config, source);
-    validateRules(config.rules, source, getAdditionalRule);
-    validateEnvironment(config.env, source, getAdditionalEnv);
-    validateGlobals(config.globals, source);
-
-    for (const override of config.overrides || []) {
-        validateRules(override.rules, source, getAdditionalRule);
-        validateEnvironment(override.env, source, getAdditionalEnv);
-        validateGlobals(config.globals, source);
-    }
-}
-
-const validated = new WeakSet();
-
-/**
- * Validate config array object.
- * @param {ConfigArray} configArray The config array to validate.
- * @returns {void}
- */
-function validateConfigArray(configArray) {
-    const getPluginEnv = Map.prototype.get.bind(configArray.pluginEnvironments);
-    const getPluginProcessor = Map.prototype.get.bind(configArray.pluginProcessors);
-    const getPluginRule = Map.prototype.get.bind(configArray.pluginRules);
-
-    // Validate.
-    for (const element of configArray) {
-        if (validated.has(element)) {
-            continue;
-        }
-        validated.add(element);
-
-        validateEnvironment(element.env, element.name, getPluginEnv);
-        validateGlobals(element.globals, element.name);
-        validateProcessor(element.processor, element.name, getPluginProcessor);
-        validateRules(element.rules, element.name, getPluginRule);
-    }
-}
-
-//------------------------------------------------------------------------------
-// Public Interface
-//------------------------------------------------------------------------------
-
-module.exports = {
-    getRuleOptionsSchema,
-    validate,
-    validateConfigArray,
-    validateConfigSchema,
-    validateRuleOptions
-};

package/lib/shared/deprecation-warnings.js

@@ -1,58 +0,0 @@
-/**
- * @fileoverview Provide the function that emits deprecation warnings.
- * @author Toru Nagashima <http://github.com/mysticatea>
- */
-"use strict";
-
-//------------------------------------------------------------------------------
-// Requirements
-//------------------------------------------------------------------------------
-
-const path = require("path");
-
-//------------------------------------------------------------------------------
-// Private
-//------------------------------------------------------------------------------
-
-// Definitions for deprecation warnings.
-const deprecationWarningMessages = {
-    ESLINT_LEGACY_ECMAFEATURES:
-        "The 'ecmaFeatures' config file property is deprecated and has no effect."
-};
-
-const sourceFileErrorCache = new Set();
-
-/**
- * Emits a deprecation warning containing a given filepath. A new deprecation warning is emitted
- * for each unique file path, but repeated invocations with the same file path have no effect.
- * No warnings are emitted if the `--no-deprecation` or `--no-warnings` Node runtime flags are active.
- * @param {string} source The name of the configuration source to report the warning for.
- * @param {string} errorCode The warning message to show.
- * @returns {void}
- */
-function emitDeprecationWarning(source, errorCode) {
-    const cacheKey = JSON.stringify({ source, errorCode });
-
-    if (sourceFileErrorCache.has(cacheKey)) {
-        return;
-    }
-
-    sourceFileErrorCache.add(cacheKey);
-
-    const rel = path.relative(process.cwd(), source);
-    const message = deprecationWarningMessages[errorCode];
-
-    process.emitWarning(
-        `${message} (found in "${rel}")`,
-        "DeprecationWarning",
-        errorCode
-    );
-}
-
-//------------------------------------------------------------------------------
-// Public Interface
-//------------------------------------------------------------------------------
-
-module.exports = {
-    emitDeprecationWarning
-};

package/lib/shared/types.js

@@ -1,216 +0,0 @@
-/**
- * @fileoverview Define common types for input completion.
- * @author Toru Nagashima <https://github.com/mysticatea>
- */
-"use strict";
-
-/** @type {any} */
-module.exports = {};
-
-/** @typedef {boolean | "off" | "readable" | "readonly" | "writable" | "writeable"} GlobalConf */
-/** @typedef {0 | 1 | 2 | "off" | "warn" | "error"} SeverityConf */
-/** @typedef {SeverityConf | [SeverityConf, ...any[]]} RuleConf */
-
-/**
- * @typedef {Object} EcmaFeatures
- * @property {boolean} [globalReturn] Enabling `return` statements at the top-level.
- * @property {boolean} [jsx] Enabling JSX syntax.
- * @property {boolean} [impliedStrict] Enabling strict mode always.
- */
-
-/**
- * @typedef {Object} ParserOptions
- * @property {EcmaFeatures} [ecmaFeatures] The optional features.
- * @property {3|5|6|7|8|9|10|11|12|13|14|15|2015|2016|2017|2018|2019|2020|2021|2022|2023|2024} [ecmaVersion] The ECMAScript version (or revision number).
- * @property {"script"|"module"} [sourceType] The source code type.
- * @property {boolean} [allowReserved] Allowing the use of reserved words as identifiers in ES3.
- */
-
-/**
- * @typedef {Object} LanguageOptions
- * @property {number|"latest"} [ecmaVersion] The ECMAScript version (or revision number).
- * @property {Record<string, GlobalConf>} [globals] The global variable settings.
- * @property {"script"|"module"|"commonjs"} [sourceType] The source code type.
- * @property {string|Object} [parser] The parser to use.
- * @property {Object} [parserOptions] The parser options to use.
- */
-
-/**
- * @typedef {Object} ConfigData
- * @property {Record<string, boolean>} [env] The environment settings.
- * @property {string | string[]} [extends] The path to other config files or the package name of shareable configs.
- * @property {Record<string, GlobalConf>} [globals] The global variable settings.
- * @property {string | string[]} [ignorePatterns] The glob patterns that ignore to lint.
- * @property {boolean} [noInlineConfig] The flag that disables directive comments.
- * @property {OverrideConfigData[]} [overrides] The override settings per kind of files.
- * @property {string} [parser] The path to a parser or the package name of a parser.
- * @property {ParserOptions} [parserOptions] The parser options.
- * @property {string[]} [plugins] The plugin specifiers.
- * @property {string} [processor] The processor specifier.
- * @property {boolean} [reportUnusedDisableDirectives] The flag to report unused `eslint-disable` comments.
- * @property {boolean} [root] The root flag.
- * @property {Record<string, RuleConf>} [rules] The rule settings.
- * @property {Object} [settings] The shared settings.
- */
-
-/**
- * @typedef {Object} OverrideConfigData
- * @property {Record<string, boolean>} [env] The environment settings.
- * @property {string | string[]} [excludedFiles] The glob patterns for excluded files.
- * @property {string | string[]} [extends] The path to other config files or the package name of shareable configs.
- * @property {string | string[]} files The glob patterns for target files.
- * @property {Record<string, GlobalConf>} [globals] The global variable settings.
- * @property {boolean} [noInlineConfig] The flag that disables directive comments.
- * @property {OverrideConfigData[]} [overrides] The override settings per kind of files.
- * @property {string} [parser] The path to a parser or the package name of a parser.
- * @property {ParserOptions} [parserOptions] The parser options.
- * @property {string[]} [plugins] The plugin specifiers.
- * @property {string} [processor] The processor specifier.
- * @property {boolean} [reportUnusedDisableDirectives] The flag to report unused `eslint-disable` comments.
- * @property {Record<string, RuleConf>} [rules] The rule settings.
- * @property {Object} [settings] The shared settings.
- */
-
-/**
- * @typedef {Object} ParseResult
- * @property {Object} ast The AST.
- * @property {ScopeManager} [scopeManager] The scope manager of the AST.
- * @property {Record<string, any>} [services] The services that the parser provides.
- * @property {Record<string, string[]>} [visitorKeys] The visitor keys of the AST.
- */
-
-/**
- * @typedef {Object} Parser
- * @property {(text:string, options:ParserOptions) => Object} parse The definition of global variables.
- * @property {(text:string, options:ParserOptions) => ParseResult} [parseForESLint] The parser options that will be enabled under this environment.
- */
-
-/**
- * @typedef {Object} Environment
- * @property {Record<string, GlobalConf>} [globals] The definition of global variables.
- * @property {ParserOptions} [parserOptions] The parser options that will be enabled under this environment.
- */
-
-/**
- * @typedef {Object} LintMessage
- * @property {number|undefined} column The 1-based column number.
- * @property {number} [endColumn] The 1-based column number of the end location.
- * @property {number} [endLine] The 1-based line number of the end location.
- * @property {boolean} [fatal] If `true` then this is a fatal error.
- * @property {{range:[number,number], text:string}} [fix] Information for autofix.
- * @property {number|undefined} line The 1-based line number.
- * @property {string} message The error message.
- * @property {string} [messageId] The ID of the message in the rule's meta.
- * @property {(string|null)} nodeType Type of node
- * @property {string|null} ruleId The ID of the rule which makes this message.
- * @property {0|1|2} severity The severity of this message.
- * @property {Array<{desc?: string, messageId?: string, fix: {range: [number, number], text: string}}>} [suggestions] Information for suggestions.
- */
-
-/**
- * @typedef {Object} SuppressedLintMessage
- * @property {number|undefined} column The 1-based column number.
- * @property {number} [endColumn] The 1-based column number of the end location.
- * @property {number} [endLine] The 1-based line number of the end location.
- * @property {boolean} [fatal] If `true` then this is a fatal error.
- * @property {{range:[number,number], text:string}} [fix] Information for autofix.
- * @property {number|undefined} line The 1-based line number.
- * @property {string} message The error message.
- * @property {string} [messageId] The ID of the message in the rule's meta.
- * @property {(string|null)} nodeType Type of node
- * @property {string|null} ruleId The ID of the rule which makes this message.
- * @property {0|1|2} severity The severity of this message.
- * @property {Array<{kind: string, justification: string}>} suppressions The suppression info.
- * @property {Array<{desc?: string, messageId?: string, fix: {range: [number, number], text: string}}>} [suggestions] Information for suggestions.
- */
-
-/**
- * @typedef {Object} SuggestionResult
- * @property {string} desc A short description.
- * @property {string} [messageId] Id referencing a message for the description.
- * @property {{ text: string, range: number[] }} fix fix result info
- */
-
-/**
- * @typedef {Object} Processor
- * @property {(text:string, filename:string) => Array<string | { text:string, filename:string }>} [preprocess] The function to extract code blocks.
- * @property {(messagesList:LintMessage[][], filename:string) => LintMessage[]} [postprocess] The function to merge messages.
- * @property {boolean} [supportsAutofix] If `true` then it means the processor supports autofix.
- */
-
-/**
- * @typedef {Object} RuleMetaDocs
- * @property {string} description The description of the rule.
- * @property {boolean} recommended If `true` then the rule is included in `eslint:recommended` preset.
- * @property {string} url The URL of the rule documentation.
- */
-
-/**
- * @typedef {Object} RuleMeta
- * @property {boolean} [deprecated] If `true` then the rule has been deprecated.
- * @property {RuleMetaDocs} docs The document information of the rule.
- * @property {"code"|"whitespace"} [fixable] The autofix type.
- * @property {boolean} [hasSuggestions] If `true` then the rule provides suggestions.
- * @property {Record<string,string>} [messages] The messages the rule reports.
- * @property {string[]} [replacedBy] The IDs of the alternative rules.
- * @property {Array|Object} schema The option schema of the rule.
- * @property {"problem"|"suggestion"|"layout"} type The rule type.
- */
-
-/**
- * @typedef {Object} Rule
- * @property {Function} create The factory of the rule.
- * @property {RuleMeta} meta The meta data of the rule.
- */
-
-/**
- * @typedef {Object} Plugin
- * @property {Record<string, ConfigData>} [configs] The definition of plugin configs.
- * @property {Record<string, Environment>} [environments] The definition of plugin environments.
- * @property {Record<string, Processor>} [processors] The definition of plugin processors.
- * @property {Record<string, Function | Rule>} [rules] The definition of plugin rules.
- */
-
-/**
- * Information of deprecated rules.
- * @typedef {Object} DeprecatedRuleInfo
- * @property {string} ruleId The rule ID.
- * @property {string[]} replacedBy The rule IDs that replace this deprecated rule.
- */
-
-/**
- * A linting result.
- * @typedef {Object} LintResult
- * @property {string} filePath The path to the file that was linted.
- * @property {LintMessage[]} messages All of the messages for the result.
- * @property {SuppressedLintMessage[]} suppressedMessages All of the suppressed messages for the result.
- * @property {number} errorCount Number of errors for the result.
- * @property {number} fatalErrorCount Number of fatal errors for the result.
- * @property {number} warningCount Number of warnings for the result.
- * @property {number} fixableErrorCount Number of fixable errors for the result.
- * @property {number} fixableWarningCount Number of fixable warnings for the result.
- * @property {string} [source] The source code of the file that was linted.
- * @property {string} [output] The source code of the file that was linted, with as many fixes applied as possible.
- * @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, maxWarningsExceeded?: MaxWarningsExceeded, rulesMeta: Record<string, RuleMeta>}} [context] A context object.
- * @returns {string | Promise<string>} Formatted text.
- */

package/lib/source-code/index.js

@@ -1,5 +0,0 @@
-"use strict";
-
-module.exports = {
-    SourceCode: require("./source-code")
-};