Skip to content

fix(eslint-plugin): [explicit-function-return-type, explicit-module-boundary-types] improved checking for allowHigherOrderFunctions option #8508

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 11 commits into from
Mar 18, 2024
Merged

fix(eslint-plugin): [explicit-function-return-type, explicit-module-boundary-types] improved checking for allowHigherOrderFunctions option #8508

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
c6a312e
fix(eslint-plugin): [explicit-function-return-type] improved checking…
yeonjuan Feb 19, 2024
7e6df4a
refactor
yeonjuan Feb 21, 2024
7f75d3a
fix lint errors
yeonjuan Feb 21, 2024
8121e20
Merge branch 'main' into fix/928
yeonjuan Feb 22, 2024
c818bbd
Merge branch 'main' into fix/928
yeonjuan Feb 22, 2024
479a6d4
Merge branch 'main' into fix/928
yeonjuan Feb 28, 2024
1922f67
Merge branch 'main' into fix/928
yeonjuan Mar 4, 2024
2ae250a
Merge branch 'main' into fix/928
yeonjuan Mar 6, 2024
a61981a
apply reviews
yeonjuan Mar 10, 2024
3dfe154
fix lint error
yeonjuan Mar 10, 2024
68ebb69
Update packages/eslint-plugin/src/rules/explicit-function-return-type.ts
JoshuaKGoldberg Mar 18, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
101 changes: 67 additions & 34 deletions packages/eslint-plugin/src/rules/explicit-function-return-type.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
import type { TSESTree } from '@typescript-eslint/utils';
import { AST_NODE_TYPES } from '@typescript-eslint/utils';

import { createRule } from '../util';
import { createRule, nullThrows } from '../util';
import type { FunctionInfo } from '../util/explicitReturnTypeUtils';
import {
ancestorHasReturnType,
checkFunctionReturnType,
Expand All @@ -22,6 +23,11 @@ type Options = [
];
type MessageIds = 'missingReturnType';

type FunctionNode =
| TSESTree.ArrowFunctionExpression
| TSESTree.FunctionDeclaration
| TSESTree.FunctionExpression;

export default createRule<Options, MessageIds>({
name: 'explicit-function-return-type',
meta: {
Expand Down Expand Up @@ -98,6 +104,22 @@ export default createRule<Options, MessageIds>({
},
],
create(context, [options]) {
const functionInfoStack: FunctionInfo<FunctionNode>[] = [];

function enterFunction(node: FunctionNode): void {
functionInfoStack.push({
node,
returns: [],
});
}

function popFunctionInfo(exitNodeType: string): FunctionInfo<FunctionNode> {
return nullThrows(
functionInfoStack.pop(),
`Stack should exist on ${exitNodeType} exit`,
);
}

function isAllowedFunction(
node:
| TSESTree.ArrowFunctionExpression
Expand Down Expand Up @@ -168,56 +190,67 @@ export default createRule<Options, MessageIds>({
return node.parent.type === AST_NODE_TYPES.CallExpression;
}

return {
'ArrowFunctionExpression, FunctionExpression'(
node: TSESTree.ArrowFunctionExpression | TSESTree.FunctionExpression,
): void {
if (
options.allowConciseArrowFunctionExpressionsStartingWithVoid &&
node.type === AST_NODE_TYPES.ArrowFunctionExpression &&
node.expression &&
node.body.type === AST_NODE_TYPES.UnaryExpression &&
node.body.operator === 'void'
) {
return;
}
function exitFunctionExpression(
node: TSESTree.ArrowFunctionExpression | TSESTree.FunctionExpression,
): void {
const info = popFunctionInfo('function expression');

if (isAllowedFunction(node)) {
return;
}
if (
options.allowConciseArrowFunctionExpressionsStartingWithVoid &&
node.type === AST_NODE_TYPES.ArrowFunctionExpression &&
node.expression &&
node.body.type === AST_NODE_TYPES.UnaryExpression &&
node.body.operator === 'void'
) {
return;
}

if (
options.allowTypedFunctionExpressions &&
(isValidFunctionExpressionReturnType(node, options) ||
ancestorHasReturnType(node))
) {
return;
}
if (isAllowedFunction(node)) {
return;
}

checkFunctionReturnType(node, options, context.sourceCode, loc =>
context.report({
node,
loc,
messageId: 'missingReturnType',
}),
);
},
FunctionDeclaration(node): void {
if (
options.allowTypedFunctionExpressions &&
(isValidFunctionExpressionReturnType(node, options) ||
ancestorHasReturnType(node))
) {
return;
}

checkFunctionReturnType(info, options, context.sourceCode, loc =>
context.report({
node,
loc,
messageId: 'missingReturnType',
}),
);
}

return {
'ArrowFunctionExpression, FunctionExpression, FunctionDeclaration':
enterFunction,
'ArrowFunctionExpression:exit': exitFunctionExpression,
'FunctionExpression:exit': exitFunctionExpression,
'FunctionDeclaration:exit'(node): void {
const info = popFunctionInfo('function declaration');
if (isAllowedFunction(node)) {
return;
}
if (options.allowTypedFunctionExpressions && node.returnType) {
return;
}

checkFunctionReturnType(node, options, context.sourceCode, loc =>
checkFunctionReturnType(info, options, context.sourceCode, loc =>
context.report({
node,
loc,
messageId: 'missingReturnType',
}),
);
},
ReturnStatement(node): void {
functionInfoStack.at(-1)?.returns.push(node);
},
};
},
});
103 changes: 73 additions & 30 deletions packages/eslint-plugin/src/rules/explicit-module-boundary-types.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ import { AST_NODE_TYPES } from '@typescript-eslint/utils';
import { createRule, isFunction } from '../util';
import type {
FunctionExpression,
FunctionInfo,
FunctionNode,
} from '../util/explicitReturnTypeUtils';
import {
Expand Down Expand Up @@ -101,13 +102,31 @@ export default createRule<Options, MessageIds>({
// tracks all of the functions we've already checked
const checkedFunctions = new Set<FunctionNode>();

// tracks functions that were found whilst traversing
const foundFunctions: FunctionNode[] = [];
const functionStack: FunctionNode[] = [];
const functionReturnsMap = new Map<
FunctionNode,
TSESTree.ReturnStatement[]
>();

// all nodes visited, avoids infinite recursion for cyclic references
// (such as class member referring to itself)
const alreadyVisited = new Set<TSESTree.Node>();

function getReturnsInFunction(
node: FunctionNode,
): TSESTree.ReturnStatement[] {
return functionReturnsMap.get(node) ?? [];
}

function enterFunction(node: FunctionNode): void {
functionStack.push(node);
functionReturnsMap.set(node, []);
}

function exitFunction(): void {
functionStack.pop();
}

/*
# How the rule works:

Expand All @@ -120,10 +139,10 @@ export default createRule<Options, MessageIds>({
*/

return {
ExportDefaultDeclaration(node): void {
'ExportDefaultDeclaration:exit'(node): void {
checkNode(node.declaration);
},
'ExportNamedDeclaration:not([source])'(
'ExportNamedDeclaration:not([source]):exit'(
node: TSESTree.ExportNamedDeclaration,
): void {
if (node.declaration) {
Expand All @@ -134,21 +153,25 @@ export default createRule<Options, MessageIds>({
}
}
},
TSExportAssignment(node): void {
'TSExportAssignment:exit'(node): void {
checkNode(node.expression);
},
'ArrowFunctionExpression, FunctionDeclaration, FunctionExpression'(
node: FunctionNode,
): void {
foundFunctions.push(node);
},
'ArrowFunctionExpression, FunctionDeclaration, FunctionExpression':
enterFunction,
'ArrowFunctionExpression:exit': exitFunction,
'FunctionDeclaration:exit': exitFunction,
'FunctionExpression:exit': exitFunction,
'Program:exit'(): void {
for (const func of foundFunctions) {
if (isExportedHigherOrderFunction(func)) {
checkNode(func);
for (const [node, returns] of functionReturnsMap) {
if (isExportedHigherOrderFunction({ node, returns })) {
checkNode(node);
}
}
},
ReturnStatement(node): void {
const current = functionStack[functionStack.length - 1];
functionReturnsMap.get(current)?.push(node);
},
};

function checkParameters(
Expand Down Expand Up @@ -265,7 +288,9 @@ export default createRule<Options, MessageIds>({
return false;
}

function isExportedHigherOrderFunction(node: FunctionNode): boolean {
function isExportedHigherOrderFunction({
node,
}: FunctionInfo<FunctionNode>): boolean {
let current: TSESTree.Node | undefined = node.parent;
while (current) {
if (current.type === AST_NODE_TYPES.ReturnStatement) {
Expand All @@ -274,9 +299,12 @@ export default createRule<Options, MessageIds>({
continue;
}

if (!isFunction(current)) {
return false;
}
const returns = getReturnsInFunction(current);
if (
!isFunction(current) ||
!doesImmediatelyReturnFunctionExpression(current)
!doesImmediatelyReturnFunctionExpression({ node: current, returns })
) {
return false;
}
Expand Down Expand Up @@ -335,8 +363,10 @@ export default createRule<Options, MessageIds>({

switch (node.type) {
case AST_NODE_TYPES.ArrowFunctionExpression:
case AST_NODE_TYPES.FunctionExpression:
return checkFunctionExpression(node);
case AST_NODE_TYPES.FunctionExpression: {
const returns = getReturnsInFunction(node);
return checkFunctionExpression({ node, returns });
}

case AST_NODE_TYPES.ArrayExpression:
for (const element of node.elements) {
Expand All @@ -360,8 +390,10 @@ export default createRule<Options, MessageIds>({
}
return;

case AST_NODE_TYPES.FunctionDeclaration:
return checkFunction(node);
case AST_NODE_TYPES.FunctionDeclaration: {
const returns = getReturnsInFunction(node);
return checkFunction({ node, returns });
}

case AST_NODE_TYPES.MethodDefinition:
case AST_NODE_TYPES.TSAbstractMethodDefinition:
Expand Down Expand Up @@ -419,7 +451,10 @@ export default createRule<Options, MessageIds>({
checkParameters(node);
}

function checkFunctionExpression(node: FunctionExpression): void {
function checkFunctionExpression({
node,
returns,
}: FunctionInfo<FunctionExpression>): void {
if (checkedFunctions.has(node)) {
return;
}
Expand All @@ -434,7 +469,7 @@ export default createRule<Options, MessageIds>({
}

checkFunctionExpressionReturnType(
node,
{ node, returns },
options,
context.sourceCode,
loc => {
Expand All @@ -449,7 +484,10 @@ export default createRule<Options, MessageIds>({
checkParameters(node);
}

function checkFunction(node: TSESTree.FunctionDeclaration): void {
function checkFunction({
node,
returns,
}: FunctionInfo<TSESTree.FunctionDeclaration>): void {
if (checkedFunctions.has(node)) {
return;
}
Expand All @@ -459,13 +497,18 @@ export default createRule<Options, MessageIds>({
return;
}

checkFunctionReturnType(node, options, context.sourceCode, loc => {
context.report({
node,
loc,
messageId: 'missingReturnType',
});
});
checkFunctionReturnType(
{ node, returns },
options,
context.sourceCode,
loc => {
context.report({
node,
loc,
messageId: 'missingReturnType',
});
},
);

checkParameters(node);
}
Expand Down
Loading
Loading