bahlint 28.58.6934-dev-001

package/lib/rules/for-direction.js

@@ -0,0 +1,168 @@
+/**
+ * @fileoverview enforce `for` loop update clause moving the counter in the right direction.(for-direction)
+ * @author Aladdin-ADD<hh_2013@foxmail.com>
+ */
+
+"use strict";
+
+//------------------------------------------------------------------------------
+// Requirements
+//------------------------------------------------------------------------------
+
+const { getStaticValue } = require("@eslint-community/eslint-utils");
+
+//------------------------------------------------------------------------------
+// Rule Definition
+//------------------------------------------------------------------------------
+
+/** @type {import('../types').Rule.RuleModule} */
+module.exports = {
+	meta: {
+		type: "problem",
+
+		docs: {
+			description:
+				"Enforce `for` loop update clause moving the counter in the right direction",
+			recommended: true,
+			url: "https://eslint.org/docs/latest/rules/for-direction",
+		},
+
+		fixable: null,
+		schema: [],
+
+		messages: {
+			incorrectDirection:
+				"The update clause in this loop moves the variable in the wrong direction.",
+		},
+	},
+
+	create(context) {
+		const { sourceCode } = context;
+
+		/**
+		 * report an error.
+		 * @param {ASTNode} node the node to report.
+		 * @returns {void}
+		 */
+		function report(node) {
+			context.report({
+				loc: {
+					start: node.loc.start,
+					end: sourceCode.getTokenBefore(node.body).loc.end,
+				},
+				messageId: "incorrectDirection",
+			});
+		}
+
+		/**
+		 * check the right side of the assignment
+		 * @param {ASTNode} update UpdateExpression to check
+		 * @param {number} dir expected direction that could either be turned around or invalidated
+		 * @returns {number} return dir, the negated dir, or zero if the counter does not change or the direction is not clear
+		 */
+		function getRightDirection(update, dir) {
+			const staticValue = getStaticValue(
+				update.right,
+				sourceCode.getScope(update),
+			);
+
+			if (
+				staticValue &&
+				["bigint", "boolean", "number"].includes(
+					typeof staticValue.value,
+				)
+			) {
+				const sign = Math.sign(Number(staticValue.value)) || 0; // convert NaN to 0
+
+				return dir * sign;
+			}
+			return 0;
+		}
+
+		/**
+		 * check UpdateExpression add/sub the counter
+		 * @param {ASTNode} update UpdateExpression to check
+		 * @param {string} counter variable name to check
+		 * @returns {number} if add return 1, if sub return -1, if nochange, return 0
+		 */
+		function getUpdateDirection(update, counter) {
+			if (
+				update.argument.type === "Identifier" &&
+				update.argument.name === counter
+			) {
+				if (update.operator === "++") {
+					return 1;
+				}
+				if (update.operator === "--") {
+					return -1;
+				}
+			}
+			return 0;
+		}
+
+		/**
+		 * check AssignmentExpression add/sub the counter
+		 * @param {ASTNode} update AssignmentExpression to check
+		 * @param {string} counter variable name to check
+		 * @returns {number} if add return 1, if sub return -1, if nochange, return 0
+		 */
+		function getAssignmentDirection(update, counter) {
+			if (update.left.name === counter) {
+				if (update.operator === "+=") {
+					return getRightDirection(update, 1);
+				}
+				if (update.operator === "-=") {
+					return getRightDirection(update, -1);
+				}
+			}
+			return 0;
+		}
+
+		return {
+			ForStatement(node) {
+				if (
+					node.test &&
+					node.test.type === "BinaryExpression" &&
+					node.update
+				) {
+					for (const counterPosition of ["left", "right"]) {
+						if (node.test[counterPosition].type !== "Identifier") {
+							continue;
+						}
+
+						const counter = node.test[counterPosition].name;
+						const operator = node.test.operator;
+						const update = node.update;
+
+						let wrongDirection;
+
+						if (operator === "<" || operator === "<=") {
+							wrongDirection =
+								counterPosition === "left" ? -1 : 1;
+						} else if (operator === ">" || operator === ">=") {
+							wrongDirection =
+								counterPosition === "left" ? 1 : -1;
+						} else {
+							return;
+						}
+
+						if (update.type === "UpdateExpression") {
+							if (
+								getUpdateDirection(update, counter) ===
+								wrongDirection
+							) {
+								report(node);
+							}
+						} else if (
+							update.type === "AssignmentExpression" &&
+							getAssignmentDirection(update, counter) ===
+								wrongDirection
+						) {
+							report(node);
+						}
+					}
+				}
+			},
+		};
+	},
+};

package/lib/rules/func-call-spacing.js

@@ -0,0 +1,281 @@
+/**
+ * @fileoverview Rule to control spacing within function calls
+ * @author Matt DuVall <http://www.mattduvall.com>
+ * @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: "function-call-spacing",
+						url: "https://eslint.style/rules/function-call-spacing",
+					},
+				},
+			],
+		},
+		type: "layout",
+
+		docs: {
+			description:
+				"Require or disallow spacing between function identifiers and their invocations",
+			recommended: false,
+			url: "https://eslint.org/docs/latest/rules/func-call-spacing",
+		},
+
+		fixable: "whitespace",
+
+		schema: {
+			anyOf: [
+				{
+					type: "array",
+					items: [
+						{
+							enum: ["never"],
+						},
+					],
+					minItems: 0,
+					maxItems: 1,
+				},
+				{
+					type: "array",
+					items: [
+						{
+							enum: ["always"],
+						},
+						{
+							type: "object",
+							properties: {
+								allowNewlines: {
+									type: "boolean",
+								},
+							},
+							additionalProperties: false,
+						},
+					],
+					minItems: 0,
+					maxItems: 2,
+				},
+			],
+		},
+
+		messages: {
+			unexpectedWhitespace:
+				"Unexpected whitespace between function name and paren.",
+			unexpectedNewline:
+				"Unexpected newline between function name and paren.",
+			missing: "Missing space between function name and paren.",
+		},
+	},
+
+	create(context) {
+		const never = context.options[0] !== "always";
+		const allowNewlines =
+			!never && context.options[1] && context.options[1].allowNewlines;
+		const sourceCode = context.sourceCode;
+		const text = sourceCode.getText();
+
+		/**
+		 * Check if open space is present in a function name
+		 * @param {ASTNode} node node to evaluate
+		 * @param {Token} leftToken The last token of the callee. This may be the closing parenthesis that encloses the callee.
+		 * @param {Token} rightToken The first token of the arguments. this is the opening parenthesis that encloses the arguments.
+		 * @returns {void}
+		 * @private
+		 */
+		function checkSpacing(node, leftToken, rightToken) {
+			const textBetweenTokens = text
+				.slice(leftToken.range[1], rightToken.range[0])
+				.replace(/\/\*.*?\*\//gu, "");
+			const hasWhitespace = /\s/u.test(textBetweenTokens);
+			const hasNewline =
+				hasWhitespace &&
+				astUtils.LINEBREAK_MATCHER.test(textBetweenTokens);
+
+			/*
+			 * never allowNewlines hasWhitespace hasNewline message
+			 * F     F             F             F          Missing space between function name and paren.
+			 * F     F             F             T          (Invalid `!hasWhitespace && hasNewline`)
+			 * F     F             T             T          Unexpected newline between function name and paren.
+			 * F     F             T             F          (OK)
+			 * F     T             T             F          (OK)
+			 * F     T             T             T          (OK)
+			 * F     T             F             T          (Invalid `!hasWhitespace && hasNewline`)
+			 * F     T             F             F          Missing space between function name and paren.
+			 * T     T             F             F          (Invalid `never && allowNewlines`)
+			 * T     T             F             T          (Invalid `!hasWhitespace && hasNewline`)
+			 * T     T             T             T          (Invalid `never && allowNewlines`)
+			 * T     T             T             F          (Invalid `never && allowNewlines`)
+			 * T     F             T             F          Unexpected space between function name and paren.
+			 * T     F             T             T          Unexpected space between function name and paren.
+			 * T     F             F             T          (Invalid `!hasWhitespace && hasNewline`)
+			 * T     F             F             F          (OK)
+			 *
+			 * T                   T                        Unexpected space between function name and paren.
+			 * F                   F                        Missing space between function name and paren.
+			 * F     F                           T          Unexpected newline between function name and paren.
+			 */
+
+			if (never && hasWhitespace) {
+				context.report({
+					node,
+					loc: {
+						start: leftToken.loc.end,
+						end: {
+							line: rightToken.loc.start.line,
+							column: rightToken.loc.start.column - 1,
+						},
+					},
+					messageId: "unexpectedWhitespace",
+					fix(fixer) {
+						// Don't remove comments.
+						if (
+							sourceCode.commentsExistBetween(
+								leftToken,
+								rightToken,
+							)
+						) {
+							return null;
+						}
+
+						// If `?.` exists, it doesn't hide no-unexpected-multiline errors
+						if (node.optional) {
+							return fixer.replaceTextRange(
+								[leftToken.range[1], rightToken.range[0]],
+								"?.",
+							);
+						}
+
+						/*
+						 * Only autofix if there is no newline
+						 * https://github.com/eslint/eslint/issues/7787
+						 */
+						if (hasNewline) {
+							return null;
+						}
+						return fixer.removeRange([
+							leftToken.range[1],
+							rightToken.range[0],
+						]);
+					},
+				});
+			} else if (!never && !hasWhitespace) {
+				context.report({
+					node,
+					loc: {
+						start: {
+							line: leftToken.loc.end.line,
+							column: leftToken.loc.end.column - 1,
+						},
+						end: rightToken.loc.start,
+					},
+					messageId: "missing",
+					fix(fixer) {
+						if (node.optional) {
+							return null; // Not sure if inserting a space to either before/after `?.` token.
+						}
+						return fixer.insertTextBefore(rightToken, " ");
+					},
+				});
+			} else if (!never && !allowNewlines && hasNewline) {
+				context.report({
+					node,
+					loc: {
+						start: leftToken.loc.end,
+						end: rightToken.loc.start,
+					},
+					messageId: "unexpectedNewline",
+					fix(fixer) {
+						/*
+						 * Only autofix if there is no newline
+						 * https://github.com/eslint/eslint/issues/7787
+						 * But if `?.` exists, it doesn't hide no-unexpected-multiline errors
+						 */
+						if (!node.optional) {
+							return null;
+						}
+
+						// Don't remove comments.
+						if (
+							sourceCode.commentsExistBetween(
+								leftToken,
+								rightToken,
+							)
+						) {
+							return null;
+						}
+
+						const range = [leftToken.range[1], rightToken.range[0]];
+						const qdToken = sourceCode.getTokenAfter(leftToken);
+
+						if (qdToken.range[0] === leftToken.range[1]) {
+							return fixer.replaceTextRange(range, "?. ");
+						}
+						if (qdToken.range[1] === rightToken.range[0]) {
+							return fixer.replaceTextRange(range, " ?.");
+						}
+						return fixer.replaceTextRange(range, " ?. ");
+					},
+				});
+			}
+		}
+
+		return {
+			"CallExpression, NewExpression"(node) {
+				const lastToken = sourceCode.getLastToken(node);
+				const lastCalleeToken = sourceCode.getLastToken(node.callee);
+				const parenToken = sourceCode.getFirstTokenBetween(
+					lastCalleeToken,
+					lastToken,
+					astUtils.isOpeningParenToken,
+				);
+				const prevToken =
+					parenToken &&
+					sourceCode.getTokenBefore(
+						parenToken,
+						astUtils.isNotQuestionDotToken,
+					);
+
+				// Parens in NewExpression are optional
+				if (!(parenToken && parenToken.range[1] < node.range[1])) {
+					return;
+				}
+
+				checkSpacing(node, prevToken, parenToken);
+			},
+
+			ImportExpression(node) {
+				const leftToken = sourceCode.getFirstToken(node);
+				const rightToken = sourceCode.getTokenAfter(leftToken);
+
+				checkSpacing(node, leftToken, rightToken);
+			},
+		};
+	},
+};