bahlint 28.58.6934

package/lib/rules/semi-spacing.js

@@ -0,0 +1,297 @@
+/**
+ * @fileoverview Validates spacing before and after semicolon
+ * @author Mathias Schreck
+ * @deprecated in ESLint v8.53.0
+ */
+
+"use strict";
+
+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: "semi-spacing",
+						url: "https://eslint.style/rules/semi-spacing",
+					},
+				},
+			],
+		},
+		type: "layout",
+
+		docs: {
+			description:
+				"Enforce consistent spacing before and after semicolons",
+			recommended: false,
+			url: "https://eslint.org/docs/latest/rules/semi-spacing",
+		},
+
+		fixable: "whitespace",
+
+		schema: [
+			{
+				type: "object",
+				properties: {
+					before: {
+						type: "boolean",
+						default: false,
+					},
+					after: {
+						type: "boolean",
+						default: true,
+					},
+				},
+				additionalProperties: false,
+			},
+		],
+
+		messages: {
+			unexpectedWhitespaceBefore:
+				"Unexpected whitespace before semicolon.",
+			unexpectedWhitespaceAfter: "Unexpected whitespace after semicolon.",
+			missingWhitespaceBefore: "Missing whitespace before semicolon.",
+			missingWhitespaceAfter: "Missing whitespace after semicolon.",
+		},
+	},
+
+	create(context) {
+		const config = context.options[0],
+			sourceCode = context.sourceCode;
+		let requireSpaceBefore = false,
+			requireSpaceAfter = true;
+
+		if (typeof config === "object") {
+			requireSpaceBefore = config.before;
+			requireSpaceAfter = config.after;
+		}
+
+		/**
+		 * Checks if a given token has leading whitespace.
+		 * @param {Object} token The token to check.
+		 * @returns {boolean} True if the given token has leading space, false if not.
+		 */
+		function hasLeadingSpace(token) {
+			const tokenBefore = sourceCode.getTokenBefore(token);
+
+			return (
+				tokenBefore &&
+				astUtils.isTokenOnSameLine(tokenBefore, token) &&
+				sourceCode.isSpaceBetween(tokenBefore, token)
+			);
+		}
+
+		/**
+		 * Checks if a given token has trailing whitespace.
+		 * @param {Object} token The token to check.
+		 * @returns {boolean} True if the given token has trailing space, false if not.
+		 */
+		function hasTrailingSpace(token) {
+			const tokenAfter = sourceCode.getTokenAfter(token);
+
+			return (
+				tokenAfter &&
+				astUtils.isTokenOnSameLine(token, tokenAfter) &&
+				sourceCode.isSpaceBetween(token, tokenAfter)
+			);
+		}
+
+		/**
+		 * Checks if the given token is the last token in its line.
+		 * @param {Token} token The token to check.
+		 * @returns {boolean} Whether or not the token is the last in its line.
+		 */
+		function isLastTokenInCurrentLine(token) {
+			const tokenAfter = sourceCode.getTokenAfter(token);
+
+			return !(
+				tokenAfter && astUtils.isTokenOnSameLine(token, tokenAfter)
+			);
+		}
+
+		/**
+		 * Checks if the given token is the first token in its line
+		 * @param {Token} token The token to check.
+		 * @returns {boolean} Whether or not the token is the first in its line.
+		 */
+		function isFirstTokenInCurrentLine(token) {
+			const tokenBefore = sourceCode.getTokenBefore(token);
+
+			return !(
+				tokenBefore && astUtils.isTokenOnSameLine(token, tokenBefore)
+			);
+		}
+
+		/**
+		 * Checks if the next token of a given token is a closing parenthesis.
+		 * @param {Token} token The token to check.
+		 * @returns {boolean} Whether or not the next token of a given token is a closing parenthesis.
+		 */
+		function isBeforeClosingParen(token) {
+			const nextToken = sourceCode.getTokenAfter(token);
+
+			return (
+				(nextToken && astUtils.isClosingBraceToken(nextToken)) ||
+				astUtils.isClosingParenToken(nextToken)
+			);
+		}
+
+		/**
+		 * Report location example :
+		 *
+		 * for unexpected space `before`
+		 *
+		 * var a = 'b'   ;
+		 *            ^^^
+		 *
+		 * for unexpected space `after`
+		 *
+		 * var a = 'b';  c = 10;
+		 *             ^^
+		 *
+		 * Reports if the given token has invalid spacing.
+		 * @param {Token} token The semicolon token to check.
+		 * @param {ASTNode} node The corresponding node of the token.
+		 * @returns {void}
+		 */
+		function checkSemicolonSpacing(token, node) {
+			if (astUtils.isSemicolonToken(token)) {
+				if (hasLeadingSpace(token)) {
+					if (!requireSpaceBefore) {
+						const tokenBefore = sourceCode.getTokenBefore(token);
+						const loc = {
+							start: tokenBefore.loc.end,
+							end: token.loc.start,
+						};
+
+						context.report({
+							node,
+							loc,
+							messageId: "unexpectedWhitespaceBefore",
+							fix(fixer) {
+								return fixer.removeRange([
+									tokenBefore.range[1],
+									token.range[0],
+								]);
+							},
+						});
+					}
+				} else {
+					if (requireSpaceBefore) {
+						const loc = token.loc;
+
+						context.report({
+							node,
+							loc,
+							messageId: "missingWhitespaceBefore",
+							fix(fixer) {
+								return fixer.insertTextBefore(token, " ");
+							},
+						});
+					}
+				}
+
+				if (
+					!isFirstTokenInCurrentLine(token) &&
+					!isLastTokenInCurrentLine(token) &&
+					!isBeforeClosingParen(token)
+				) {
+					if (hasTrailingSpace(token)) {
+						if (!requireSpaceAfter) {
+							const tokenAfter = sourceCode.getTokenAfter(token);
+							const loc = {
+								start: token.loc.end,
+								end: tokenAfter.loc.start,
+							};
+
+							context.report({
+								node,
+								loc,
+								messageId: "unexpectedWhitespaceAfter",
+								fix(fixer) {
+									return fixer.removeRange([
+										token.range[1],
+										tokenAfter.range[0],
+									]);
+								},
+							});
+						}
+					} else {
+						if (requireSpaceAfter) {
+							const loc = token.loc;
+
+							context.report({
+								node,
+								loc,
+								messageId: "missingWhitespaceAfter",
+								fix(fixer) {
+									return fixer.insertTextAfter(token, " ");
+								},
+							});
+						}
+					}
+				}
+			}
+		}
+
+		/**
+		 * Checks the spacing of the semicolon with the assumption that the last token is the semicolon.
+		 * @param {ASTNode} node The node to check.
+		 * @returns {void}
+		 */
+		function checkNode(node) {
+			const token = sourceCode.getLastToken(node);
+
+			checkSemicolonSpacing(token, node);
+		}
+
+		return {
+			VariableDeclaration: checkNode,
+			ExpressionStatement: checkNode,
+			BreakStatement: checkNode,
+			ContinueStatement: checkNode,
+			DebuggerStatement: checkNode,
+			DoWhileStatement: checkNode,
+			ReturnStatement: checkNode,
+			ThrowStatement: checkNode,
+			ImportDeclaration: checkNode,
+			ExportNamedDeclaration: checkNode,
+			ExportAllDeclaration: checkNode,
+			ExportDefaultDeclaration: checkNode,
+			ForStatement(node) {
+				if (node.init) {
+					checkSemicolonSpacing(
+						sourceCode.getTokenAfter(node.init),
+						node,
+					);
+				}
+
+				if (node.test) {
+					checkSemicolonSpacing(
+						sourceCode.getTokenAfter(node.test),
+						node,
+					);
+				}
+			},
+			PropertyDefinition: checkNode,
+		};
+	},
+};

package/lib/rules/semi-style.js

@@ -0,0 +1,218 @@
+/**
+ * @fileoverview Rule to enforce location of semicolons.
+ * @author Toru Nagashima
+ * @deprecated in ESLint v8.53.0
+ */
+
+"use strict";
+
+//------------------------------------------------------------------------------
+// Requirements
+//------------------------------------------------------------------------------
+
+const astUtils = require("./utils/ast-utils");
+
+//------------------------------------------------------------------------------
+// Rule Definition
+//------------------------------------------------------------------------------
+
+const SELECTOR = [
+	"BreakStatement",
+	"ContinueStatement",
+	"DebuggerStatement",
+	"DoWhileStatement",
+	"ExportAllDeclaration",
+	"ExportDefaultDeclaration",
+	"ExportNamedDeclaration",
+	"ExpressionStatement",
+	"ImportDeclaration",
+	"ReturnStatement",
+	"ThrowStatement",
+	"VariableDeclaration",
+	"PropertyDefinition",
+].join(",");
+
+/**
+ * Get the child node list of a given node.
+ * This returns `BlockStatement#body`, `StaticBlock#body`, `Program#body`,
+ * `ClassBody#body`, or `SwitchCase#consequent`.
+ * This is used to check whether a node is the first/last child.
+ * @param {Node} node A node to get child node list.
+ * @returns {Node[]|null} The child node list.
+ */
+function getChildren(node) {
+	const t = node.type;
+
+	if (
+		t === "BlockStatement" ||
+		t === "StaticBlock" ||
+		t === "Program" ||
+		t === "ClassBody"
+	) {
+		return node.body;
+	}
+	if (t === "SwitchCase") {
+		return node.consequent;
+	}
+	return null;
+}
+
+/**
+ * Check whether a given node is the last statement in the parent block.
+ * @param {Node} node A node to check.
+ * @returns {boolean} `true` if the node is the last statement in the parent block.
+ */
+function isLastChild(node) {
+	const t = node.parent.type;
+
+	if (
+		t === "IfStatement" &&
+		node.parent.consequent === node &&
+		node.parent.alternate
+	) {
+		// before `else` keyword.
+		return true;
+	}
+	if (t === "DoWhileStatement") {
+		// before `while` keyword.
+		return true;
+	}
+	const nodeList = getChildren(node.parent);
+
+	return nodeList !== null && nodeList.at(-1) === node; // before `}` or etc.
+}
+
+/** @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: "semi-style",
+						url: "https://eslint.style/rules/semi-style",
+					},
+				},
+			],
+		},
+		type: "layout",
+
+		docs: {
+			description: "Enforce location of semicolons",
+			recommended: false,
+			url: "https://eslint.org/docs/latest/rules/semi-style",
+		},
+
+		schema: [{ enum: ["last", "first"] }],
+		fixable: "whitespace",
+
+		messages: {
+			expectedSemiColon: "Expected this semicolon to be at {{pos}}.",
+		},
+	},
+
+	create(context) {
+		const sourceCode = context.sourceCode;
+		const option = context.options[0] || "last";
+
+		/**
+		 * Check the given semicolon token.
+		 * @param {Token} semiToken The semicolon token to check.
+		 * @param {"first"|"last"} expected The expected location to check.
+		 * @returns {void}
+		 */
+		function check(semiToken, expected) {
+			const prevToken = sourceCode.getTokenBefore(semiToken);
+			const nextToken = sourceCode.getTokenAfter(semiToken);
+			const prevIsSameLine =
+				!prevToken || astUtils.isTokenOnSameLine(prevToken, semiToken);
+			const nextIsSameLine =
+				!nextToken || astUtils.isTokenOnSameLine(semiToken, nextToken);
+
+			if (
+				(expected === "last" && !prevIsSameLine) ||
+				(expected === "first" && !nextIsSameLine)
+			) {
+				context.report({
+					loc: semiToken.loc,
+					messageId: "expectedSemiColon",
+					data: {
+						pos:
+							expected === "last"
+								? "the end of the previous line"
+								: "the beginning of the next line",
+					},
+					fix(fixer) {
+						if (
+							prevToken &&
+							nextToken &&
+							sourceCode.commentsExistBetween(
+								prevToken,
+								nextToken,
+							)
+						) {
+							return null;
+						}
+
+						const start = prevToken
+							? prevToken.range[1]
+							: semiToken.range[0];
+						const end = nextToken
+							? nextToken.range[0]
+							: semiToken.range[1];
+						const text = expected === "last" ? ";\n" : "\n;";
+
+						return fixer.replaceTextRange([start, end], text);
+					},
+				});
+			}
+		}
+
+		return {
+			[SELECTOR](node) {
+				if (option === "first" && isLastChild(node)) {
+					return;
+				}
+
+				const lastToken = sourceCode.getLastToken(node);
+
+				if (astUtils.isSemicolonToken(lastToken)) {
+					check(lastToken, option);
+				}
+			},
+
+			ForStatement(node) {
+				const firstSemi =
+					node.init &&
+					sourceCode.getTokenAfter(
+						node.init,
+						astUtils.isSemicolonToken,
+					);
+				const secondSemi =
+					node.test &&
+					sourceCode.getTokenAfter(
+						node.test,
+						astUtils.isSemicolonToken,
+					);
+
+				if (firstSemi) {
+					check(firstSemi, "last");
+				}
+				if (secondSemi) {
+					check(secondSemi, "last");
+				}
+			},
+		};
+	},
+};