bahlint 28.58.6934

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

@@ -0,0 +1,81 @@
+/**
+ * @fileoverview SourceCodeVisitor class
+ * @author Nicholas C. Zakas
+ */
+
+"use strict";
+
+//-----------------------------------------------------------------------------
+// Helpers
+//-----------------------------------------------------------------------------
+
+const emptyArray = Object.freeze([]);
+
+//------------------------------------------------------------------------------
+// Exports
+//------------------------------------------------------------------------------
+
+/**
+ * A structure to hold a list of functions to call for a given name.
+ * This is used to allow multiple rules to register functions for a given name
+ * without having to know about each other.
+ */
+class SourceCodeVisitor {
+	/**
+	 * The functions to call for a given name.
+	 * @type {Map<string, Function[]>}
+	 */
+	#functions = new Map();
+
+	/**
+	 * Adds a function to the list of functions to call for a given name.
+	 * @param {string} name The name of the function to call.
+	 * @param {Function} func The function to call.
+	 * @returns {void}
+	 */
+	add(name, func) {
+		if (this.#functions.has(name)) {
+			this.#functions.get(name).push(func);
+		} else {
+			this.#functions.set(name, [func]);
+		}
+	}
+
+	/**
+	 * Gets the list of functions to call for a given name.
+	 * @param {string} name The name of the function to call.
+	 * @returns {Function[]} The list of functions to call.
+	 */
+	get(name) {
+		if (this.#functions.has(name)) {
+			return this.#functions.get(name);
+		}
+
+		return emptyArray;
+	}
+
+	/**
+	 * Iterates over all names and calls the callback with the name.
+	 * @param {(name:string) => void} callback The callback to call for each name.
+	 * @returns {void}
+	 */
+	forEachName(callback) {
+		this.#functions.forEach((funcs, name) => {
+			callback(name);
+		});
+	}
+
+	/**
+	 * Calls the functions for a given name with the given arguments.
+	 * @param {string} name The name of the function to call.
+	 * @param {any[]} args The arguments to pass to the function.
+	 * @returns {void}
+	 */
+	callSync(name, ...args) {
+		if (this.#functions.has(name)) {
+			this.#functions.get(name).forEach(func => func(...args));
+		}
+	}
+}
+
+module.exports = { SourceCodeVisitor };

package/lib/linter/timing.js

@@ -0,0 +1,209 @@
+/**
+ * @fileoverview Tracks performance of individual rules.
+ * @author Brandon Mills
+ */
+
+"use strict";
+
+const { startTime, endTime } = require("../shared/stats");
+
+//------------------------------------------------------------------------------
+// Helpers
+//------------------------------------------------------------------------------
+
+/* c8 ignore next */
+/**
+ * Align the string to left
+ * @param {string} str string to evaluate
+ * @param {number} len length of the string
+ * @param {string} ch delimiter character
+ * @returns {string} modified string
+ * @private
+ */
+function alignLeft(str, len, ch) {
+	return str + new Array(len - str.length + 1).join(ch || " ");
+}
+
+/* c8 ignore next */
+/**
+ * Align the string to right
+ * @param {string} str string to evaluate
+ * @param {number} len length of the string
+ * @param {string} ch delimiter character
+ * @returns {string} modified string
+ * @private
+ */
+function alignRight(str, len, ch) {
+	return new Array(len - str.length + 1).join(ch || " ") + str;
+}
+
+//------------------------------------------------------------------------------
+// Module definition
+//------------------------------------------------------------------------------
+
+const enabled = !!process.env.TIMING;
+
+const HEADERS = ["Rule", "Time (ms)", "Relative"];
+const ALIGN = [alignLeft, alignRight, alignRight];
+
+/**
+ * Decide how many rules to show in the output list.
+ * @returns {number} the number of rules to show
+ */
+function getListSize() {
+	const MINIMUM_SIZE = 10;
+
+	if (typeof process.env.TIMING !== "string") {
+		return MINIMUM_SIZE;
+	}
+
+	if (process.env.TIMING.toLowerCase() === "all") {
+		return Number.POSITIVE_INFINITY;
+	}
+
+	const TIMING_ENV_VAR_AS_INTEGER = Number.parseInt(process.env.TIMING, 10);
+
+	return TIMING_ENV_VAR_AS_INTEGER > 10
+		? TIMING_ENV_VAR_AS_INTEGER
+		: MINIMUM_SIZE;
+}
+
+/* c8 ignore next */
+/**
+ * display the data
+ * @param {Object} data Data object to be displayed
+ * @returns {void} prints modified string with console.log
+ * @private
+ */
+function display(data) {
+	let total = 0;
+	const rows = Object.keys(data)
+		.map(key => {
+			const time = data[key];
+
+			total += time;
+			return [key, time];
+		})
+		.sort((a, b) => b[1] - a[1])
+		.slice(0, getListSize());
+
+	rows.forEach(row => {
+		row.push(`${((row[1] * 100) / total).toFixed(1)}%`);
+		row[1] = row[1].toFixed(3);
+	});
+
+	rows.unshift(HEADERS);
+
+	const widths = [];
+
+	rows.forEach(row => {
+		const len = row.length;
+
+		for (let i = 0; i < len; i++) {
+			const n = row[i].length;
+
+			if (!widths[i] || n > widths[i]) {
+				widths[i] = n;
+			}
+		}
+	});
+
+	const table = rows.map(row =>
+		row.map((cell, index) => ALIGN[index](cell, widths[index])).join(" | "),
+	);
+
+	table.splice(
+		1,
+		0,
+		widths
+			.map((width, index) => {
+				const extraAlignment =
+					index !== 0 && index !== widths.length - 1 ? 2 : 1;
+
+				return ALIGN[index](":", width + extraAlignment, "-");
+			})
+			.join("|"),
+	);
+
+	console.log(table.join("\n")); // eslint-disable-line no-console -- Debugging function
+}
+
+/* c8 ignore next */
+module.exports = (function () {
+	const data = Object.create(null);
+	let displayEnabled = true;
+
+	/**
+	 * Time the run
+	 * @param {any} key key from the data object
+	 * @param {Function} fn function to be called
+	 * @param {boolean} stats if 'stats' is true, return the result and the time difference
+	 * @returns {Function} function to be executed
+	 * @private
+	 */
+	function time(key, fn, stats) {
+		return function (...args) {
+			const t = startTime();
+			const result = fn(...args);
+			const tdiff = endTime(t);
+
+			if (enabled) {
+				if (typeof data[key] === "undefined") {
+					data[key] = 0;
+				}
+
+				data[key] += tdiff;
+			}
+
+			return stats ? { result, tdiff } : result;
+		};
+	}
+
+	/**
+	 * Returns a shallow copy of the collected timings data.
+	 * @returns {Record<string, number>} mapping of ruleId to total time in ms
+	 */
+	function getData() {
+		return { ...data };
+	}
+
+	/**
+	 * Merges rule timing totals collected elsewhere into this process' totals.
+	 * @param {Record<string, number>} dataToMerge mapping of ruleId to total time in ms
+	 * @returns {void}
+	 */
+	function mergeData(dataToMerge) {
+		for (const [key, value] of Object.entries(dataToMerge)) {
+			if (typeof data[key] === "undefined") {
+				data[key] = 0;
+			}
+			data[key] += value;
+		}
+	}
+
+	/**
+	 * Disables printing of timing data on process exit.
+	 * Intended for worker threads or non-main contexts.
+	 * @returns {void}
+	 */
+	function disableDisplay() {
+		displayEnabled = false;
+	}
+
+	if (enabled) {
+		process.on("exit", () => {
+			if (displayEnabled && Object.keys(data).length > 0) {
+				display(data);
+			}
+		});
+	}
+
+	return {
+		time,
+		enabled,
+		getListSize,
+		getData,
+		mergeData,
+		disableDisplay,
+	};
+})();

package/lib/linter/vfile.js

@@ -0,0 +1,115 @@
+/**
+ * @fileoverview Virtual file
+ * @author Nicholas C. Zakas
+ */
+
+"use strict";
+
+//-----------------------------------------------------------------------------
+// Type Definitions
+//-----------------------------------------------------------------------------
+
+/** @typedef {import("@eslint/core").File} File */
+
+//------------------------------------------------------------------------------
+// Helpers
+//------------------------------------------------------------------------------
+
+/**
+ * Determines if a given value has a byte order mark (BOM).
+ * @param {string|Uint8Array} value The value to check.
+ * @returns {boolean} `true` if the value has a BOM, `false` otherwise.
+ */
+function hasUnicodeBOM(value) {
+	return typeof value === "string"
+		? value.charCodeAt(0) === 0xfeff
+		: value[0] === 0xef && value[1] === 0xbb && value[2] === 0xbf;
+}
+
+/**
+ * Strips Unicode BOM from the given value.
+ * @param {string|Uint8Array} value The value to remove the BOM from.
+ * @returns {string|Uint8Array} The stripped value.
+ */
+function stripUnicodeBOM(value) {
+	if (!hasUnicodeBOM(value)) {
+		return value;
+	}
+
+	if (typeof value === "string") {
+		/*
+		 * Check Unicode BOM.
+		 * In JavaScript, string data is stored as UTF-16, so BOM is 0xFEFF.
+		 * http://www.ecma-international.org/ecma-262/6.0/#sec-unicode-format-control-characters
+		 */
+		return value.slice(1);
+	}
+
+	/*
+	 * In a Uint8Array, the BOM is represented by three bytes: 0xEF, 0xBB, and 0xBF,
+	 * so we can just remove the first three bytes.
+	 */
+	return value.slice(3);
+}
+
+//------------------------------------------------------------------------------
+// Exports
+//------------------------------------------------------------------------------
+
+/**
+ * Represents a virtual file inside of ESLint.
+ * @implements {File}
+ */
+class VFile {
+	/**
+	 * The file path including any processor-created virtual path.
+	 * @type {string}
+	 * @readonly
+	 */
+	path;
+
+	/**
+	 * The file path on disk.
+	 * @type {string}
+	 * @readonly
+	 */
+	physicalPath;
+
+	/**
+	 * The file contents.
+	 * @type {string|Uint8Array}
+	 * @readonly
+	 */
+	body;
+
+	/**
+	 * The raw body of the file, including a BOM if present.
+	 * @type {string|Uint8Array}
+	 * @readonly
+	 */
+	rawBody;
+
+	/**
+	 * Indicates whether the file has a byte order mark (BOM).
+	 * @type {boolean}
+	 * @readonly
+	 */
+	bom;
+
+	/**
+	 * Creates a new instance.
+	 * @param {string} path The file path.
+	 * @param {string|Uint8Array} body The file contents.
+	 * @param {Object} [options] Additional options.
+	 * @param {string} [options.physicalPath] The file path on disk.
+	 */
+	constructor(path, body, { physicalPath } = {}) {
+		this.path = path;
+		this.physicalPath = physicalPath ?? path;
+		this.bom = hasUnicodeBOM(body);
+		this.body = stripUnicodeBOM(body);
+		this.rawBody = body;
+	}
+}
+
+module.exports = { VFile };