eslint 8.57.1 → 9.39.1

package/lib/{source-code → languages/js/source-code}/token-store/limit-cursor.js

@@ -18,23 +18,22 @@ const DecorativeCursor = require("./decorative-cursor");
  * The decorative cursor which limits the number of tokens.
  */
 module.exports = class LimitCursor extends DecorativeCursor {
+	/**
+	 * Initializes this cursor.
+	 * @param {Cursor} cursor The cursor to be decorated.
+	 * @param {number} count The count of tokens this cursor iterates.
+	 */
+	constructor(cursor, count) {
+		super(cursor);
+		this.count = count;
+	}
 
-    /**
-     * Initializes this cursor.
-     * @param {Cursor} cursor The cursor to be decorated.
-     * @param {number} count The count of tokens this cursor iterates.
-     */
-    constructor(cursor, count) {
-        super(cursor);
-        this.count = count;
-    }
-
-    /** @inheritdoc */
-    moveNext() {
-        if (this.count > 0) {
-            this.count -= 1;
-            return super.moveNext();
-        }
-        return false;
-    }
+	/** @inheritdoc */
+	moveNext() {
+		if (this.count > 0) {
+			this.count -= 1;
+			return super.moveNext();
+		}
+		return false;
+	}
 };

package/lib/languages/js/source-code/token-store/padded-token-cursor.js

@@ -0,0 +1,45 @@
+/**
+ * @fileoverview Define the cursor which iterates tokens only, with inflated range.
+ * @author Toru Nagashima
+ */
+"use strict";
+
+//------------------------------------------------------------------------------
+// Requirements
+//------------------------------------------------------------------------------
+
+const ForwardTokenCursor = require("./forward-token-cursor");
+
+//------------------------------------------------------------------------------
+// Exports
+//------------------------------------------------------------------------------
+
+/**
+ * The cursor which iterates tokens only, with inflated range.
+ * This is for the backward compatibility of padding options.
+ */
+module.exports = class PaddedTokenCursor extends ForwardTokenCursor {
+	/**
+	 * Initializes this cursor.
+	 * @param {Token[]} tokens The array of tokens.
+	 * @param {Comment[]} comments The array of comments.
+	 * @param {Object} indexMap The map from locations to indices in `tokens`.
+	 * @param {number} startLoc The start location of the iteration range.
+	 * @param {number} endLoc The end location of the iteration range.
+	 * @param {number} beforeCount The number of tokens this cursor iterates before start.
+	 * @param {number} afterCount The number of tokens this cursor iterates after end.
+	 */
+	constructor(
+		tokens,
+		comments,
+		indexMap,
+		startLoc,
+		endLoc,
+		beforeCount,
+		afterCount,
+	) {
+		super(tokens, comments, indexMap, startLoc, endLoc);
+		this.index = Math.max(0, this.index - beforeCount);
+		this.indexEnd = Math.min(tokens.length - 1, this.indexEnd + afterCount);
+	}
+};

package/lib/{source-code → languages/js/source-code}/token-store/skip-cursor.js

@@ -18,25 +18,24 @@ const DecorativeCursor = require("./decorative-cursor");
  * The decorative cursor which ignores the first few tokens.
  */
 module.exports = class SkipCursor extends DecorativeCursor {
+	/**
+	 * Initializes this cursor.
+	 * @param {Cursor} cursor The cursor to be decorated.
+	 * @param {number} count The count of tokens this cursor skips.
+	 */
+	constructor(cursor, count) {
+		super(cursor);
+		this.count = count;
+	}
 
-    /**
-     * Initializes this cursor.
-     * @param {Cursor} cursor The cursor to be decorated.
-     * @param {number} count The count of tokens this cursor skips.
-     */
-    constructor(cursor, count) {
-        super(cursor);
-        this.count = count;
-    }
-
-    /** @inheritdoc */
-    moveNext() {
-        while (this.count > 0) {
-            this.count -= 1;
-            if (!super.moveNext()) {
-                return false;
-            }
-        }
-        return super.moveNext();
-    }
+	/** @inheritdoc */
+	moveNext() {
+		while (this.count > 0) {
+			this.count -= 1;
+			if (!super.moveNext()) {
+				return false;
+			}
+		}
+		return super.moveNext();
+	}
 };

package/lib/languages/js/source-code/token-store/utils.js

@@ -0,0 +1,110 @@
+/**
+ * @fileoverview Define utility functions for token store.
+ * @author Toru Nagashima
+ */
+"use strict";
+
+//------------------------------------------------------------------------------
+// Exports
+//------------------------------------------------------------------------------
+
+/**
+ * Finds the index of the first token which is after the given location.
+ * If it was not found, this returns `tokens.length`.
+ * @param {(Token|Comment)[]} tokens It searches the token in this list.
+ * @param {number} location The location to search.
+ * @returns {number} The found index or `tokens.length`.
+ */
+exports.search = function search(tokens, location) {
+	for (
+		let minIndex = 0, maxIndex = tokens.length - 1;
+		minIndex <= maxIndex;
+
+	) {
+		/*
+		 * Calculate the index in the middle between minIndex and maxIndex.
+		 * `| 0` is used to round a fractional value down to the nearest integer: this is similar to
+		 * using `Math.trunc()` or `Math.floor()`, but performance tests have shown this method to
+		 * be faster.
+		 */
+		const index = ((minIndex + maxIndex) / 2) | 0;
+		const token = tokens[index];
+		const tokenStartLocation = token.range[0];
+
+		if (location <= tokenStartLocation) {
+			if (index === minIndex) {
+				return index;
+			}
+			maxIndex = index;
+		} else {
+			minIndex = index + 1;
+		}
+	}
+	return tokens.length;
+};
+
+/**
+ * Gets the index of the `startLoc` in `tokens`.
+ * `startLoc` can be the value of `node.range[1]`, so this checks about `startLoc - 1` as well.
+ * @param {(Token|Comment)[]} tokens The tokens to find an index.
+ * @param {Object} indexMap The map from locations to indices.
+ * @param {number} startLoc The location to get an index.
+ * @returns {number} The index.
+ */
+exports.getFirstIndex = function getFirstIndex(tokens, indexMap, startLoc) {
+	if (startLoc in indexMap) {
+		return indexMap[startLoc];
+	}
+	if (startLoc - 1 in indexMap) {
+		const index = indexMap[startLoc - 1];
+		const token = tokens[index];
+
+		// If the mapped index is out of bounds, the returned cursor index will point after the end of the tokens array.
+		if (!token) {
+			return tokens.length;
+		}
+
+		/*
+		 * For the map of "comment's location -> token's index", it points the next token of a comment.
+		 * In that case, +1 is unnecessary.
+		 */
+		if (token.range[0] >= startLoc) {
+			return index;
+		}
+		return index + 1;
+	}
+	return 0;
+};
+
+/**
+ * Gets the index of the `endLoc` in `tokens`.
+ * The information of end locations are recorded at `endLoc - 1` in `indexMap`, so this checks about `endLoc - 1` as well.
+ * @param {(Token|Comment)[]} tokens The tokens to find an index.
+ * @param {Object} indexMap The map from locations to indices.
+ * @param {number} endLoc The location to get an index.
+ * @returns {number} The index.
+ */
+exports.getLastIndex = function getLastIndex(tokens, indexMap, endLoc) {
+	if (endLoc in indexMap) {
+		return indexMap[endLoc] - 1;
+	}
+	if (endLoc - 1 in indexMap) {
+		const index = indexMap[endLoc - 1];
+		const token = tokens[index];
+
+		// If the mapped index is out of bounds, the returned cursor index will point before the end of the tokens array.
+		if (!token) {
+			return tokens.length - 1;
+		}
+
+		/*
+		 * For the map of "comment's location -> token's index", it points the next token of a comment.
+		 * In that case, -1 is necessary.
+		 */
+		if (token.range[1] > endLoc) {
+			return index - 1;
+		}
+		return index;
+	}
+	return tokens.length - 1;
+};

package/lib/languages/js/validate-language-options.js

@@ -0,0 +1,196 @@
+/**
+ * @fileoverview The schema to validate language options
+ * @author Nicholas C. Zakas
+ */
+
+"use strict";
+
+//-----------------------------------------------------------------------------
+// Data
+//-----------------------------------------------------------------------------
+
+const globalVariablesValues = new Set([
+	true,
+	"true",
+	"writable",
+	"writeable",
+	false,
+	"false",
+	"readonly",
+	"readable",
+	null,
+	"off",
+]);
+
+//------------------------------------------------------------------------------
+// Helpers
+//------------------------------------------------------------------------------
+
+/**
+ * Check if a value is a non-null object.
+ * @param {any} value The value to check.
+ * @returns {boolean} `true` if the value is a non-null object.
+ */
+function isNonNullObject(value) {
+	return typeof value === "object" && value !== null;
+}
+
+/**
+ * Check if a value is a non-null non-array object.
+ * @param {any} value The value to check.
+ * @returns {boolean} `true` if the value is a non-null non-array object.
+ */
+function isNonArrayObject(value) {
+	return isNonNullObject(value) && !Array.isArray(value);
+}
+
+/**
+ * Check if a value is undefined.
+ * @param {any} value The value to check.
+ * @returns {boolean} `true` if the value is undefined.
+ */
+function isUndefined(value) {
+	return typeof value === "undefined";
+}
+
+//-----------------------------------------------------------------------------
+// Schemas
+//-----------------------------------------------------------------------------
+
+/**
+ * Validates the ecmaVersion property.
+ * @param {string|number} ecmaVersion The value to check.
+ * @returns {void}
+ * @throws {TypeError} If the value is invalid.
+ */
+function validateEcmaVersion(ecmaVersion) {
+	if (isUndefined(ecmaVersion)) {
+		throw new TypeError(
+			'Key "ecmaVersion": Expected an "ecmaVersion" property.',
+		);
+	}
+
+	if (typeof ecmaVersion !== "number" && ecmaVersion !== "latest") {
+		throw new TypeError(
+			'Key "ecmaVersion": Expected a number or "latest".',
+		);
+	}
+}
+
+/**
+ * Validates the sourceType property.
+ * @param {string} sourceType The value to check.
+ * @returns {void}
+ * @throws {TypeError} If the value is invalid.
+ */
+function validateSourceType(sourceType) {
+	if (
+		typeof sourceType !== "string" ||
+		!/^(?:script|module|commonjs)$/u.test(sourceType)
+	) {
+		throw new TypeError(
+			'Key "sourceType": Expected "script", "module", or "commonjs".',
+		);
+	}
+}
+
+/**
+ * Validates the globals property.
+ * @param {Object} globals The value to check.
+ * @returns {void}
+ * @throws {TypeError} If the value is invalid.
+ */
+function validateGlobals(globals) {
+	if (!isNonArrayObject(globals)) {
+		throw new TypeError('Key "globals": Expected an object.');
+	}
+
+	for (const key of Object.keys(globals)) {
+		// avoid hairy edge case
+		if (key === "__proto__") {
+			continue;
+		}
+
+		if (key !== key.trim()) {
+			throw new TypeError(
+				`Key "globals": Global "${key}" has leading or trailing whitespace.`,
+			);
+		}
+
+		if (!globalVariablesValues.has(globals[key])) {
+			throw new TypeError(
+				`Key "globals": Key "${key}": Expected "readonly", "writable", or "off".`,
+			);
+		}
+	}
+}
+
+/**
+ * Validates the parser property.
+ * @param {Object} parser The value to check.
+ * @returns {void}
+ * @throws {TypeError} If the value is invalid.
+ */
+function validateParser(parser) {
+	if (
+		!parser ||
+		typeof parser !== "object" ||
+		(typeof parser.parse !== "function" &&
+			typeof parser.parseForESLint !== "function")
+	) {
+		throw new TypeError(
+			'Key "parser": Expected object with parse() or parseForESLint() method.',
+		);
+	}
+}
+
+/**
+ * Validates the language options.
+ * @param {Object} languageOptions The language options to validate.
+ * @returns {void}
+ * @throws {TypeError} If the language options are invalid.
+ */
+function validateLanguageOptions(languageOptions) {
+	if (!isNonArrayObject(languageOptions)) {
+		throw new TypeError("Expected an object.");
+	}
+
+	const {
+		ecmaVersion,
+		sourceType,
+		globals,
+		parser,
+		parserOptions,
+		...otherOptions
+	} = languageOptions;
+
+	if ("ecmaVersion" in languageOptions) {
+		validateEcmaVersion(ecmaVersion);
+	}
+
+	if ("sourceType" in languageOptions) {
+		validateSourceType(sourceType);
+	}
+
+	if ("globals" in languageOptions) {
+		validateGlobals(globals);
+	}
+
+	if ("parser" in languageOptions) {
+		validateParser(parser);
+	}
+
+	if ("parserOptions" in languageOptions) {
+		if (!isNonArrayObject(parserOptions)) {
+			throw new TypeError('Key "parserOptions": Expected an object.');
+		}
+	}
+
+	const otherOptionKeys = Object.keys(otherOptions);
+
+	if (otherOptionKeys.length > 0) {
+		throw new TypeError(`Unexpected key "${otherOptionKeys[0]}" found.`);
+	}
+}
+
+module.exports = { validateLanguageOptions };