bahlint 28.58.6934

package/lib/rules/strict.js

@@ -0,0 +1,314 @@
+/**
+ * @fileoverview Rule to control usage of strict mode directives.
+ * @author Brandon Mills
+ */
+
+"use strict";
+
+//------------------------------------------------------------------------------
+// Requirements
+//------------------------------------------------------------------------------
+
+const astUtils = require("./utils/ast-utils");
+
+//------------------------------------------------------------------------------
+// Helpers
+//------------------------------------------------------------------------------
+
+/**
+ * Gets all of the Use Strict Directives in the Directive Prologue of a group of
+ * statements.
+ * @param {ASTNode[]} statements Statements in the program or function body.
+ * @returns {ASTNode[]} All of the Use Strict Directives.
+ */
+function getUseStrictDirectives(statements) {
+	const directives = [];
+
+	for (let i = 0; i < statements.length; i++) {
+		const statement = statements[i];
+
+		if (
+			statement.type === "ExpressionStatement" &&
+			statement.expression.type === "Literal" &&
+			statement.expression.value === "use strict"
+		) {
+			directives[i] = statement;
+		} else {
+			break;
+		}
+	}
+
+	return directives;
+}
+
+/**
+ * Checks whether a given parameter is a simple parameter.
+ * @param {ASTNode} node A pattern node to check.
+ * @returns {boolean} `true` if the node is an Identifier node.
+ */
+function isSimpleParameter(node) {
+	return node.type === "Identifier";
+}
+
+/**
+ * Checks whether a given parameter list is a simple parameter list.
+ * @param {ASTNode[]} params A parameter list to check.
+ * @returns {boolean} `true` if the every parameter is an Identifier node.
+ */
+function isSimpleParameterList(params) {
+	return params.every(isSimpleParameter);
+}
+
+//------------------------------------------------------------------------------
+// Rule Definition
+//------------------------------------------------------------------------------
+
+/** @type {import('../types').Rule.RuleModule} */
+module.exports = {
+	meta: {
+		type: "suggestion",
+
+		defaultOptions: ["safe"],
+
+		docs: {
+			description: "Require or disallow strict mode directives",
+			recommended: false,
+			url: "https://eslint.org/docs/latest/rules/strict",
+		},
+
+		schema: [
+			{
+				enum: ["never", "global", "function", "safe"],
+			},
+		],
+
+		fixable: "code",
+		messages: {
+			function: "Use the function form of 'use strict'.",
+			global: "Use the global form of 'use strict'.",
+			multiple: "Multiple 'use strict' directives.",
+			never: "Strict mode is not permitted.",
+			unnecessary: "Unnecessary 'use strict' directive.",
+			module: "'use strict' is unnecessary inside of modules.",
+			implied:
+				"'use strict' is unnecessary when implied strict mode is enabled.",
+			unnecessaryInClasses:
+				"'use strict' is unnecessary inside of classes.",
+			nonSimpleParameterList:
+				"'use strict' directive inside a function with non-simple parameter list throws a syntax error since ES2016.",
+			wrap: "Wrap {{name}} in a function with 'use strict' directive.",
+		},
+	},
+
+	create(context) {
+		const ecmaFeatures =
+				context.languageOptions.parserOptions.ecmaFeatures || {},
+			scopes = [],
+			classScopes = [];
+		let [mode] = context.options;
+
+		if (ecmaFeatures.impliedStrict) {
+			mode = "implied";
+		} else if (mode === "safe") {
+			mode =
+				ecmaFeatures.globalReturn ||
+				context.languageOptions.sourceType === "commonjs"
+					? "global"
+					: "function";
+		}
+
+		/**
+		 * Determines whether a reported error should be fixed, depending on the error type.
+		 * @param {string} errorType The type of error
+		 * @returns {boolean} `true` if the reported error should be fixed
+		 */
+		function shouldFix(errorType) {
+			return (
+				errorType === "multiple" ||
+				errorType === "unnecessary" ||
+				errorType === "module" ||
+				errorType === "implied" ||
+				errorType === "unnecessaryInClasses"
+			);
+		}
+
+		/**
+		 * Gets a fixer function to remove a given 'use strict' directive.
+		 * @param {ASTNode} node The directive that should be removed
+		 * @returns {Function} A fixer function
+		 */
+		function getFixFunction(node) {
+			return fixer => fixer.remove(node);
+		}
+
+		/**
+		 * Report a slice of an array of nodes with a given message.
+		 * @param {ASTNode[]} nodes Nodes.
+		 * @param {string} start Index to start from.
+		 * @param {string} end Index to end before.
+		 * @param {string} messageId Message to display.
+		 * @param {boolean} fix `true` if the directive should be fixed (i.e. removed)
+		 * @returns {void}
+		 */
+		function reportSlice(nodes, start, end, messageId, fix) {
+			nodes.slice(start, end).forEach(node => {
+				context.report({
+					node,
+					messageId,
+					fix: fix ? getFixFunction(node) : null,
+				});
+			});
+		}
+
+		/**
+		 * Report all nodes in an array with a given message.
+		 * @param {ASTNode[]} nodes Nodes.
+		 * @param {string} messageId Message id to display.
+		 * @param {boolean} fix `true` if the directive should be fixed (i.e. removed)
+		 * @returns {void}
+		 */
+		function reportAll(nodes, messageId, fix) {
+			reportSlice(nodes, 0, nodes.length, messageId, fix);
+		}
+
+		/**
+		 * Report all nodes in an array, except the first, with a given message.
+		 * @param {ASTNode[]} nodes Nodes.
+		 * @param {string} messageId Message id to display.
+		 * @param {boolean} fix `true` if the directive should be fixed (i.e. removed)
+		 * @returns {void}
+		 */
+		function reportAllExceptFirst(nodes, messageId, fix) {
+			reportSlice(nodes, 1, nodes.length, messageId, fix);
+		}
+
+		/**
+		 * Entering a function in 'function' mode pushes a new nested scope onto the
+		 * stack. The new scope is true if the nested function is strict mode code.
+		 * @param {ASTNode} node The function declaration or expression.
+		 * @param {ASTNode[]} useStrictDirectives The Use Strict Directives of the node.
+		 * @returns {void}
+		 */
+		function enterFunctionInFunctionMode(node, useStrictDirectives) {
+			const isInClass = classScopes.length > 0,
+				isParentGlobal =
+					scopes.length === 0 && classScopes.length === 0,
+				isParentStrict = scopes.length > 0 && scopes.at(-1),
+				isStrict = useStrictDirectives.length > 0;
+
+			if (isStrict) {
+				if (!isSimpleParameterList(node.params)) {
+					context.report({
+						node: useStrictDirectives[0],
+						messageId: "nonSimpleParameterList",
+					});
+				} else if (isParentStrict) {
+					context.report({
+						node: useStrictDirectives[0],
+						messageId: "unnecessary",
+						fix: getFixFunction(useStrictDirectives[0]),
+					});
+				} else if (isInClass) {
+					context.report({
+						node: useStrictDirectives[0],
+						messageId: "unnecessaryInClasses",
+						fix: getFixFunction(useStrictDirectives[0]),
+					});
+				}
+
+				reportAllExceptFirst(useStrictDirectives, "multiple", true);
+			} else if (isParentGlobal) {
+				if (isSimpleParameterList(node.params)) {
+					context.report({ node, messageId: "function" });
+				} else {
+					context.report({
+						node,
+						messageId: "wrap",
+						data: { name: astUtils.getFunctionNameWithKind(node) },
+					});
+				}
+			}
+
+			scopes.push(isParentStrict || isStrict);
+		}
+
+		/**
+		 * Exiting a function in 'function' mode pops its scope off the stack.
+		 * @returns {void}
+		 */
+		function exitFunctionInFunctionMode() {
+			scopes.pop();
+		}
+
+		/**
+		 * Enter a function and either:
+		 * - Push a new nested scope onto the stack (in 'function' mode).
+		 * - Report all the Use Strict Directives (in the other modes).
+		 * @param {ASTNode} node The function declaration or expression.
+		 * @returns {void}
+		 */
+		function enterFunction(node) {
+			const isBlock = node.body.type === "BlockStatement",
+				useStrictDirectives = isBlock
+					? getUseStrictDirectives(node.body.body)
+					: [];
+
+			if (mode === "function") {
+				enterFunctionInFunctionMode(node, useStrictDirectives);
+			} else if (useStrictDirectives.length > 0) {
+				if (isSimpleParameterList(node.params)) {
+					reportAll(useStrictDirectives, mode, shouldFix(mode));
+				} else {
+					context.report({
+						node: useStrictDirectives[0],
+						messageId: "nonSimpleParameterList",
+					});
+					reportAllExceptFirst(useStrictDirectives, "multiple", true);
+				}
+			}
+		}
+
+		const rule = {
+			Program(node) {
+				const useStrictDirectives = getUseStrictDirectives(node.body);
+
+				if (node.sourceType === "module") {
+					mode = "module";
+				}
+
+				if (mode === "global") {
+					if (
+						node.body.length > 0 &&
+						useStrictDirectives.length === 0
+					) {
+						context.report({ node, messageId: "global" });
+					}
+					reportAllExceptFirst(useStrictDirectives, "multiple", true);
+				} else {
+					reportAll(useStrictDirectives, mode, shouldFix(mode));
+				}
+			},
+			FunctionDeclaration: enterFunction,
+			FunctionExpression: enterFunction,
+			ArrowFunctionExpression: enterFunction,
+		};
+
+		if (mode === "function") {
+			Object.assign(rule, {
+				// Inside of class bodies are always strict mode.
+				ClassBody() {
+					classScopes.push(true);
+				},
+				"ClassBody:exit"() {
+					classScopes.pop();
+				},
+
+				"FunctionDeclaration:exit": exitFunctionInFunctionMode,
+				"FunctionExpression:exit": exitFunctionInFunctionMode,
+				"ArrowFunctionExpression:exit": exitFunctionInFunctionMode,
+			});
+		}
+
+		return rule;
+	},
+};

package/lib/rules/switch-colon-spacing.js

@@ -0,0 +1,158 @@
+/**
+ * @fileoverview Rule to enforce spacing around colons of switch statements.
+ * @author Toru Nagashima
+ * @deprecated in ESLint v8.53.0
+ */
+
+"use strict";
+
+//------------------------------------------------------------------------------
+// Requirements
+//------------------------------------------------------------------------------
+
+const astUtils = require("./utils/ast-utils");
+
+//------------------------------------------------------------------------------
+// Rule Definition
+//------------------------------------------------------------------------------
+
+/** @type {import('../types').Rule.RuleModule} */
+module.exports = {
+	meta: {
+		deprecated: {
+			message: "Formatting rules are being moved out of ESLint core.",
+			url: "https://eslint.org/blog/2023/10/deprecating-formatting-rules/",
+			deprecatedSince: "8.53.0",
+			availableUntil: "11.0.0",
+			replacedBy: [
+				{
+					message:
+						"ESLint Stylistic now maintains deprecated stylistic core rules.",
+					url: "https://eslint.style/guide/migration",
+					plugin: {
+						name: "@stylistic/eslint-plugin",
+						url: "https://eslint.style",
+					},
+					rule: {
+						name: "switch-colon-spacing",
+						url: "https://eslint.style/rules/switch-colon-spacing",
+					},
+				},
+			],
+		},
+		type: "layout",
+
+		docs: {
+			description: "Enforce spacing around colons of switch statements",
+			recommended: false,
+			url: "https://eslint.org/docs/latest/rules/switch-colon-spacing",
+		},
+
+		schema: [
+			{
+				type: "object",
+				properties: {
+					before: { type: "boolean", default: false },
+					after: { type: "boolean", default: true },
+				},
+				additionalProperties: false,
+			},
+		],
+		fixable: "whitespace",
+		messages: {
+			expectedBefore: "Expected space(s) before this colon.",
+			expectedAfter: "Expected space(s) after this colon.",
+			unexpectedBefore: "Unexpected space(s) before this colon.",
+			unexpectedAfter: "Unexpected space(s) after this colon.",
+		},
+	},
+
+	create(context) {
+		const sourceCode = context.sourceCode;
+		const options = context.options[0] || {};
+		const beforeSpacing = options.before === true; // false by default
+		const afterSpacing = options.after !== false; // true by default
+
+		/**
+		 * Check whether the spacing between the given 2 tokens is valid or not.
+		 * @param {Token} left The left token to check.
+		 * @param {Token} right The right token to check.
+		 * @param {boolean} expected The expected spacing to check. `true` if there should be a space.
+		 * @returns {boolean} `true` if the spacing between the tokens is valid.
+		 */
+		function isValidSpacing(left, right, expected) {
+			return (
+				astUtils.isClosingBraceToken(right) ||
+				!astUtils.isTokenOnSameLine(left, right) ||
+				sourceCode.isSpaceBetween(left, right) === expected
+			);
+		}
+
+		/**
+		 * Check whether comments exist between the given 2 tokens.
+		 * @param {Token} left The left token to check.
+		 * @param {Token} right The right token to check.
+		 * @returns {boolean} `true` if comments exist between the given 2 tokens.
+		 */
+		function commentsExistBetween(left, right) {
+			return (
+				sourceCode.getFirstTokenBetween(left, right, {
+					includeComments: true,
+					filter: astUtils.isCommentToken,
+				}) !== null
+			);
+		}
+
+		/**
+		 * Fix the spacing between the given 2 tokens.
+		 * @param {RuleFixer} fixer The fixer to fix.
+		 * @param {Token} left The left token of fix range.
+		 * @param {Token} right The right token of fix range.
+		 * @param {boolean} spacing The spacing style. `true` if there should be a space.
+		 * @returns {Fix|null} The fix object.
+		 */
+		function fix(fixer, left, right, spacing) {
+			if (commentsExistBetween(left, right)) {
+				return null;
+			}
+			if (spacing) {
+				return fixer.insertTextAfter(left, " ");
+			}
+			return fixer.removeRange([left.range[1], right.range[0]]);
+		}
+
+		return {
+			SwitchCase(node) {
+				const colonToken = astUtils.getSwitchCaseColonToken(
+					node,
+					sourceCode,
+				);
+				const beforeToken = sourceCode.getTokenBefore(colonToken);
+				const afterToken = sourceCode.getTokenAfter(colonToken);
+
+				if (!isValidSpacing(beforeToken, colonToken, beforeSpacing)) {
+					context.report({
+						node,
+						loc: colonToken.loc,
+						messageId: beforeSpacing
+							? "expectedBefore"
+							: "unexpectedBefore",
+						fix: fixer =>
+							fix(fixer, beforeToken, colonToken, beforeSpacing),
+					});
+				}
+				if (!isValidSpacing(colonToken, afterToken, afterSpacing)) {
+					context.report({
+						node,
+						loc: colonToken.loc,
+						messageId: afterSpacing
+							? "expectedAfter"
+							: "unexpectedAfter",
+						fix: fixer =>
+							fix(fixer, colonToken, afterToken, afterSpacing),
+					});
+				}
+			},
+		};
+	},
+};

package/lib/rules/symbol-description.js

@@ -0,0 +1,70 @@
+/**
+ * @fileoverview Rule to enforce description with the `Symbol` object
+ * @author Jarek Rencz
+ */
+
+"use strict";
+
+//------------------------------------------------------------------------------
+// Requirements
+//------------------------------------------------------------------------------
+
+const astUtils = require("./utils/ast-utils");
+
+//------------------------------------------------------------------------------
+// Rule Definition
+//------------------------------------------------------------------------------
+
+/** @type {import('../types').Rule.RuleModule} */
+module.exports = {
+	meta: {
+		type: "suggestion",
+
+		docs: {
+			description: "Require symbol descriptions",
+			recommended: false,
+			url: "https://eslint.org/docs/latest/rules/symbol-description",
+		},
+		fixable: null,
+		schema: [],
+		messages: {
+			expected: "Expected Symbol to have a description.",
+		},
+	},
+
+	create(context) {
+		const sourceCode = context.sourceCode;
+
+		/**
+		 * Reports if node does not conform the rule in case rule is set to
+		 * report missing description
+		 * @param {ASTNode} node A CallExpression node to check.
+		 * @returns {void}
+		 */
+		function checkArgument(node) {
+			if (node.arguments.length === 0) {
+				context.report({
+					node,
+					messageId: "expected",
+				});
+			}
+		}
+
+		return {
+			"Program:exit"(node) {
+				const scope = sourceCode.getScope(node);
+				const variable = astUtils.getVariableByName(scope, "Symbol");
+
+				if (variable && variable.defs.length === 0) {
+					variable.references.forEach(reference => {
+						const idNode = reference.identifier;
+
+						if (astUtils.isCallee(idNode)) {
+							checkArgument(idNode.parent);
+						}
+					});
+				}
+			},
+		};
+	},
+};

package/lib/rules/template-curly-spacing.js

@@ -0,0 +1,168 @@
+/**
+ * @fileoverview Rule to enforce spacing around embedded expressions of template strings
+ * @author Toru Nagashima
+ * @deprecated in ESLint v8.53.0
+ */
+
+"use strict";
+
+//------------------------------------------------------------------------------
+// Requirements
+//------------------------------------------------------------------------------
+
+const astUtils = require("./utils/ast-utils");
+
+//------------------------------------------------------------------------------
+// Rule Definition
+//------------------------------------------------------------------------------
+
+/** @type {import('../types').Rule.RuleModule} */
+module.exports = {
+	meta: {
+		deprecated: {
+			message: "Formatting rules are being moved out of ESLint core.",
+			url: "https://eslint.org/blog/2023/10/deprecating-formatting-rules/",
+			deprecatedSince: "8.53.0",
+			availableUntil: "11.0.0",
+			replacedBy: [
+				{
+					message:
+						"ESLint Stylistic now maintains deprecated stylistic core rules.",
+					url: "https://eslint.style/guide/migration",
+					plugin: {
+						name: "@stylistic/eslint-plugin",
+						url: "https://eslint.style",
+					},
+					rule: {
+						name: "template-curly-spacing",
+						url: "https://eslint.style/rules/template-curly-spacing",
+					},
+				},
+			],
+		},
+		type: "layout",
+
+		docs: {
+			description:
+				"Require or disallow spacing around embedded expressions of template strings",
+			recommended: false,
+			url: "https://eslint.org/docs/latest/rules/template-curly-spacing",
+		},
+
+		fixable: "whitespace",
+
+		schema: [{ enum: ["always", "never"] }],
+		messages: {
+			expectedBefore: "Expected space(s) before '}'.",
+			expectedAfter: "Expected space(s) after '${'.",
+			unexpectedBefore: "Unexpected space(s) before '}'.",
+			unexpectedAfter: "Unexpected space(s) after '${'.",
+		},
+	},
+
+	create(context) {
+		const sourceCode = context.sourceCode;
+		const always = context.options[0] === "always";
+
+		/**
+		 * Checks spacing before `}` of a given token.
+		 * @param {Token} token A token to check. This is a Template token.
+		 * @returns {void}
+		 */
+		function checkSpacingBefore(token) {
+			if (!token.value.startsWith("}")) {
+				return; // starts with a backtick, this is the first template element in the template literal
+			}
+
+			const prevToken = sourceCode.getTokenBefore(token, {
+					includeComments: true,
+				}),
+				hasSpace = sourceCode.isSpaceBetween(prevToken, token);
+
+			if (!astUtils.isTokenOnSameLine(prevToken, token)) {
+				return;
+			}
+
+			if (always && !hasSpace) {
+				context.report({
+					loc: {
+						start: token.loc.start,
+						end: {
+							line: token.loc.start.line,
+							column: token.loc.start.column + 1,
+						},
+					},
+					messageId: "expectedBefore",
+					fix: fixer => fixer.insertTextBefore(token, " "),
+				});
+			}
+
+			if (!always && hasSpace) {
+				context.report({
+					loc: {
+						start: prevToken.loc.end,
+						end: token.loc.start,
+					},
+					messageId: "unexpectedBefore",
+					fix: fixer =>
+						fixer.removeRange([prevToken.range[1], token.range[0]]),
+				});
+			}
+		}
+
+		/**
+		 * Checks spacing after `${` of a given token.
+		 * @param {Token} token A token to check. This is a Template token.
+		 * @returns {void}
+		 */
+		function checkSpacingAfter(token) {
+			if (!token.value.endsWith("${")) {
+				return; // ends with a backtick, this is the last template element in the template literal
+			}
+
+			const nextToken = sourceCode.getTokenAfter(token, {
+					includeComments: true,
+				}),
+				hasSpace = sourceCode.isSpaceBetween(token, nextToken);
+
+			if (!astUtils.isTokenOnSameLine(token, nextToken)) {
+				return;
+			}
+
+			if (always && !hasSpace) {
+				context.report({
+					loc: {
+						start: {
+							line: token.loc.end.line,
+							column: token.loc.end.column - 2,
+						},
+						end: token.loc.end,
+					},
+					messageId: "expectedAfter",
+					fix: fixer => fixer.insertTextAfter(token, " "),
+				});
+			}
+
+			if (!always && hasSpace) {
+				context.report({
+					loc: {
+						start: token.loc.end,
+						end: nextToken.loc.start,
+					},
+					messageId: "unexpectedAfter",
+					fix: fixer =>
+						fixer.removeRange([token.range[1], nextToken.range[0]]),
+				});
+			}
+		}
+
+		return {
+			TemplateElement(node) {
+				const token = sourceCode.getFirstToken(node);
+
+				checkSpacingBefore(token);
+				checkSpacingAfter(token);
+			},
+		};
+	},
+};