bahlint 28.58.6934

package/lib/rules/brace-style.js

@@ -0,0 +1,278 @@
+/**
+ * @fileoverview Rule to flag block statements that do not use the one true brace style
+ * @author Ian Christian Myers
+ * @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: "brace-style",
+						url: "https://eslint.style/rules/brace-style",
+					},
+				},
+			],
+		},
+		type: "layout",
+
+		docs: {
+			description: "Enforce consistent brace style for blocks",
+			recommended: false,
+			url: "https://eslint.org/docs/latest/rules/brace-style",
+		},
+
+		schema: [
+			{
+				enum: ["1tbs", "stroustrup", "allman"],
+			},
+			{
+				type: "object",
+				properties: {
+					allowSingleLine: {
+						type: "boolean",
+						default: false,
+					},
+				},
+				additionalProperties: false,
+			},
+		],
+
+		fixable: "whitespace",
+
+		messages: {
+			nextLineOpen:
+				"Opening curly brace does not appear on the same line as controlling statement.",
+			sameLineOpen:
+				"Opening curly brace appears on the same line as controlling statement.",
+			blockSameLine:
+				"Statement inside of curly braces should be on next line.",
+			nextLineClose:
+				"Closing curly brace does not appear on the same line as the subsequent block.",
+			singleLineClose:
+				"Closing curly brace should be on the same line as opening curly brace or on the line after the previous block.",
+			sameLineClose:
+				"Closing curly brace appears on the same line as the subsequent block.",
+		},
+	},
+
+	create(context) {
+		const style = context.options[0] || "1tbs",
+			params = context.options[1] || {},
+			sourceCode = context.sourceCode;
+
+		//--------------------------------------------------------------------------
+		// Helpers
+		//--------------------------------------------------------------------------
+
+		/**
+		 * Fixes a place where a newline unexpectedly appears
+		 * @param {Token} firstToken The token before the unexpected newline
+		 * @param {Token} secondToken The token after the unexpected newline
+		 * @returns {Function} A fixer function to remove the newlines between the tokens
+		 */
+		function removeNewlineBetween(firstToken, secondToken) {
+			const textRange = [firstToken.range[1], secondToken.range[0]];
+			const textBetween = sourceCode.text.slice(
+				textRange[0],
+				textRange[1],
+			);
+
+			// Don't do a fix if there is a comment between the tokens
+			if (textBetween.trim()) {
+				return null;
+			}
+			return fixer => fixer.replaceTextRange(textRange, " ");
+		}
+
+		/**
+		 * Validates a pair of curly brackets based on the user's config
+		 * @param {Token} openingCurly The opening curly bracket
+		 * @param {Token} closingCurly The closing curly bracket
+		 * @returns {void}
+		 */
+		function validateCurlyPair(openingCurly, closingCurly) {
+			const tokenBeforeOpeningCurly =
+				sourceCode.getTokenBefore(openingCurly);
+			const tokenAfterOpeningCurly =
+				sourceCode.getTokenAfter(openingCurly);
+			const tokenBeforeClosingCurly =
+				sourceCode.getTokenBefore(closingCurly);
+			const singleLineException =
+				params.allowSingleLine &&
+				astUtils.isTokenOnSameLine(openingCurly, closingCurly);
+
+			if (
+				style !== "allman" &&
+				!astUtils.isTokenOnSameLine(
+					tokenBeforeOpeningCurly,
+					openingCurly,
+				)
+			) {
+				context.report({
+					node: openingCurly,
+					messageId: "nextLineOpen",
+					fix: removeNewlineBetween(
+						tokenBeforeOpeningCurly,
+						openingCurly,
+					),
+				});
+			}
+
+			if (
+				style === "allman" &&
+				astUtils.isTokenOnSameLine(
+					tokenBeforeOpeningCurly,
+					openingCurly,
+				) &&
+				!singleLineException
+			) {
+				context.report({
+					node: openingCurly,
+					messageId: "sameLineOpen",
+					fix: fixer => fixer.insertTextBefore(openingCurly, "\n"),
+				});
+			}
+
+			if (
+				astUtils.isTokenOnSameLine(
+					openingCurly,
+					tokenAfterOpeningCurly,
+				) &&
+				tokenAfterOpeningCurly !== closingCurly &&
+				!singleLineException
+			) {
+				context.report({
+					node: openingCurly,
+					messageId: "blockSameLine",
+					fix: fixer => fixer.insertTextAfter(openingCurly, "\n"),
+				});
+			}
+
+			if (
+				tokenBeforeClosingCurly !== openingCurly &&
+				!singleLineException &&
+				astUtils.isTokenOnSameLine(
+					tokenBeforeClosingCurly,
+					closingCurly,
+				)
+			) {
+				context.report({
+					node: closingCurly,
+					messageId: "singleLineClose",
+					fix: fixer => fixer.insertTextBefore(closingCurly, "\n"),
+				});
+			}
+		}
+
+		/**
+		 * Validates the location of a token that appears before a keyword (e.g. a newline before `else`)
+		 * @param {Token} curlyToken The closing curly token. This is assumed to precede a keyword token (such as `else` or `finally`).
+		 * @returns {void}
+		 */
+		function validateCurlyBeforeKeyword(curlyToken) {
+			const keywordToken = sourceCode.getTokenAfter(curlyToken);
+
+			if (
+				style === "1tbs" &&
+				!astUtils.isTokenOnSameLine(curlyToken, keywordToken)
+			) {
+				context.report({
+					node: curlyToken,
+					messageId: "nextLineClose",
+					fix: removeNewlineBetween(curlyToken, keywordToken),
+				});
+			}
+
+			if (
+				style !== "1tbs" &&
+				astUtils.isTokenOnSameLine(curlyToken, keywordToken)
+			) {
+				context.report({
+					node: curlyToken,
+					messageId: "sameLineClose",
+					fix: fixer => fixer.insertTextAfter(curlyToken, "\n"),
+				});
+			}
+		}
+
+		//--------------------------------------------------------------------------
+		// Public API
+		//--------------------------------------------------------------------------
+
+		return {
+			BlockStatement(node) {
+				if (!astUtils.STATEMENT_LIST_PARENTS.has(node.parent.type)) {
+					validateCurlyPair(
+						sourceCode.getFirstToken(node),
+						sourceCode.getLastToken(node),
+					);
+				}
+			},
+			StaticBlock(node) {
+				validateCurlyPair(
+					sourceCode.getFirstToken(node, { skip: 1 }), // skip the `static` token
+					sourceCode.getLastToken(node),
+				);
+			},
+			ClassBody(node) {
+				validateCurlyPair(
+					sourceCode.getFirstToken(node),
+					sourceCode.getLastToken(node),
+				);
+			},
+			SwitchStatement(node) {
+				const closingCurly = sourceCode.getLastToken(node);
+				const openingCurly = sourceCode.getTokenBefore(
+					node.cases.length ? node.cases[0] : closingCurly,
+				);
+
+				validateCurlyPair(openingCurly, closingCurly);
+			},
+			IfStatement(node) {
+				if (
+					node.consequent.type === "BlockStatement" &&
+					node.alternate
+				) {
+					// Handle the keyword after the `if` block (before `else`)
+					validateCurlyBeforeKeyword(
+						sourceCode.getLastToken(node.consequent),
+					);
+				}
+			},
+			TryStatement(node) {
+				// Handle the keyword after the `try` block (before `catch` or `finally`)
+				validateCurlyBeforeKeyword(sourceCode.getLastToken(node.block));
+
+				if (node.handler && node.finalizer) {
+					// Handle the keyword after the `catch` block (before `finally`)
+					validateCurlyBeforeKeyword(
+						sourceCode.getLastToken(node.handler.body),
+					);
+				}
+			},
+		};
+	},
+};

package/lib/rules/callback-return.js

@@ -0,0 +1,216 @@
+/**
+ * @fileoverview Enforce return after a callback.
+ * @author Jamund Ferguson
+ * @deprecated in ESLint v7.0.0
+ */
+"use strict";
+
+//------------------------------------------------------------------------------
+// Rule Definition
+//------------------------------------------------------------------------------
+
+/** @type {import('../types').Rule.RuleModule} */
+module.exports = {
+	meta: {
+		deprecated: {
+			message: "Node.js rules were moved out of ESLint core.",
+			url: "https://eslint.org/docs/latest/use/migrating-to-7.0.0#deprecate-node-rules",
+			deprecatedSince: "7.0.0",
+			availableUntil: "11.0.0",
+			replacedBy: [
+				{
+					message:
+						"eslint-plugin-n now maintains deprecated Node.js-related rules.",
+					plugin: {
+						name: "eslint-plugin-n",
+						url: "https://github.com/eslint-community/eslint-plugin-n",
+					},
+					rule: {
+						name: "callback-return",
+						url: "https://github.com/eslint-community/eslint-plugin-n/tree/master/docs/rules/callback-return.md",
+					},
+				},
+			],
+		},
+
+		type: "suggestion",
+
+		docs: {
+			description: "Require `return` statements after callbacks",
+			recommended: false,
+			url: "https://eslint.org/docs/latest/rules/callback-return",
+		},
+
+		schema: [
+			{
+				type: "array",
+				items: { type: "string" },
+			},
+		],
+
+		messages: {
+			missingReturn: "Expected return with your callback function.",
+		},
+	},
+
+	create(context) {
+		const callbacks = context.options[0] || ["callback", "cb", "next"],
+			sourceCode = context.sourceCode;
+
+		//--------------------------------------------------------------------------
+		// Helpers
+		//--------------------------------------------------------------------------
+
+		/**
+		 * Find the closest parent matching a list of types.
+		 * @param {ASTNode} node The node whose parents we are searching
+		 * @param {Array} types The node types to match
+		 * @returns {ASTNode} The matched node or undefined.
+		 */
+		function findClosestParentOfType(node, types) {
+			if (!node.parent) {
+				return null;
+			}
+			if (!types.includes(node.parent.type)) {
+				return findClosestParentOfType(node.parent, types);
+			}
+			return node.parent;
+		}
+
+		/**
+		 * Check to see if a node contains only identifiers
+		 * @param {ASTNode} node The node to check
+		 * @returns {boolean} Whether or not the node contains only identifiers
+		 */
+		function containsOnlyIdentifiers(node) {
+			if (node.type === "Identifier") {
+				return true;
+			}
+
+			if (node.type === "MemberExpression") {
+				if (node.object.type === "Identifier") {
+					return true;
+				}
+				if (node.object.type === "MemberExpression") {
+					return containsOnlyIdentifiers(node.object);
+				}
+			}
+
+			return false;
+		}
+
+		/**
+		 * Check to see if a CallExpression is in our callback list.
+		 * @param {ASTNode} node The node to check against our callback names list.
+		 * @returns {boolean} Whether or not this function matches our callback name.
+		 */
+		function isCallback(node) {
+			return (
+				containsOnlyIdentifiers(node.callee) &&
+				callbacks.includes(sourceCode.getText(node.callee))
+			);
+		}
+
+		/**
+		 * Determines whether or not the callback is part of a callback expression.
+		 * @param {ASTNode} node The callback node
+		 * @param {ASTNode} parentNode The expression node
+		 * @returns {boolean} Whether or not this is part of a callback expression
+		 */
+		function isCallbackExpression(node, parentNode) {
+			// ensure the parent node exists and is an expression
+			if (!parentNode || parentNode.type !== "ExpressionStatement") {
+				return false;
+			}
+
+			// cb()
+			if (parentNode.expression === node) {
+				return true;
+			}
+
+			// special case for cb && cb() and similar
+			if (
+				parentNode.expression.type === "BinaryExpression" ||
+				parentNode.expression.type === "LogicalExpression"
+			) {
+				if (parentNode.expression.right === node) {
+					return true;
+				}
+			}
+
+			return false;
+		}
+
+		//--------------------------------------------------------------------------
+		// Public
+		//--------------------------------------------------------------------------
+
+		return {
+			CallExpression(node) {
+				// if we're not a callback we can return
+				if (!isCallback(node)) {
+					return;
+				}
+
+				// find the closest block, return or loop
+				const closestBlock =
+					findClosestParentOfType(node, [
+						"BlockStatement",
+						"ReturnStatement",
+						"ArrowFunctionExpression",
+					]) || {};
+
+				// if our parent is a return we know we're ok
+				if (closestBlock.type === "ReturnStatement") {
+					return;
+				}
+
+				// arrow functions don't always have blocks and implicitly return
+				if (closestBlock.type === "ArrowFunctionExpression") {
+					return;
+				}
+
+				// block statements are part of functions and most if statements
+				if (closestBlock.type === "BlockStatement") {
+					// find the last item in the block
+					const lastItem = closestBlock.body.at(-1);
+
+					// if the callback is the last thing in a block that might be ok
+					if (isCallbackExpression(node, lastItem)) {
+						const parentType = closestBlock.parent.type;
+
+						// but only if the block is part of a function
+						if (
+							parentType === "FunctionExpression" ||
+							parentType === "FunctionDeclaration" ||
+							parentType === "ArrowFunctionExpression"
+						) {
+							return;
+						}
+					}
+
+					// ending a block with a return is also ok
+					if (lastItem.type === "ReturnStatement") {
+						// but only if the callback is immediately before
+						if (
+							isCallbackExpression(node, closestBlock.body.at(-2))
+						) {
+							return;
+						}
+					}
+				}
+
+				// as long as you're the child of a function at this point you should be asked to return
+				if (
+					findClosestParentOfType(node, [
+						"FunctionDeclaration",
+						"FunctionExpression",
+						"ArrowFunctionExpression",
+					])
+				) {
+					context.report({ node, messageId: "missingReturn" });
+				}
+			},
+		};
+	},
+};