eslint 9.39.1 → 10.0.0-alpha.0

package/lib/linter/rule-fixer.js

@@ -38,6 +38,18 @@ function insertTextAt(index, text) {
 	};
 }
 
+/**
+ * Asserts that the provided text is a string.
+ * @param {unknown} text The text to validate.
+ * @returns {void}
+ * @throws {TypeError} If `text` is not a string.
+ */
+function assertIsString(text) {
+	if (typeof text !== "string") {
+		throw new TypeError("'text' must be a string");
+	}
+}
+
 //------------------------------------------------------------------------------
 // Public Interface
 //------------------------------------------------------------------------------
@@ -67,8 +79,11 @@ class RuleFixer {
 	 * @param {ASTNode|Token} nodeOrToken The node or token to insert after.
 	 * @param {string} text The text to insert.
 	 * @returns {Object} The fix command.
+	 * @throws {TypeError} If `text` is not a string.
 	 */
 	insertTextAfter(nodeOrToken, text) {
+		assertIsString(text);
+
 		const range = this.#sourceCode.getRange(nodeOrToken);
 
 		return this.insertTextAfterRange(range, text);
@@ -81,8 +96,11 @@ class RuleFixer {
 	 *      is end of range.
 	 * @param {string} text The text to insert.
 	 * @returns {Object} The fix command.
+	 * @throws {TypeError} If `text` is not a string.
 	 */
 	insertTextAfterRange(range, text) {
+		assertIsString(text);
+
 		return insertTextAt(range[1], text);
 	}
 
@@ -92,8 +110,11 @@ class RuleFixer {
 	 * @param {ASTNode|Token} nodeOrToken The node or token to insert before.
 	 * @param {string} text The text to insert.
 	 * @returns {Object} The fix command.
+	 * @throws {TypeError} If `text` is not a string.
 	 */
 	insertTextBefore(nodeOrToken, text) {
+		assertIsString(text);
+
 		const range = this.#sourceCode.getRange(nodeOrToken);
 
 		return this.insertTextBeforeRange(range, text);
@@ -106,8 +127,11 @@ class RuleFixer {
 	 *      is end of range.
 	 * @param {string} text The text to insert.
 	 * @returns {Object} The fix command.
+	 * @throws {TypeError} If `text` is not a string.
 	 */
 	insertTextBeforeRange(range, text) {
+		assertIsString(text);
+
 		return insertTextAt(range[0], text);
 	}
 
@@ -117,8 +141,11 @@ class RuleFixer {
 	 * @param {ASTNode|Token} nodeOrToken The node or token to remove.
 	 * @param {string} text The text to insert.
 	 * @returns {Object} The fix command.
+	 * @throws {TypeError} If `text` is not a string.
 	 */
 	replaceText(nodeOrToken, text) {
+		assertIsString(text);
+
 		const range = this.#sourceCode.getRange(nodeOrToken);
 
 		return this.replaceTextRange(range, text);
@@ -131,8 +158,11 @@ class RuleFixer {
 	 *      is end of range.
 	 * @param {string} text The text to insert.
 	 * @returns {Object} The fix command.
+	 * @throws {TypeError} If `text` is not a string.
 	 */
 	replaceTextRange(range, text) {
+		assertIsString(text);
+
 		return {
 			range,
 			text,

package/lib/options.js

@@ -24,12 +24,10 @@ const optionator = require("optionator");
  * @property {"metadata" | "content"} cacheStrategy Strategy to use for detecting changed files in the cache
  * @property {boolean} [color] Force enabling/disabling of color
  * @property {number | "auto" | "off"} [concurrency] Number of linting threads, "auto" to choose automatically, "off" for no multithreading
- * @property {string} [config] Use this configuration, overriding .eslintrc.* config options if present
+ * @property {string} [config] Use this configuration, overriding eslint.config.* config options if present
  * @property {boolean} debug Output debugging information
- * @property {string[]} [env] Specify environments
  * @property {boolean} envInfo Output execution environment information
  * @property {boolean} errorOnUnmatchedPattern Prevent errors when pattern is unmatched
- * @property {boolean} eslintrc Disable use of configuration from .eslintrc.*
  * @property {string[]} [ext] Specify JavaScript file extensions
  * @property {string[]} [flag] Feature flags
  * @property {boolean} fix Automatically fix problems
@@ -39,8 +37,7 @@ const optionator = require("optionator");
  * @property {string[]} [global] Define global variables
  * @property {boolean} [help] Show help
  * @property {boolean} ignore Disable use of ignore files and patterns
- * @property {string} [ignorePath] Specify path of ignore file
- * @property {string[]} [ignorePattern] Patterns of files to ignore. In eslintrc mode, these are in addition to `.eslintignore`
+ * @property {string[]} [ignorePattern] Patterns of files to ignore
  * @property {boolean} init Run config initialization wizard
  * @property {boolean} inlineConfig Prevent comments from changing config or rules
  * @property {number} maxWarnings Number of warnings to trigger nonzero exit code
@@ -56,9 +53,7 @@ const optionator = require("optionator");
  * @property {boolean} quiet Report errors only
  * @property {boolean | undefined} reportUnusedDisableDirectives Adds reported errors for unused eslint-disable and eslint-enable directives
  * @property {string | undefined} reportUnusedDisableDirectivesSeverity A severity string indicating if and how unused disable and enable directives should be tracked and reported.
- * @property {string} [resolvePluginsRelativeTo] A folder where plugins should be resolved from, CWD by default
  * @property {Object} [rule] Specify rules
- * @property {string[]} [rulesdir] Load additional rules from this directory. Deprecated: Use rules from plugins
  * @property {boolean} [stats] Report additional statistics
  * @property {boolean} stdin Lint code provided on <STDIN>
  * @property {string} [stdinFilename] Specify filename to process STDIN as
@@ -78,165 +73,9 @@ const optionator = require("optionator");
 
 /**
  * Creates the CLI options for ESLint.
- * @param {boolean} usingFlatConfig Indicates if flat config is being used.
  * @returns {Object} The optionator instance.
  */
-module.exports = function (usingFlatConfig) {
-	let lookupFlag;
-
-	if (usingFlatConfig) {
-		lookupFlag = {
-			option: "config-lookup",
-			type: "Boolean",
-			default: "true",
-			description: "Disable look up for eslint.config.js",
-		};
-	} else {
-		lookupFlag = {
-			option: "eslintrc",
-			type: "Boolean",
-			default: "true",
-			description: "Disable use of configuration from .eslintrc.*",
-		};
-	}
-
-	let envFlag;
-
-	if (!usingFlatConfig) {
-		envFlag = {
-			option: "env",
-			type: "[String]",
-			description: "Specify environments",
-		};
-	}
-
-	let inspectConfigFlag;
-
-	if (usingFlatConfig) {
-		inspectConfigFlag = {
-			option: "inspect-config",
-			type: "Boolean",
-			description:
-				"Open the config inspector with the current configuration",
-		};
-	}
-
-	let extFlag;
-
-	if (!usingFlatConfig) {
-		extFlag = {
-			option: "ext",
-			type: "[String]",
-			description: "Specify JavaScript file extensions",
-		};
-	} else {
-		extFlag = {
-			option: "ext",
-			type: "[String]",
-			description: "Specify additional file extensions to lint",
-		};
-	}
-
-	let resolvePluginsFlag;
-
-	if (!usingFlatConfig) {
-		resolvePluginsFlag = {
-			option: "resolve-plugins-relative-to",
-			type: "path::String",
-			description:
-				"A folder where plugins should be resolved from, CWD by default",
-		};
-	}
-
-	let rulesDirFlag;
-
-	if (!usingFlatConfig) {
-		rulesDirFlag = {
-			option: "rulesdir",
-			type: "[path::String]",
-			description:
-				"Load additional rules from this directory. Deprecated: Use rules from plugins",
-		};
-	}
-
-	let ignorePathFlag;
-
-	if (!usingFlatConfig) {
-		ignorePathFlag = {
-			option: "ignore-path",
-			type: "path::String",
-			description: "Specify path of ignore file",
-		};
-	}
-
-	let statsFlag;
-
-	if (usingFlatConfig) {
-		statsFlag = {
-			option: "stats",
-			type: "Boolean",
-			default: "false",
-			description: "Add statistics to the lint report",
-		};
-	}
-
-	let warnIgnoredFlag;
-
-	if (usingFlatConfig) {
-		warnIgnoredFlag = {
-			option: "warn-ignored",
-			type: "Boolean",
-			default: "true",
-			description:
-				"Suppress warnings when the file list includes ignored files",
-		};
-	}
-
-	let flagFlag;
-
-	if (usingFlatConfig) {
-		flagFlag = {
-			option: "flag",
-			type: "[String]",
-			description: "Enable a feature flag",
-		};
-	}
-
-	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"],
-		};
-	}
-
-	let mcpFlag;
-
-	if (usingFlatConfig) {
-		mcpFlag = {
-			option: "mcp",
-			type: "Boolean",
-			description: "Start the ESLint MCP server",
-		};
-	}
-
-	let concurrencyFlag;
-
-	if (usingFlatConfig) {
-		concurrencyFlag = {
-			option: "concurrency",
-			type: "Int|String",
-			default: "off",
-			description:
-				"Number of linting threads, auto to choose automatically, off for no multithreading",
-		};
-	}
-
+module.exports = function () {
 	return optionator({
 		prepend: "eslint [options] file.js [file.js] [dir]",
 		defaults: {
@@ -247,18 +86,30 @@ module.exports = function (usingFlatConfig) {
 			{
 				heading: "Basic configuration",
 			},
-			lookupFlag,
+			{
+				option: "config-lookup",
+				type: "Boolean",
+				default: "true",
+				description: "Disable look up for eslint.config.js",
+			},
 			{
 				option: "config",
 				alias: "c",
 				type: "path::String",
-				description: usingFlatConfig
-					? "Use this configuration instead of eslint.config.js, eslint.config.mjs, or eslint.config.cjs"
-					: "Use this configuration, overriding .eslintrc.* config options if present",
+				description:
+					"Use this configuration instead of eslint.config.js, eslint.config.mjs, or eslint.config.cjs",
+			},
+			{
+				option: "inspect-config",
+				type: "Boolean",
+				description:
+					"Open the config inspector with the current configuration",
+			},
+			{
+				option: "ext",
+				type: "[String]",
+				description: "Specify additional file extensions to lint",
 			},
-			inspectConfigFlag,
-			envFlag,
-			extFlag,
 			{
 				option: "global",
 				type: "[String]",
@@ -274,7 +125,6 @@ module.exports = function (usingFlatConfig) {
 				type: "Object",
 				description: "Specify parser options",
 			},
-			resolvePluginsFlag,
 			{
 				heading: "Specify Rules and Plugins",
 			},
@@ -288,7 +138,6 @@ module.exports = function (usingFlatConfig) {
 				type: "Object",
 				description: "Specify rules",
 			},
-			rulesDirFlag,
 			{
 				heading: "Fix Problems",
 			},
@@ -314,7 +163,6 @@ module.exports = function (usingFlatConfig) {
 			{
 				heading: "Ignore Files",
 			},
-			ignorePathFlag,
 			{
 				option: "ignore",
 				type: "Boolean",
@@ -324,7 +172,7 @@ module.exports = function (usingFlatConfig) {
 			{
 				option: "ignore-pattern",
 				type: "[String]",
-				description: `Patterns of files to ignore${usingFlatConfig ? "" : " (in addition to those in .eslintignore)"}`,
+				description: "Patterns of files to ignore",
 				concatRepeatedArrays: [
 					true,
 					{
@@ -407,7 +255,14 @@ module.exports = function (usingFlatConfig) {
 					"Chooses severity level for reporting unused eslint-disable and eslint-enable directives",
 				enum: ["off", "warn", "error", "0", "1", "2"],
 			},
-			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"],
+			},
 			{
 				heading: "Caching",
 			},
@@ -496,7 +351,13 @@ module.exports = function (usingFlatConfig) {
 				default: "false",
 				description: "Exit with exit code 2 in case of fatal error",
 			},
-			warnIgnoredFlag,
+			{
+				option: "warn-ignored",
+				type: "Boolean",
+				default: "true",
+				description:
+					"Suppress warnings when the file list includes ignored files",
+			},
 			{
 				option: "pass-on-no-patterns",
 				type: "Boolean",
@@ -527,10 +388,29 @@ module.exports = function (usingFlatConfig) {
 				type: "path::String",
 				description: "Print the configuration for the given file",
 			},
-			statsFlag,
-			flagFlag,
-			mcpFlag,
-			concurrencyFlag,
-		].filter(value => !!value),
+			{
+				option: "stats",
+				type: "Boolean",
+				default: "false",
+				description: "Add statistics to the lint report",
+			},
+			{
+				option: "flag",
+				type: "[String]",
+				description: "Enable a feature flag",
+			},
+			{
+				option: "mcp",
+				type: "Boolean",
+				description: "Start the ESLint MCP server",
+			},
+			{
+				option: "concurrency",
+				type: "Int|String",
+				default: "off",
+				description:
+					"Number of linting threads, auto to choose automatically, off for no multithreading",
+			},
+		],
 	});
 };