eslint 9.22.0 → 9.24.0

package/lib/linter/rule-fixer.js

@@ -24,10 +24,10 @@
  * @private
  */
 function insertTextAt(index, text) {
-    return {
-        range: [index, index],
-        text
-    };
+	return {
+		range: [index, index],
+		text,
+	};
 }
 
 //------------------------------------------------------------------------------
@@ -38,126 +38,124 @@ function insertTextAt(index, text) {
  * 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: ""
-        };
-    }
+	/**
+	 * 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/lib/linter/rules.js

@@ -16,7 +16,7 @@ const builtInRules = require("../rules");
 // Typedefs
 //------------------------------------------------------------------------------
 
-/** @typedef {import("../shared/types").Rule} Rule */
+/** @typedef {import("../types").Rule.RuleModule} Rule */
 
 //------------------------------------------------------------------------------
 // Public Interface
@@ -26,46 +26,46 @@ const builtInRules = require("../rules");
  * A storage for rules.
  */
 class Rules {
-    constructor() {
-        this._rules = Object.create(null);
-    }
+	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;
-    }
+	/**
+	 * 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);
-        }
+	/**
+	 * 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;
-    }
+		return null;
+	}
 
-    *[Symbol.iterator]() {
-        yield* builtInRules;
+	*[Symbol.iterator]() {
+		yield* builtInRules;
 
-        for (const ruleId of Object.keys(this._rules)) {
-            yield [ruleId, this.get(ruleId)];
-        }
-    }
+		for (const ruleId of Object.keys(this._rules)) {
+			yield [ruleId, this.get(ruleId)];
+		}
+	}
 }
 
 module.exports = Rules;

package/lib/linter/safe-emitter.js

@@ -30,23 +30,23 @@
  * @returns {SafeEmitter} An emitter
  */
 module.exports = () => {
-    const listeners = Object.create(null);
+	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);
-        }
-    });
+	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);
+		},
+	});
 };

package/lib/linter/source-code-fixer.js

@@ -24,7 +24,7 @@ const BOM = "\uFEFF";
  * @private
  */
 function compareMessagesByFixRange(a, b) {
-    return a.fix.range[0] - b.fix.range[0] || a.fix.range[1] - b.fix.range[1];
+	return a.fix.range[0] - b.fix.range[0] || a.fix.range[1] - b.fix.range[1];
 }
 
 /**
@@ -35,7 +35,7 @@ function compareMessagesByFixRange(a, b) {
  * @private
  */
 function compareMessagesByLocation(a, b) {
-    return a.line - b.line || a.column - b.column;
+	return a.line - b.line || a.column - b.column;
 }
 
 //------------------------------------------------------------------------------
@@ -47,7 +47,7 @@ function compareMessagesByLocation(a, b) {
  * @constructor
  */
 function SourceCodeFixer() {
-    Object.freeze(this);
+	Object.freeze(this);
 }
 
 /**
@@ -58,95 +58,97 @@ function SourceCodeFixer() {
  * @param {boolean|Function} [shouldFix=true] Determines whether each message should be fixed
  * @returns {Object} An object containing the fixed text and any unfixed messages.
  */
-SourceCodeFixer.applyFixes = function(sourceText, messages, shouldFix) {
-    debug("Applying fixes");
-
-    if (shouldFix === false) {
-        debug("shouldFix parameter was false, not attempting fixes");
-        return {
-            fixed: false,
-            messages,
-            output: sourceText
-        };
-    }
-
-    // clone the array
-    const remainingMessages = [],
-        fixes = [],
-        bom = sourceText.startsWith(BOM) ? BOM : "",
-        text = bom ? sourceText.slice(1) : sourceText;
-    let lastPos = Number.NEGATIVE_INFINITY,
-        output = bom;
-
-    /**
-     * Try to use the 'fix' from a problem.
-     * @param {Message} problem The message object to apply fixes from
-     * @returns {boolean} Whether fix was successfully applied
-     */
-    function attemptFix(problem) {
-        const fix = problem.fix;
-        const start = fix.range[0];
-        const end = fix.range[1];
-
-        // Remain it as a problem if it's overlapped or it's a negative range
-        if (lastPos >= start || start > end) {
-            remainingMessages.push(problem);
-            return false;
-        }
-
-        // Remove BOM.
-        if ((start < 0 && end >= 0) || (start === 0 && fix.text.startsWith(BOM))) {
-            output = "";
-        }
-
-        // Make output to this fix.
-        output += text.slice(Math.max(0, lastPos), Math.max(0, start));
-        output += fix.text;
-        lastPos = end;
-        return true;
-    }
-
-    messages.forEach(problem => {
-        if (Object.hasOwn(problem, "fix") && problem.fix) {
-            fixes.push(problem);
-        } else {
-            remainingMessages.push(problem);
-        }
-    });
-
-    if (fixes.length) {
-        debug("Found fixes to apply");
-        let fixesWereApplied = false;
-
-        for (const problem of fixes.sort(compareMessagesByFixRange)) {
-            if (typeof shouldFix !== "function" || shouldFix(problem)) {
-                attemptFix(problem);
-
-                /*
-                 * The only time attemptFix will fail is if a previous fix was
-                 * applied which conflicts with it.  So we can mark this as true.
-                 */
-                fixesWereApplied = true;
-            } else {
-                remainingMessages.push(problem);
-            }
-        }
-        output += text.slice(Math.max(0, lastPos));
-
-        return {
-            fixed: fixesWereApplied,
-            messages: remainingMessages.sort(compareMessagesByLocation),
-            output
-        };
-    }
-
-    debug("No fixes to apply");
-    return {
-        fixed: false,
-        messages,
-        output: bom + text
-    };
-
+SourceCodeFixer.applyFixes = function (sourceText, messages, shouldFix) {
+	debug("Applying fixes");
+
+	if (shouldFix === false) {
+		debug("shouldFix parameter was false, not attempting fixes");
+		return {
+			fixed: false,
+			messages,
+			output: sourceText,
+		};
+	}
+
+	// clone the array
+	const remainingMessages = [],
+		fixes = [],
+		bom = sourceText.startsWith(BOM) ? BOM : "",
+		text = bom ? sourceText.slice(1) : sourceText;
+	let lastPos = Number.NEGATIVE_INFINITY,
+		output = bom;
+
+	/**
+	 * Try to use the 'fix' from a problem.
+	 * @param {Message} problem The message object to apply fixes from
+	 * @returns {boolean} Whether fix was successfully applied
+	 */
+	function attemptFix(problem) {
+		const fix = problem.fix;
+		const start = fix.range[0];
+		const end = fix.range[1];
+
+		// Remain it as a problem if it's overlapped or it's a negative range
+		if (lastPos >= start || start > end) {
+			remainingMessages.push(problem);
+			return false;
+		}
+
+		// Remove BOM.
+		if (
+			(start < 0 && end >= 0) ||
+			(start === 0 && fix.text.startsWith(BOM))
+		) {
+			output = "";
+		}
+
+		// Make output to this fix.
+		output += text.slice(Math.max(0, lastPos), Math.max(0, start));
+		output += fix.text;
+		lastPos = end;
+		return true;
+	}
+
+	messages.forEach(problem => {
+		if (Object.hasOwn(problem, "fix") && problem.fix) {
+			fixes.push(problem);
+		} else {
+			remainingMessages.push(problem);
+		}
+	});
+
+	if (fixes.length) {
+		debug("Found fixes to apply");
+		let fixesWereApplied = false;
+
+		for (const problem of fixes.sort(compareMessagesByFixRange)) {
+			if (typeof shouldFix !== "function" || shouldFix(problem)) {
+				attemptFix(problem);
+
+				/*
+				 * The only time attemptFix will fail is if a previous fix was
+				 * applied which conflicts with it.  So we can mark this as true.
+				 */
+				fixesWereApplied = true;
+			} else {
+				remainingMessages.push(problem);
+			}
+		}
+		output += text.slice(Math.max(0, lastPos));
+
+		return {
+			fixed: fixesWereApplied,
+			messages: remainingMessages.sort(compareMessagesByLocation),
+			output,
+		};
+	}
+
+	debug("No fixes to apply");
+	return {
+		fixed: false,
+		messages,
+		output: bom + text,
+	};
 };
 
 module.exports = SourceCodeFixer;