@alexlit/lint-kit 126.6.0 → 127.0.0

package/packages/config-eslint/node_modules/eslint/lib/linter/report-translator.js

@@ -0,0 +1,376 @@
+/**
+ * @fileoverview A helper that translates context.report() calls from the rule API into generic problem objects
+ * @author Teddy Katz
+ */
+
+"use strict";
+
+//------------------------------------------------------------------------------
+// Requirements
+//------------------------------------------------------------------------------
+
+const assert = require("node:assert");
+const { RuleFixer } = require("./rule-fixer");
+const { interpolate } = require("./interpolate");
+
+//------------------------------------------------------------------------------
+// Typedefs
+//------------------------------------------------------------------------------
+
+/** @typedef {import("../shared/types").LintMessage} LintMessage */
+
+/**
+ * An error message description
+ * @typedef {Object} MessageDescriptor
+ * @property {ASTNode} [node] The reported node
+ * @property {Location} loc The location of the problem.
+ * @property {string} message The problem message.
+ * @property {Object} [data] Optional data to use to fill in placeholders in the
+ *      message.
+ * @property {Function} [fix] The function to call that creates a fix command.
+ * @property {Array<{desc?: string, messageId?: string, fix: Function}>} suggest Suggestion descriptions and functions to create a the associated fixes.
+ */
+
+//------------------------------------------------------------------------------
+// Module Definition
+//------------------------------------------------------------------------------
+
+
+/**
+ * Translates a multi-argument context.report() call into a single object argument call
+ * @param {...*} args A list of arguments passed to `context.report`
+ * @returns {MessageDescriptor} A normalized object containing report information
+ */
+function normalizeMultiArgReportCall(...args) {
+
+    // If there is one argument, it is considered to be a new-style call already.
+    if (args.length === 1) {
+
+        // Shallow clone the object to avoid surprises if reusing the descriptor
+        return Object.assign({}, args[0]);
+    }
+
+    // If the second argument is a string, the arguments are interpreted as [node, message, data, fix].
+    if (typeof args[1] === "string") {
+        return {
+            node: args[0],
+            message: args[1],
+            data: args[2],
+            fix: args[3]
+        };
+    }
+
+    // Otherwise, the arguments are interpreted as [node, loc, message, data, fix].
+    return {
+        node: args[0],
+        loc: args[1],
+        message: args[2],
+        data: args[3],
+        fix: args[4]
+    };
+}
+
+/**
+ * Asserts that either a loc or a node was provided, and the node is valid if it was provided.
+ * @param {MessageDescriptor} descriptor A descriptor to validate
+ * @returns {void}
+ * @throws AssertionError if neither a node nor a loc was provided, or if the node is not an object
+ */
+function assertValidNodeInfo(descriptor) {
+    if (descriptor.node) {
+        assert(typeof descriptor.node === "object", "Node must be an object");
+    } else {
+        assert(descriptor.loc, "Node must be provided when reporting error if location is not provided");
+    }
+}
+
+/**
+ * Normalizes a MessageDescriptor to always have a `loc` with `start` and `end` properties
+ * @param {MessageDescriptor} descriptor A descriptor for the report from a rule.
+ * @returns {{start: Location, end: (Location|null)}} An updated location that infers the `start` and `end` properties
+ * from the `node` of the original descriptor, or infers the `start` from the `loc` of the original descriptor.
+ */
+function normalizeReportLoc(descriptor) {
+    if (descriptor.loc.start) {
+        return descriptor.loc;
+    }
+    return { start: descriptor.loc, end: null };
+}
+
+/**
+ * Clones the given fix object.
+ * @param {Fix|null} fix The fix to clone.
+ * @returns {Fix|null} Deep cloned fix object or `null` if `null` or `undefined` was passed in.
+ */
+function cloneFix(fix) {
+    if (!fix) {
+        return null;
+    }
+
+    return {
+        range: [fix.range[0], fix.range[1]],
+        text: fix.text
+    };
+}
+
+/**
+ * Check that a fix has a valid range.
+ * @param {Fix|null} fix The fix to validate.
+ * @returns {void}
+ */
+function assertValidFix(fix) {
+    if (fix) {
+        assert(fix.range && typeof fix.range[0] === "number" && typeof fix.range[1] === "number", `Fix has invalid range: ${JSON.stringify(fix, null, 2)}`);
+    }
+}
+
+/**
+ * Compares items in a fixes array by range.
+ * @param {Fix} a The first message.
+ * @param {Fix} b The second message.
+ * @returns {int} -1 if a comes before b, 1 if a comes after b, 0 if equal.
+ * @private
+ */
+function compareFixesByRange(a, b) {
+    return a.range[0] - b.range[0] || a.range[1] - b.range[1];
+}
+
+/**
+ * Merges the given fixes array into one.
+ * @param {Fix[]} fixes The fixes to merge.
+ * @param {SourceCode} sourceCode The source code object to get the text between fixes.
+ * @returns {{text: string, range: number[]}} The merged fixes
+ */
+function mergeFixes(fixes, sourceCode) {
+    for (const fix of fixes) {
+        assertValidFix(fix);
+    }
+
+    if (fixes.length === 0) {
+        return null;
+    }
+    if (fixes.length === 1) {
+        return cloneFix(fixes[0]);
+    }
+
+    fixes.sort(compareFixesByRange);
+
+    const originalText = sourceCode.text;
+    const start = fixes[0].range[0];
+    const end = fixes.at(-1).range[1];
+    let text = "";
+    let lastPos = Number.MIN_SAFE_INTEGER;
+
+    for (const fix of fixes) {
+        assert(fix.range[0] >= lastPos, "Fix objects must not be overlapped in a report.");
+
+        if (fix.range[0] >= 0) {
+            text += originalText.slice(Math.max(0, start, lastPos), fix.range[0]);
+        }
+        text += fix.text;
+        lastPos = fix.range[1];
+    }
+    text += originalText.slice(Math.max(0, start, lastPos), end);
+
+    return { range: [start, end], text };
+}
+
+/**
+ * Gets one fix object from the given descriptor.
+ * If the descriptor retrieves multiple fixes, this merges those to one.
+ * @param {MessageDescriptor} descriptor The report descriptor.
+ * @param {SourceCode} sourceCode The source code object to get text between fixes.
+ * @returns {({text: string, range: number[]}|null)} The fix for the descriptor
+ */
+function normalizeFixes(descriptor, sourceCode) {
+    if (typeof descriptor.fix !== "function") {
+        return null;
+    }
+
+    const ruleFixer = new RuleFixer({ sourceCode });
+
+    // @type {null | Fix | Fix[] | IterableIterator<Fix>}
+    const fix = descriptor.fix(ruleFixer);
+
+    // Merge to one.
+    if (fix && Symbol.iterator in fix) {
+        return mergeFixes(Array.from(fix), sourceCode);
+    }
+
+    assertValidFix(fix);
+    return cloneFix(fix);
+}
+
+/**
+ * Gets an array of suggestion objects from the given descriptor.
+ * @param {MessageDescriptor} descriptor The report descriptor.
+ * @param {SourceCode} sourceCode The source code object to get text between fixes.
+ * @param {Object} messages Object of meta messages for the rule.
+ * @returns {Array<SuggestionResult>} The suggestions for the descriptor
+ */
+function mapSuggestions(descriptor, sourceCode, messages) {
+    if (!descriptor.suggest || !Array.isArray(descriptor.suggest)) {
+        return [];
+    }
+
+    return descriptor.suggest
+        .map(suggestInfo => {
+            const computedDesc = suggestInfo.desc || messages[suggestInfo.messageId];
+
+            return {
+                ...suggestInfo,
+                desc: interpolate(computedDesc, suggestInfo.data),
+                fix: normalizeFixes(suggestInfo, sourceCode)
+            };
+        })
+
+        // Remove suggestions that didn't provide a fix
+        .filter(({ fix }) => fix);
+}
+
+/**
+ * Creates information about the report from a descriptor
+ * @param {Object} options Information about the problem
+ * @param {string} options.ruleId Rule ID
+ * @param {(0|1|2)} options.severity Rule severity
+ * @param {(ASTNode|null)} options.node Node
+ * @param {string} options.message Error message
+ * @param {string} [options.messageId] The error message ID.
+ * @param {{start: SourceLocation, end: (SourceLocation|null)}} options.loc Start and end location
+ * @param {{text: string, range: (number[]|null)}} options.fix The fix object
+ * @param {Array<{text: string, range: (number[]|null)}>} options.suggestions The array of suggestions objects
+ * @param {Language} [options.language] The language to use to adjust line and column offsets.
+ * @returns {LintMessage} Information about the report
+ */
+function createProblem(options) {
+    const { language } = options;
+
+    // calculate offsets based on the language in use
+    const columnOffset = language.columnStart === 1 ? 0 : 1;
+    const lineOffset = language.lineStart === 1 ? 0 : 1;
+
+    const problem = {
+        ruleId: options.ruleId,
+        severity: options.severity,
+        message: options.message,
+        line: options.loc.start.line + lineOffset,
+        column: options.loc.start.column + columnOffset,
+        nodeType: options.node && options.node.type || null
+    };
+
+    /*
+     * If this isn’t in the conditional, some of the tests fail
+     * because `messageId` is present in the problem object
+     */
+    if (options.messageId) {
+        problem.messageId = options.messageId;
+    }
+
+    if (options.loc.end) {
+        problem.endLine = options.loc.end.line + lineOffset;
+        problem.endColumn = options.loc.end.column + columnOffset;
+    }
+
+    if (options.fix) {
+        problem.fix = options.fix;
+    }
+
+    if (options.suggestions && options.suggestions.length > 0) {
+        problem.suggestions = options.suggestions;
+    }
+
+    return problem;
+}
+
+/**
+ * Validates that suggestions are properly defined. Throws if an error is detected.
+ * @param {Array<{ desc?: string, messageId?: string }>} suggest The incoming suggest data.
+ * @param {Object} messages Object of meta messages for the rule.
+ * @returns {void}
+ */
+function validateSuggestions(suggest, messages) {
+    if (suggest && Array.isArray(suggest)) {
+        suggest.forEach(suggestion => {
+            if (suggestion.messageId) {
+                const { messageId } = suggestion;
+
+                if (!messages) {
+                    throw new TypeError(`context.report() called with a suggest option with a messageId '${messageId}', but no messages were present in the rule metadata.`);
+                }
+
+                if (!messages[messageId]) {
+                    throw new TypeError(`context.report() called with a suggest option with a messageId '${messageId}' which is not present in the 'messages' config: ${JSON.stringify(messages, null, 2)}`);
+                }
+
+                if (suggestion.desc) {
+                    throw new TypeError("context.report() called with a suggest option that defines both a 'messageId' and an 'desc'. Please only pass one.");
+                }
+            } else if (!suggestion.desc) {
+                throw new TypeError("context.report() called with a suggest option that doesn't have either a `desc` or `messageId`");
+            }
+
+            if (typeof suggestion.fix !== "function") {
+                throw new TypeError(`context.report() called with a suggest option without a fix function. See: ${suggestion}`);
+            }
+        });
+    }
+}
+
+/**
+ * Returns a function that converts the arguments of a `context.report` call from a rule into a reported
+ * problem for the Node.js API.
+ * @param {{ruleId: string, severity: number, sourceCode: SourceCode, messageIds: Object, disableFixes: boolean, language:Language}} metadata Metadata for the reported problem
+ * @returns {function(...args): LintMessage} Function that returns information about the report
+ */
+
+module.exports = function createReportTranslator(metadata) {
+
+    /*
+     * `createReportTranslator` gets called once per enabled rule per file. It needs to be very performant.
+     * The report translator itself (i.e. the function that `createReportTranslator` returns) gets
+     * called every time a rule reports a problem, which happens much less frequently (usually, the vast
+     * majority of rules don't report any problems for a given file).
+     */
+    return (...args) => {
+        const descriptor = normalizeMultiArgReportCall(...args);
+        const messages = metadata.messageIds;
+        const { sourceCode } = metadata;
+
+        assertValidNodeInfo(descriptor);
+
+        let computedMessage;
+
+        if (descriptor.messageId) {
+            if (!messages) {
+                throw new TypeError("context.report() called with a messageId, but no messages were present in the rule metadata.");
+            }
+            const id = descriptor.messageId;
+
+            if (descriptor.message) {
+                throw new TypeError("context.report() called with a message and a messageId. Please only pass one.");
+            }
+            if (!messages || !Object.hasOwn(messages, id)) {
+                throw new TypeError(`context.report() called with a messageId of '${id}' which is not present in the 'messages' config: ${JSON.stringify(messages, null, 2)}`);
+            }
+            computedMessage = messages[id];
+        } else if (descriptor.message) {
+            computedMessage = descriptor.message;
+        } else {
+            throw new TypeError("Missing `message` property in report() call; add a message that describes the linting problem.");
+        }
+
+        validateSuggestions(descriptor.suggest, messages);
+
+        return createProblem({
+            ruleId: metadata.ruleId,
+            severity: metadata.severity,
+            node: descriptor.node,
+            message: interpolate(computedMessage, descriptor.data),
+            messageId: descriptor.messageId,
+            loc: descriptor.loc ? normalizeReportLoc(descriptor) : sourceCode.getLoc(descriptor.node),
+            fix: metadata.disableFixes ? null : normalizeFixes(descriptor, sourceCode),
+            suggestions: metadata.disableFixes ? [] : mapSuggestions(descriptor, sourceCode, messages),
+            language: metadata.language
+        });
+    };
+};

package/packages/config-eslint/node_modules/eslint/lib/linter/rule-fixer.js

@@ -0,0 +1,163 @@
+/**
+ * @fileoverview An object that creates fix commands for rules.
+ * @author Nicholas C. Zakas
+ */
+"use strict";
+
+/* eslint class-methods-use-this: off -- Methods desired on instance */
+
+//------------------------------------------------------------------------------
+// Requirements
+//------------------------------------------------------------------------------
+
+// none!
+
+//------------------------------------------------------------------------------
+// Helpers
+//------------------------------------------------------------------------------
+
+/**
+ * Creates a fix command that inserts text at the specified index in the source text.
+ * @param {int} index The 0-based index at which to insert the new text.
+ * @param {string} text The text to insert.
+ * @returns {Object} The fix command.
+ * @private
+ */
+function insertTextAt(index, text) {
+    return {
+        range: [index, index],
+        text
+    };
+}
+
+//------------------------------------------------------------------------------
+// Public Interface
+//------------------------------------------------------------------------------
+
+/**
+ * Creates code fixing commands for rules.
+ */
+class RuleFixer {
+
+    /**
+     * The source code object representing the text to be fixed.
+     * @type {SourceCode}
+     */
+    #sourceCode;
+
+    /**
+     * Creates a new instance.
+     * @param {Object} options The options for the fixer.
+     * @param {SourceCode} options.sourceCode The source code object representing the text to be fixed.
+     */
+    constructor({ sourceCode }) {
+        this.#sourceCode = sourceCode;
+    }
+
+    /**
+     * Creates a fix command that inserts text after the given node or token.
+     * The fix is not applied until applyFixes() is called.
+     * @param {ASTNode|Token} nodeOrToken The node or token to insert after.
+     * @param {string} text The text to insert.
+     * @returns {Object} The fix command.
+     */
+    insertTextAfter(nodeOrToken, text) {
+        const range = this.#sourceCode.getRange(nodeOrToken);
+
+        return this.insertTextAfterRange(range, text);
+    }
+
+    /**
+     * Creates a fix command that inserts text after the specified range in the source text.
+     * The fix is not applied until applyFixes() is called.
+     * @param {int[]} range The range to replace, first item is start of range, second
+     *      is end of range.
+     * @param {string} text The text to insert.
+     * @returns {Object} The fix command.
+     */
+    insertTextAfterRange(range, text) {
+        return insertTextAt(range[1], text);
+    }
+
+    /**
+     * Creates a fix command that inserts text before the given node or token.
+     * The fix is not applied until applyFixes() is called.
+     * @param {ASTNode|Token} nodeOrToken The node or token to insert before.
+     * @param {string} text The text to insert.
+     * @returns {Object} The fix command.
+     */
+    insertTextBefore(nodeOrToken, text) {
+        const range = this.#sourceCode.getRange(nodeOrToken);
+
+        return this.insertTextBeforeRange(range, text);
+    }
+
+    /**
+     * Creates a fix command that inserts text before the specified range in the source text.
+     * The fix is not applied until applyFixes() is called.
+     * @param {int[]} range The range to replace, first item is start of range, second
+     *      is end of range.
+     * @param {string} text The text to insert.
+     * @returns {Object} The fix command.
+     */
+    insertTextBeforeRange(range, text) {
+        return insertTextAt(range[0], text);
+    }
+
+    /**
+     * Creates a fix command that replaces text at the node or token.
+     * The fix is not applied until applyFixes() is called.
+     * @param {ASTNode|Token} nodeOrToken The node or token to remove.
+     * @param {string} text The text to insert.
+     * @returns {Object} The fix command.
+     */
+    replaceText(nodeOrToken, text) {
+        const range = this.#sourceCode.getRange(nodeOrToken);
+
+        return this.replaceTextRange(range, text);
+    }
+
+    /**
+     * Creates a fix command that replaces text at the specified range in the source text.
+     * The fix is not applied until applyFixes() is called.
+     * @param {int[]} range The range to replace, first item is start of range, second
+     *      is end of range.
+     * @param {string} text The text to insert.
+     * @returns {Object} The fix command.
+     */
+    replaceTextRange(range, text) {
+        return {
+            range,
+            text
+        };
+    }
+
+    /**
+     * Creates a fix command that removes the node or token from the source.
+     * The fix is not applied until applyFixes() is called.
+     * @param {ASTNode|Token} nodeOrToken The node or token to remove.
+     * @returns {Object} The fix command.
+     */
+    remove(nodeOrToken) {
+        const range = this.#sourceCode.getRange(nodeOrToken);
+
+        return this.removeRange(range);
+    }
+
+    /**
+     * Creates a fix command that removes the specified range of text from the source.
+     * The fix is not applied until applyFixes() is called.
+     * @param {int[]} range The range to remove, first item is start of range, second
+     *      is end of range.
+     * @returns {Object} The fix command.
+     */
+    removeRange(range) {
+        return {
+            range,
+            text: ""
+        };
+    }
+}
+
+
+module.exports = { RuleFixer };

package/packages/config-eslint/node_modules/eslint/lib/linter/rules.js

@@ -0,0 +1,71 @@
+/**
+ * @fileoverview Defines a storage for rules.
+ * @author Nicholas C. Zakas
+ * @author aladdin-add
+ */
+
+"use strict";
+
+//------------------------------------------------------------------------------
+// Requirements
+//------------------------------------------------------------------------------
+
+const builtInRules = require("../rules");
+
+//------------------------------------------------------------------------------
+// Typedefs
+//------------------------------------------------------------------------------
+
+/** @typedef {import("../shared/types").Rule} Rule */
+
+//------------------------------------------------------------------------------
+// Public Interface
+//------------------------------------------------------------------------------
+
+/**
+ * A storage for rules.
+ */
+class Rules {
+    constructor() {
+        this._rules = Object.create(null);
+    }
+
+    /**
+     * Registers a rule module for rule id in storage.
+     * @param {string} ruleId Rule id (file name).
+     * @param {Rule} rule Rule object.
+     * @returns {void}
+     */
+    define(ruleId, rule) {
+        this._rules[ruleId] = rule;
+    }
+
+    /**
+     * Access rule handler by id (file name).
+     * @param {string} ruleId Rule id (file name).
+     * @returns {Rule} Rule object.
+     */
+    get(ruleId) {
+        if (typeof this._rules[ruleId] === "string") {
+            this.define(ruleId, require(this._rules[ruleId]));
+        }
+        if (this._rules[ruleId]) {
+            return this._rules[ruleId];
+        }
+        if (builtInRules.has(ruleId)) {
+            return builtInRules.get(ruleId);
+        }
+
+        return null;
+    }
+
+    *[Symbol.iterator]() {
+        yield* builtInRules;
+
+        for (const ruleId of Object.keys(this._rules)) {
+            yield [ruleId, this.get(ruleId)];
+        }
+    }
+}
+
+module.exports = Rules;

package/packages/config-eslint/node_modules/eslint/lib/linter/safe-emitter.js

@@ -0,0 +1,52 @@
+/**
+ * @fileoverview A variant of EventEmitter which does not give listeners information about each other
+ * @author Teddy Katz
+ */
+
+"use strict";
+
+//------------------------------------------------------------------------------
+// Typedefs
+//------------------------------------------------------------------------------
+
+/**
+ * An event emitter
+ * @typedef {Object} SafeEmitter
+ * @property {(eventName: string, listenerFunc: Function) => void} on Adds a listener for a given event name
+ * @property {(eventName: string, arg1?: any, arg2?: any, arg3?: any) => void} emit Emits an event with a given name.
+ * This calls all the listeners that were listening for that name, with `arg1`, `arg2`, and `arg3` as arguments.
+ * @property {function(): string[]} eventNames Gets the list of event names that have registered listeners.
+ */
+
+/**
+ * Creates an object which can listen for and emit events.
+ * This is similar to the EventEmitter API in Node's standard library, but it has a few differences.
+ * The goal is to allow multiple modules to attach arbitrary listeners to the same emitter, without
+ * letting the modules know about each other at all.
+ * 1. It has no special keys like `error` and `newListener`, which would allow modules to detect when
+ * another module throws an error or registers a listener.
+ * 2. It calls listener functions without any `this` value. (`EventEmitter` calls listeners with a
+ * `this` value of the emitter instance, which would give listeners access to other listeners.)
+ * @returns {SafeEmitter} An emitter
+ */
+module.exports = () => {
+    const listeners = Object.create(null);
+
+    return Object.freeze({
+        on(eventName, listener) {
+            if (eventName in listeners) {
+                listeners[eventName].push(listener);
+            } else {
+                listeners[eventName] = [listener];
+            }
+        },
+        emit(eventName, ...args) {
+            if (eventName in listeners) {
+                listeners[eventName].forEach(listener => listener(...args));
+            }
+        },
+        eventNames() {
+            return Object.keys(listeners);
+        }
+    });
+};