eslint 8.57.1 → 9.39.1

package/lib/rules/func-names.js

@@ -17,175 +17,176 @@ const astUtils = require("./utils/ast-utils");
  * @returns {boolean} `true` if the variable is a function name.
  */
 function isFunctionName(variable) {
-    return variable && variable.defs[0].type === "FunctionName";
+	return variable && variable.defs[0].type === "FunctionName";
 }
 
 //------------------------------------------------------------------------------
 // Rule Definition
 //------------------------------------------------------------------------------
 
-/** @type {import('../shared/types').Rule} */
+/** @type {import('../types').Rule.RuleModule} */
 module.exports = {
-    meta: {
-        type: "suggestion",
-
-        docs: {
-            description: "Require or disallow named `function` expressions",
-            recommended: false,
-            url: "https://eslint.org/docs/latest/rules/func-names"
-        },
-
-        schema: {
-            definitions: {
-                value: {
-                    enum: [
-                        "always",
-                        "as-needed",
-                        "never"
-                    ]
-                }
-            },
-            items: [
-                {
-                    $ref: "#/definitions/value"
-                },
-                {
-                    type: "object",
-                    properties: {
-                        generators: {
-                            $ref: "#/definitions/value"
-                        }
-                    },
-                    additionalProperties: false
-                }
-            ]
-        },
-
-        messages: {
-            unnamed: "Unexpected unnamed {{name}}.",
-            named: "Unexpected named {{name}}."
-        }
-    },
-
-    create(context) {
-
-        const sourceCode = context.sourceCode;
-
-        /**
-         * Returns the config option for the given node.
-         * @param {ASTNode} node A node to get the config for.
-         * @returns {string} The config option.
-         */
-        function getConfigForNode(node) {
-            if (
-                node.generator &&
-                context.options.length > 1 &&
-                context.options[1].generators
-            ) {
-                return context.options[1].generators;
-            }
-
-            return context.options[0] || "always";
-        }
-
-        /**
-         * Determines whether the current FunctionExpression node is a get, set, or
-         * shorthand method in an object literal or a class.
-         * @param {ASTNode} node A node to check.
-         * @returns {boolean} True if the node is a get, set, or shorthand method.
-         */
-        function isObjectOrClassMethod(node) {
-            const parent = node.parent;
-
-            return (parent.type === "MethodDefinition" || (
-                parent.type === "Property" && (
-                    parent.method ||
-                    parent.kind === "get" ||
-                    parent.kind === "set"
-                )
-            ));
-        }
-
-        /**
-         * Determines whether the current FunctionExpression node has a name that would be
-         * inferred from context in a conforming ES6 environment.
-         * @param {ASTNode} node A node to check.
-         * @returns {boolean} True if the node would have a name assigned automatically.
-         */
-        function hasInferredName(node) {
-            const parent = node.parent;
-
-            return isObjectOrClassMethod(node) ||
-                (parent.type === "VariableDeclarator" && parent.id.type === "Identifier" && parent.init === node) ||
-                (parent.type === "Property" && parent.value === node) ||
-                (parent.type === "PropertyDefinition" && parent.value === node) ||
-                (parent.type === "AssignmentExpression" && parent.left.type === "Identifier" && parent.right === node) ||
-                (parent.type === "AssignmentPattern" && parent.left.type === "Identifier" && parent.right === node);
-        }
-
-        /**
-         * Reports that an unnamed function should be named
-         * @param {ASTNode} node The node to report in the event of an error.
-         * @returns {void}
-         */
-        function reportUnexpectedUnnamedFunction(node) {
-            context.report({
-                node,
-                messageId: "unnamed",
-                loc: astUtils.getFunctionHeadLoc(node, sourceCode),
-                data: { name: astUtils.getFunctionNameWithKind(node) }
-            });
-        }
-
-        /**
-         * Reports that a named function should be unnamed
-         * @param {ASTNode} node The node to report in the event of an error.
-         * @returns {void}
-         */
-        function reportUnexpectedNamedFunction(node) {
-            context.report({
-                node,
-                messageId: "named",
-                loc: astUtils.getFunctionHeadLoc(node, sourceCode),
-                data: { name: astUtils.getFunctionNameWithKind(node) }
-            });
-        }
-
-        /**
-         * The listener for function nodes.
-         * @param {ASTNode} node function node
-         * @returns {void}
-         */
-        function handleFunction(node) {
-
-            // Skip recursive functions.
-            const nameVar = sourceCode.getDeclaredVariables(node)[0];
-
-            if (isFunctionName(nameVar) && nameVar.references.length > 0) {
-                return;
-            }
-
-            const hasName = Boolean(node.id && node.id.name);
-            const config = getConfigForNode(node);
-
-            if (config === "never") {
-                if (hasName && node.type !== "FunctionDeclaration") {
-                    reportUnexpectedNamedFunction(node);
-                }
-            } else if (config === "as-needed") {
-                if (!hasName && !hasInferredName(node)) {
-                    reportUnexpectedUnnamedFunction(node);
-                }
-            } else {
-                if (!hasName && !isObjectOrClassMethod(node)) {
-                    reportUnexpectedUnnamedFunction(node);
-                }
-            }
-        }
-
-        return {
-            "FunctionExpression:exit": handleFunction,
-            "ExportDefaultDeclaration > FunctionDeclaration": handleFunction
-        };
-    }
+	meta: {
+		type: "suggestion",
+
+		defaultOptions: ["always", {}],
+
+		docs: {
+			description: "Require or disallow named `function` expressions",
+			recommended: false,
+			url: "https://eslint.org/docs/latest/rules/func-names",
+		},
+
+		schema: {
+			definitions: {
+				value: {
+					enum: ["always", "as-needed", "never"],
+				},
+			},
+			items: [
+				{
+					$ref: "#/definitions/value",
+				},
+				{
+					type: "object",
+					properties: {
+						generators: {
+							$ref: "#/definitions/value",
+						},
+					},
+					additionalProperties: false,
+				},
+			],
+		},
+
+		messages: {
+			unnamed: "Unexpected unnamed {{name}}.",
+			named: "Unexpected named {{name}}.",
+		},
+	},
+
+	create(context) {
+		const sourceCode = context.sourceCode;
+
+		/**
+		 * Returns the config option for the given node.
+		 * @param {ASTNode} node A node to get the config for.
+		 * @returns {string} The config option.
+		 */
+		function getConfigForNode(node) {
+			if (node.generator && context.options[1].generators) {
+				return context.options[1].generators;
+			}
+
+			return context.options[0];
+		}
+
+		/**
+		 * Determines whether the current FunctionExpression node is a get, set, or
+		 * shorthand method in an object literal or a class.
+		 * @param {ASTNode} node A node to check.
+		 * @returns {boolean} True if the node is a get, set, or shorthand method.
+		 */
+		function isObjectOrClassMethod(node) {
+			const parent = node.parent;
+
+			return (
+				parent.type === "MethodDefinition" ||
+				(parent.type === "Property" &&
+					(parent.method ||
+						parent.kind === "get" ||
+						parent.kind === "set"))
+			);
+		}
+
+		/**
+		 * Determines whether the current FunctionExpression node has a name that would be
+		 * inferred from context in a conforming ES6 environment.
+		 * @param {ASTNode} node A node to check.
+		 * @returns {boolean} True if the node would have a name assigned automatically.
+		 */
+		function hasInferredName(node) {
+			const parent = node.parent;
+
+			return (
+				isObjectOrClassMethod(node) ||
+				(parent.type === "VariableDeclarator" &&
+					parent.id.type === "Identifier" &&
+					parent.init === node) ||
+				(parent.type === "Property" && parent.value === node) ||
+				(parent.type === "PropertyDefinition" &&
+					parent.value === node) ||
+				(parent.type === "AssignmentExpression" &&
+					parent.left.type === "Identifier" &&
+					parent.right === node) ||
+				(parent.type === "AssignmentPattern" &&
+					parent.left.type === "Identifier" &&
+					parent.right === node)
+			);
+		}
+
+		/**
+		 * Reports that an unnamed function should be named
+		 * @param {ASTNode} node The node to report in the event of an error.
+		 * @returns {void}
+		 */
+		function reportUnexpectedUnnamedFunction(node) {
+			context.report({
+				node,
+				messageId: "unnamed",
+				loc: astUtils.getFunctionHeadLoc(node, sourceCode),
+				data: { name: astUtils.getFunctionNameWithKind(node) },
+			});
+		}
+
+		/**
+		 * Reports that a named function should be unnamed
+		 * @param {ASTNode} node The node to report in the event of an error.
+		 * @returns {void}
+		 */
+		function reportUnexpectedNamedFunction(node) {
+			context.report({
+				node,
+				messageId: "named",
+				loc: astUtils.getFunctionHeadLoc(node, sourceCode),
+				data: { name: astUtils.getFunctionNameWithKind(node) },
+			});
+		}
+
+		/**
+		 * The listener for function nodes.
+		 * @param {ASTNode} node function node
+		 * @returns {void}
+		 */
+		function handleFunction(node) {
+			// Skip recursive functions.
+			const nameVar = sourceCode.getDeclaredVariables(node)[0];
+
+			if (isFunctionName(nameVar) && nameVar.references.length > 0) {
+				return;
+			}
+
+			const hasName = Boolean(node.id && node.id.name);
+			const config = getConfigForNode(node);
+
+			if (config === "never") {
+				if (hasName && node.type !== "FunctionDeclaration") {
+					reportUnexpectedNamedFunction(node);
+				}
+			} else if (config === "as-needed") {
+				if (!hasName && !hasInferredName(node)) {
+					reportUnexpectedUnnamedFunction(node);
+				}
+			} else {
+				if (!hasName && !isObjectOrClassMethod(node)) {
+					reportUnexpectedUnnamedFunction(node);
+				}
+			}
+		}
+
+		return {
+			"FunctionExpression:exit": handleFunction,
+			"ExportDefaultDeclaration > FunctionDeclaration": handleFunction,
+		};
+	},
 };

package/lib/rules/func-style.js

@@ -8,91 +8,214 @@
 // Rule Definition
 //------------------------------------------------------------------------------
 
-/** @type {import('../shared/types').Rule} */
+/** @type {import('../types').Rule.RuleModule} */
 module.exports = {
-    meta: {
-        type: "suggestion",
-
-        docs: {
-            description: "Enforce the consistent use of either `function` declarations or expressions",
-            recommended: false,
-            url: "https://eslint.org/docs/latest/rules/func-style"
-        },
-
-        schema: [
-            {
-                enum: ["declaration", "expression"]
-            },
-            {
-                type: "object",
-                properties: {
-                    allowArrowFunctions: {
-                        type: "boolean",
-                        default: false
-                    }
-                },
-                additionalProperties: false
-            }
-        ],
-
-        messages: {
-            expression: "Expected a function expression.",
-            declaration: "Expected a function declaration."
-        }
-    },
-
-    create(context) {
-
-        const style = context.options[0],
-            allowArrowFunctions = context.options[1] && context.options[1].allowArrowFunctions,
-            enforceDeclarations = (style === "declaration"),
-            stack = [];
-
-        const nodesToCheck = {
-            FunctionDeclaration(node) {
-                stack.push(false);
-
-                if (!enforceDeclarations && node.parent.type !== "ExportDefaultDeclaration") {
-                    context.report({ node, messageId: "expression" });
-                }
-            },
-            "FunctionDeclaration:exit"() {
-                stack.pop();
-            },
-
-            FunctionExpression(node) {
-                stack.push(false);
-
-                if (enforceDeclarations && node.parent.type === "VariableDeclarator") {
-                    context.report({ node: node.parent, messageId: "declaration" });
-                }
-            },
-            "FunctionExpression:exit"() {
-                stack.pop();
-            },
-
-            ThisExpression() {
-                if (stack.length > 0) {
-                    stack[stack.length - 1] = true;
-                }
-            }
-        };
-
-        if (!allowArrowFunctions) {
-            nodesToCheck.ArrowFunctionExpression = function() {
-                stack.push(false);
-            };
-
-            nodesToCheck["ArrowFunctionExpression:exit"] = function(node) {
-                const hasThisExpr = stack.pop();
-
-                if (enforceDeclarations && !hasThisExpr && node.parent.type === "VariableDeclarator") {
-                    context.report({ node: node.parent, messageId: "declaration" });
-                }
-            };
-        }
-
-        return nodesToCheck;
-
-    }
+	meta: {
+		dialects: ["javascript", "typescript"],
+		language: "javascript",
+		type: "suggestion",
+
+		defaultOptions: [
+			"expression",
+			{
+				allowArrowFunctions: false,
+				allowTypeAnnotation: false,
+				overrides: {},
+			},
+		],
+
+		docs: {
+			description:
+				"Enforce the consistent use of either `function` declarations or expressions assigned to variables",
+			recommended: false,
+			frozen: true,
+			url: "https://eslint.org/docs/latest/rules/func-style",
+		},
+
+		schema: [
+			{
+				enum: ["declaration", "expression"],
+			},
+			{
+				type: "object",
+				properties: {
+					allowArrowFunctions: {
+						type: "boolean",
+					},
+					allowTypeAnnotation: {
+						type: "boolean",
+					},
+					overrides: {
+						type: "object",
+						properties: {
+							namedExports: {
+								enum: ["declaration", "expression", "ignore"],
+							},
+						},
+						additionalProperties: false,
+					},
+				},
+				additionalProperties: false,
+			},
+		],
+
+		messages: {
+			expression: "Expected a function expression.",
+			declaration: "Expected a function declaration.",
+		},
+	},
+
+	create(context) {
+		const [style, { allowArrowFunctions, allowTypeAnnotation, overrides }] =
+			context.options;
+		const enforceDeclarations = style === "declaration";
+		const { namedExports: exportFunctionStyle } = overrides;
+		const stack = [];
+
+		/**
+		 * Checks if a function declaration is part of an overloaded function
+		 * @param {ASTNode} node The function declaration node to check
+		 * @returns {boolean} True if the function is overloaded
+		 */
+		function isOverloadedFunction(node) {
+			const functionName = node.id.name;
+
+			if (node.parent.type === "ExportNamedDeclaration") {
+				return node.parent.parent.body.some(
+					member =>
+						member.type === "ExportNamedDeclaration" &&
+						member.declaration?.type === "TSDeclareFunction" &&
+						member.declaration.id.name === functionName,
+				);
+			}
+
+			if (node.parent.type === "SwitchCase") {
+				return node.parent.parent.cases.some(switchCase =>
+					switchCase.consequent.some(
+						member =>
+							member.type === "TSDeclareFunction" &&
+							member.id.name === functionName,
+					),
+				);
+			}
+
+			return (
+				Array.isArray(node.parent.body) &&
+				node.parent.body.some(
+					member =>
+						member.type === "TSDeclareFunction" &&
+						member.id.name === functionName,
+				)
+			);
+		}
+
+		const nodesToCheck = {
+			FunctionDeclaration(node) {
+				stack.push(false);
+
+				if (
+					!enforceDeclarations &&
+					node.parent.type !== "ExportDefaultDeclaration" &&
+					(typeof exportFunctionStyle === "undefined" ||
+						node.parent.type !== "ExportNamedDeclaration") &&
+					!isOverloadedFunction(node)
+				) {
+					context.report({ node, messageId: "expression" });
+				}
+
+				if (
+					node.parent.type === "ExportNamedDeclaration" &&
+					exportFunctionStyle === "expression" &&
+					!isOverloadedFunction(node)
+				) {
+					context.report({ node, messageId: "expression" });
+				}
+			},
+			"FunctionDeclaration:exit"() {
+				stack.pop();
+			},
+
+			FunctionExpression(node) {
+				stack.push(false);
+
+				if (
+					enforceDeclarations &&
+					node.parent.type === "VariableDeclarator" &&
+					(typeof exportFunctionStyle === "undefined" ||
+						node.parent.parent.parent.type !==
+							"ExportNamedDeclaration") &&
+					!(allowTypeAnnotation && node.parent.id.typeAnnotation)
+				) {
+					context.report({
+						node: node.parent,
+						messageId: "declaration",
+					});
+				}
+
+				if (
+					node.parent.type === "VariableDeclarator" &&
+					node.parent.parent.parent.type ===
+						"ExportNamedDeclaration" &&
+					exportFunctionStyle === "declaration" &&
+					!(allowTypeAnnotation && node.parent.id.typeAnnotation)
+				) {
+					context.report({
+						node: node.parent,
+						messageId: "declaration",
+					});
+				}
+			},
+			"FunctionExpression:exit"() {
+				stack.pop();
+			},
+
+			"ThisExpression, Super"() {
+				if (stack.length > 0) {
+					stack[stack.length - 1] = true;
+				}
+			},
+		};
+
+		if (!allowArrowFunctions) {
+			nodesToCheck.ArrowFunctionExpression = function () {
+				stack.push(false);
+			};
+
+			nodesToCheck["ArrowFunctionExpression:exit"] = function (node) {
+				const hasThisOrSuperExpr = stack.pop();
+
+				if (
+					!hasThisOrSuperExpr &&
+					node.parent.type === "VariableDeclarator"
+				) {
+					if (
+						enforceDeclarations &&
+						(typeof exportFunctionStyle === "undefined" ||
+							node.parent.parent.parent.type !==
+								"ExportNamedDeclaration") &&
+						!(allowTypeAnnotation && node.parent.id.typeAnnotation)
+					) {
+						context.report({
+							node: node.parent,
+							messageId: "declaration",
+						});
+					}
+
+					if (
+						node.parent.parent.parent.type ===
+							"ExportNamedDeclaration" &&
+						exportFunctionStyle === "declaration" &&
+						!(allowTypeAnnotation && node.parent.id.typeAnnotation)
+					) {
+						context.report({
+							node: node.parent,
+							messageId: "declaration",
+						});
+					}
+				}
+			};
+		}
+
+		return nodesToCheck;
+	},
 };