eslint 8.57.1 → 9.39.1

package/lib/cli-engine/formatters/formatters-meta.json

@@ -1,46 +1,18 @@
 [
-    {
-        "name": "checkstyle",
-        "description": "Outputs results to the [Checkstyle](https://checkstyle.sourceforge.io/) format."
-    },
-    {
-        "name": "compact",
-        "description": "Human-readable output format. Mimics the default output of JSHint."
-    },
-    {
-        "name": "html",
-        "description": "Outputs results to HTML. The `html` formatter is useful for visual presentation in the browser."
-    },
-    {
-        "name": "jslint-xml",
-        "description": "Outputs results to format compatible with the [JSLint Jenkins plugin](https://plugins.jenkins.io/jslint/)."
-    },
-    {
-        "name": "json-with-metadata",
-        "description": "Outputs JSON-serialized results. The `json-with-metadata` provides the same linting results as the [`json`](#json) formatter with additional metadata about the rules applied. The linting results are included in the `results` property and the rules metadata is included in the `metadata` property.\n\nAlternatively, you can use the [ESLint Node.js API](../../integrate/nodejs-api) to programmatically use ESLint."
-    },
-    {
-        "name": "json",
-        "description": "Outputs JSON-serialized results. The `json` formatter is useful when you want to programmatically work with the CLI's linting results.\n\nAlternatively, you can use the [ESLint Node.js API](../../integrate/nodejs-api) to programmatically use ESLint."
-    },
-    {
-        "name": "junit",
-        "description": "Outputs results to format compatible with the [JUnit Jenkins plugin](https://plugins.jenkins.io/junit/)."
-    },
-    {
-        "name": "stylish",
-        "description": "Human-readable output format. This is the default formatter."
-    },
-    {
-        "name": "tap",
-        "description": "Outputs results to the [Test Anything Protocol (TAP)](https://testanything.org/) specification format."
-    },
-    {
-        "name": "unix",
-        "description": "Outputs results to a format similar to many commands in UNIX-like systems. Parsable with tools such as [grep](https://www.gnu.org/software/grep/manual/grep.html), [sed](https://www.gnu.org/software/sed/manual/sed.html), and [awk](https://www.gnu.org/software/gawk/manual/gawk.html)."
-    },
-    {
-        "name": "visualstudio",
-        "description": "Outputs results to format compatible with the integrated terminal of the [Visual Studio](https://visualstudio.microsoft.com/) IDE. When using Visual Studio, you can click on the linting results in the integrated terminal to go to the issue in the source code."
-    }
-]
+  {
+    "name": "html",
+    "description": "Outputs results to HTML. The `html` formatter is useful for visual presentation in the browser."
+  },
+  {
+    "name": "json-with-metadata",
+    "description": "Outputs JSON-serialized results. The `json-with-metadata` provides the same linting results as the [`json`](#json) formatter with additional metadata about the rules applied. The linting results are included in the `results` property and the rules metadata is included in the `metadata` property.\n\nAlternatively, you can use the [ESLint Node.js API](../../integrate/nodejs-api) to programmatically use ESLint."
+  },
+  {
+    "name": "json",
+    "description": "Outputs JSON-serialized results. The `json` formatter is useful when you want to programmatically work with the CLI's linting results.\n\nAlternatively, you can use the [ESLint Node.js API](../../integrate/nodejs-api) to programmatically use ESLint."
+  },
+  {
+    "name": "stylish",
+    "description": "Human-readable output format. This is the default formatter."
+  }
+]

package/lib/cli-engine/formatters/html.js

@@ -8,22 +8,22 @@
 // Helpers
 //------------------------------------------------------------------------------
 
-const encodeHTML = (function() {
-    const encodeHTMLRules = {
-        "&": "&",
-        "<": "&#60;",
-        ">": "&#62;",
-        '"': "&#34;",
-        "'": "&#39;"
-    };
-    const matchHTML = /[&<>"']/ug;
-
-    return function(code) {
-        return code
-            ? code.toString().replace(matchHTML, m => encodeHTMLRules[m] || m)
-            : "";
-    };
-}());
+const encodeHTML = (function () {
+	const encodeHTMLRules = {
+		"&": "&#38;",
+		"<": "&#60;",
+		">": "&#62;",
+		'"': "&#34;",
+		"'": "&#39;",
+	};
+	const matchHTML = /[&<>"']/gu;
+
+	return function (code) {
+		return code
+			? code.toString().replace(matchHTML, m => encodeHTMLRules[m] || m)
+			: "";
+	};
+})();
 
 /**
  * Get the final HTML document.
@@ -31,9 +31,9 @@ const encodeHTML = (function() {
  * @returns {string} HTML document.
  */
 function pageTemplate(it) {
-    const { reportColor, reportSummary, date, results } = it;
+	const { reportColor, reportSummary, date, results } = it;
 
-    return `
+	return `
 <!DOCTYPE html>
 <html>
     <head>
@@ -182,11 +182,11 @@ function pageTemplate(it) {
 /**
  * Given a word and a count, append an s if count is not one.
  * @param {string} word A word in its singular form.
- * @param {int} count A number controlling whether word should be pluralized.
+ * @param {number} count A number controlling whether word should be pluralized.
  * @returns {string} The original word with an s on the end if count is not one.
  */
 function pluralize(word, count) {
-    return (count === 1 ? word : `${word}s`);
+	return count === 1 ? word : `${word}s`;
 }
 
 /**
@@ -196,29 +196,29 @@ function pluralize(word, count) {
  * @returns {string} The formatted string, pluralized where necessary
  */
 function renderSummary(totalErrors, totalWarnings) {
-    const totalProblems = totalErrors + totalWarnings;
-    let renderedText = `${totalProblems} ${pluralize("problem", totalProblems)}`;
+	const totalProblems = totalErrors + totalWarnings;
+	let renderedText = `${totalProblems} ${pluralize("problem", totalProblems)}`;
 
-    if (totalProblems !== 0) {
-        renderedText += ` (${totalErrors} ${pluralize("error", totalErrors)}, ${totalWarnings} ${pluralize("warning", totalWarnings)})`;
-    }
-    return renderedText;
+	if (totalProblems !== 0) {
+		renderedText += ` (${totalErrors} ${pluralize("error", totalErrors)}, ${totalWarnings} ${pluralize("warning", totalWarnings)})`;
+	}
+	return renderedText;
 }
 
 /**
  * Get the color based on whether there are errors/warnings...
  * @param {string} totalErrors Total errors
  * @param {string} totalWarnings Total warnings
- * @returns {int} The color code (0 = green, 1 = yellow, 2 = red)
+ * @returns {number} The color code (0 = green, 1 = yellow, 2 = red)
  */
 function renderColor(totalErrors, totalWarnings) {
-    if (totalErrors !== 0) {
-        return 2;
-    }
-    if (totalWarnings !== 0) {
-        return 1;
-    }
-    return 0;
+	if (totalErrors !== 0) {
+		return 2;
+	}
+	if (totalWarnings !== 0) {
+		return 1;
+	}
+	return 0;
 }
 
 /**
@@ -227,18 +227,18 @@ function renderColor(totalErrors, totalWarnings) {
  * @returns {string} HTML (table row) describing the message.
  */
 function messageTemplate(it) {
-    const {
-        parentIndex,
-        lineNumber,
-        columnNumber,
-        severityNumber,
-        severityName,
-        message,
-        ruleUrl,
-        ruleId
-    } = it;
-
-    return `
+	const {
+		parentIndex,
+		lineNumber,
+		columnNumber,
+		severityNumber,
+		severityName,
+		message,
+		ruleUrl,
+		ruleId,
+	} = it;
+
+	return `
 <tr style="display: none;" class="f-${parentIndex}">
     <td>${lineNumber}:${columnNumber}</td>
     <td class="clr-${severityNumber}">${severityName}</td>
@@ -253,41 +253,42 @@ function messageTemplate(it) {
 /**
  * Get HTML (table rows) describing the messages.
  * @param {Array} messages Messages.
- * @param {int} parentIndex Index of the parent HTML row.
+ * @param {number} parentIndex Index of the parent HTML row.
  * @param {Object} rulesMeta Dictionary containing metadata for each rule executed by the analysis.
  * @returns {string} HTML (table rows) describing the messages.
  */
 function renderMessages(messages, parentIndex, rulesMeta) {
-
-    /**
-     * Get HTML (table row) describing a message.
-     * @param {Object} message Message.
-     * @returns {string} HTML (table row) describing a message.
-     */
-    return messages.map(message => {
-        const lineNumber = message.line || 0;
-        const columnNumber = message.column || 0;
-        let ruleUrl;
-
-        if (rulesMeta) {
-            const meta = rulesMeta[message.ruleId];
-
-            if (meta && meta.docs && meta.docs.url) {
-                ruleUrl = meta.docs.url;
-            }
-        }
-
-        return messageTemplate({
-            parentIndex,
-            lineNumber,
-            columnNumber,
-            severityNumber: message.severity,
-            severityName: message.severity === 1 ? "Warning" : "Error",
-            message: message.message,
-            ruleId: message.ruleId,
-            ruleUrl
-        });
-    }).join("\n");
+	/**
+	 * Get HTML (table row) describing a message.
+	 * @param {Object} message Message.
+	 * @returns {string} HTML (table row) describing a message.
+	 */
+	return messages
+		.map(message => {
+			const lineNumber = message.line || 0;
+			const columnNumber = message.column || 0;
+			let ruleUrl;
+
+			if (rulesMeta) {
+				const meta = rulesMeta[message.ruleId];
+
+				if (meta && meta.docs && meta.docs.url) {
+					ruleUrl = meta.docs.url;
+				}
+			}
+
+			return messageTemplate({
+				parentIndex,
+				lineNumber,
+				columnNumber,
+				severityNumber: message.severity,
+				severityName: message.severity === 1 ? "Warning" : "Error",
+				message: message.message,
+				ruleId: message.ruleId,
+				ruleUrl,
+			});
+		})
+		.join("\n");
 }
 
 /**
@@ -296,9 +297,9 @@ function renderMessages(messages, parentIndex, rulesMeta) {
  * @returns {string} HTML (table row) describing the result for the file.
  */
 function resultTemplate(it) {
-    const { color, index, filePath, summary } = it;
+	const { color, index, filePath, summary } = it;
 
-    return `
+	return `
 <tr class="bg-${color}" data-group="f-${index}">
     <th colspan="4">
         [+] ${encodeHTML(filePath)}
@@ -315,37 +316,44 @@ function resultTemplate(it) {
  * @returns {string} HTML string describing the results.
  */
 function renderResults(results, rulesMeta) {
-    return results.map((result, index) => resultTemplate({
-        index,
-        color: renderColor(result.errorCount, result.warningCount),
-        filePath: result.filePath,
-        summary: renderSummary(result.errorCount, result.warningCount)
-    }) + renderMessages(result.messages, index, rulesMeta)).join("\n");
+	return results
+		.map(
+			(result, index) =>
+				resultTemplate({
+					index,
+					color: renderColor(result.errorCount, result.warningCount),
+					filePath: result.filePath,
+					summary: renderSummary(
+						result.errorCount,
+						result.warningCount,
+					),
+				}) + renderMessages(result.messages, index, rulesMeta),
+		)
+		.join("\n");
 }
 
 //------------------------------------------------------------------------------
 // Public Interface
 //------------------------------------------------------------------------------
 
-module.exports = function(results, data) {
-    let totalErrors,
-        totalWarnings;
+module.exports = function (results, data) {
+	let totalErrors, totalWarnings;
 
-    const metaData = data ? data.rulesMeta : {};
+	const metaData = data ? data.rulesMeta : {};
 
-    totalErrors = 0;
-    totalWarnings = 0;
+	totalErrors = 0;
+	totalWarnings = 0;
 
-    // Iterate over results to get totals
-    results.forEach(result => {
-        totalErrors += result.errorCount;
-        totalWarnings += result.warningCount;
-    });
+	// Iterate over results to get totals
+	results.forEach(result => {
+		totalErrors += result.errorCount;
+		totalWarnings += result.warningCount;
+	});
 
-    return pageTemplate({
-        date: new Date(),
-        reportColor: renderColor(totalErrors, totalWarnings),
-        reportSummary: renderSummary(totalErrors, totalWarnings),
-        results: renderResults(results, metaData)
-    });
+	return pageTemplate({
+		date: new Date(),
+		reportColor: renderColor(totalErrors, totalWarnings),
+		reportSummary: renderSummary(totalErrors, totalWarnings),
+		results: renderResults(results, metaData),
+	});
 };

package/lib/cli-engine/formatters/json-with-metadata.js

@@ -8,9 +8,9 @@
 // Public Interface
 //------------------------------------------------------------------------------
 
-module.exports = function(results, data) {
-    return JSON.stringify({
-        results,
-        metadata: data
-    });
+module.exports = function (results, data) {
+	return JSON.stringify({
+		results,
+		metadata: data,
+	});
 };

package/lib/cli-engine/formatters/json.js

@@ -8,6 +8,6 @@
 // Public Interface
 //------------------------------------------------------------------------------
 
-module.exports = function(results) {
-    return JSON.stringify(results);
+module.exports = function (results) {
+	return JSON.stringify(results);
 };

package/lib/cli-engine/formatters/stylish.js

@@ -5,8 +5,8 @@
 "use strict";
 
 const chalk = require("chalk"),
-    stripAnsi = require("strip-ansi"),
-    table = require("text-table");
+	util = require("node:util"),
+	table = require("../../shared/text-table");
 
 //------------------------------------------------------------------------------
 // Helpers
@@ -15,87 +15,108 @@ const chalk = require("chalk"),
 /**
  * Given a word and a count, append an s if count is not one.
  * @param {string} word A word in its singular form.
- * @param {int} count A number controlling whether word should be pluralized.
+ * @param {number} count A number controlling whether word should be pluralized.
  * @returns {string} The original word with an s on the end if count is not one.
  */
 function pluralize(word, count) {
-    return (count === 1 ? word : `${word}s`);
+	return count === 1 ? word : `${word}s`;
 }
 
 //------------------------------------------------------------------------------
 // Public Interface
 //------------------------------------------------------------------------------
 
-module.exports = function(results) {
-
-    let output = "\n",
-        errorCount = 0,
-        warningCount = 0,
-        fixableErrorCount = 0,
-        fixableWarningCount = 0,
-        summaryColor = "yellow";
-
-    results.forEach(result => {
-        const messages = result.messages;
-
-        if (messages.length === 0) {
-            return;
-        }
-
-        errorCount += result.errorCount;
-        warningCount += result.warningCount;
-        fixableErrorCount += result.fixableErrorCount;
-        fixableWarningCount += result.fixableWarningCount;
-
-        output += `${chalk.underline(result.filePath)}\n`;
-
-        output += `${table(
-            messages.map(message => {
-                let messageType;
-
-                if (message.fatal || message.severity === 2) {
-                    messageType = chalk.red("error");
-                    summaryColor = "red";
-                } else {
-                    messageType = chalk.yellow("warning");
-                }
-
-                return [
-                    "",
-                    message.line || 0,
-                    message.column || 0,
-                    messageType,
-                    message.message.replace(/([^ ])\.$/u, "$1"),
-                    chalk.dim(message.ruleId || "")
-                ];
-            }),
-            {
-                align: ["", "r", "l"],
-                stringLength(str) {
-                    return stripAnsi(str).length;
-                }
-            }
-        ).split("\n").map(el => el.replace(/(\d+)\s+(\d+)/u, (m, p1, p2) => chalk.dim(`${p1}:${p2}`))).join("\n")}\n\n`;
-    });
-
-    const total = errorCount + warningCount;
-
-    if (total > 0) {
-        output += chalk[summaryColor].bold([
-            "\u2716 ", total, pluralize(" problem", total),
-            " (", errorCount, pluralize(" error", errorCount), ", ",
-            warningCount, pluralize(" warning", warningCount), ")\n"
-        ].join(""));
-
-        if (fixableErrorCount > 0 || fixableWarningCount > 0) {
-            output += chalk[summaryColor].bold([
-                "  ", fixableErrorCount, pluralize(" error", fixableErrorCount), " and ",
-                fixableWarningCount, pluralize(" warning", fixableWarningCount),
-                " potentially fixable with the `--fix` option.\n"
-            ].join(""));
-        }
-    }
-
-    // Resets output color, for prevent change on top level
-    return total > 0 ? chalk.reset(output) : "";
+module.exports = function (results) {
+	let output = "\n",
+		errorCount = 0,
+		warningCount = 0,
+		fixableErrorCount = 0,
+		fixableWarningCount = 0,
+		summaryColor = "yellow";
+
+	results.forEach(result => {
+		const messages = result.messages;
+
+		if (messages.length === 0) {
+			return;
+		}
+
+		errorCount += result.errorCount;
+		warningCount += result.warningCount;
+		fixableErrorCount += result.fixableErrorCount;
+		fixableWarningCount += result.fixableWarningCount;
+
+		output += `${chalk.underline(result.filePath)}\n`;
+
+		output += `${table(
+			messages.map(message => {
+				let messageType;
+
+				if (message.fatal || message.severity === 2) {
+					messageType = chalk.red("error");
+					summaryColor = "red";
+				} else {
+					messageType = chalk.yellow("warning");
+				}
+
+				return [
+					"",
+					String(message.line || 0),
+					String(message.column || 0),
+					messageType,
+					message.message.replace(/([^ ])\.$/u, "$1"),
+					chalk.dim(message.ruleId || ""),
+				];
+			}),
+			{
+				align: ["", "r", "l"],
+				stringLength(str) {
+					return util.stripVTControlCharacters(str).length;
+				},
+			},
+		)
+			.split("\n")
+			.map(el =>
+				el.replace(/(\d+)\s+(\d+)/u, (m, p1, p2) =>
+					chalk.dim(`${p1}:${p2}`),
+				),
+			)
+			.join("\n")}\n\n`;
+	});
+
+	const total = errorCount + warningCount;
+
+	if (total > 0) {
+		output += chalk[summaryColor].bold(
+			[
+				"\u2716 ",
+				total,
+				pluralize(" problem", total),
+				" (",
+				errorCount,
+				pluralize(" error", errorCount),
+				", ",
+				warningCount,
+				pluralize(" warning", warningCount),
+				")\n",
+			].join(""),
+		);
+
+		if (fixableErrorCount > 0 || fixableWarningCount > 0) {
+			output += chalk[summaryColor].bold(
+				[
+					"  ",
+					fixableErrorCount,
+					pluralize(" error", fixableErrorCount),
+					" and ",
+					fixableWarningCount,
+					pluralize(" warning", fixableWarningCount),
+					" potentially fixable with the `--fix` option.\n",
+				].join(""),
+			);
+		}
+	}
+
+	// Resets output color, for prevent change on top level
+	return total > 0 ? chalk.reset(output) : "";
 };

package/lib/cli-engine/hash.js

@@ -25,7 +25,7 @@ const murmur = require("imurmurhash");
  * @returns {string} the hash
  */
 function hash(str) {
-    return murmur(str).result().toString(36);
+	return murmur(str).result().toString(36);
 }
 
 //------------------------------------------------------------------------------

package/lib/cli-engine/index.js

@@ -3,5 +3,5 @@
 const { CLIEngine } = require("./cli-engine");
 
 module.exports = {
-    CLIEngine
+	CLIEngine,
 };