Skip to content

Commit 936e252

Browse files
islandryuJoshuaKGoldbergJosh Goldberg
authoredFeb 2, 2022
feat(eslint-plugin): [explicit-function-return-type] add allowedNames (#4440)
* feat(eslint-plugin): [explicit-function-return-type] add allowedNames option * feat(eslint-plugin): [explicit-function-return-type] afix typecheck * Update packages/eslint-plugin/src/rules/explicit-function-return-type.ts Co-authored-by: Josh Goldberg <me@joshuakgoldberg.com> * feat(eslint-plugin): [explicit-function-return-type] Change to allowedNames to work for object properties and class methods * feat(eslint-plugin): [explicit-function-return-type] Change to allowedNames to work for object properties and class methods * fix(eslint-plugin): [explicit-function-return-type] fix for codecov * fix(eslint-plugin): [explicit-function-return-type] add test * fix(eslint-plugin): [explicit-function-return-type] add test * fix(eslint-plugin): [explicit-function-return-type] fix for codecov * fix(eslint-plugin): [explicit-function-return-type] Change allowedName to not ignore computed property Co-authored-by: Josh Goldberg <me@joshuakgoldberg.com> Co-authored-by: Josh Goldberg <joshuakgoldberg@outlook.com>
·
v8.29.0v5.11.0
1 parent a2bd048 commit 936e252

File tree

3 files changed

+275
-0
lines changed

3 files changed

+275
-0
lines changed
 

‎packages/eslint-plugin/docs/rules/explicit-function-return-type.md

+20
Original file line numberDiff line numberDiff line change
@@ -77,6 +77,10 @@ type Options = {
7777
allowDirectConstAssertionInArrowFunctions?: boolean;
7878
// if true, concise arrow functions that start with the void keyword will not be checked
7979
allowConciseArrowFunctionExpressionsStartingWithVoid?: boolean;
80+
/**
81+
* An array of function/method names that will not have their arguments or their return values checked.
82+
*/
83+
allowedNames?: string[];
8084
};
8185

8286
const defaults = {
@@ -85,6 +89,7 @@ const defaults = {
8589
allowHigherOrderFunctions: true,
8690
allowDirectConstAssertionInArrowFunctions: true,
8791
allowConciseArrowFunctionExpressionsStartingWithVoid: false,
92+
allowedNames: [],
8893
};
8994
```
9095

@@ -262,6 +267,21 @@ const log = (message: string) => {
262267
var log = (message: string) => void console.log(message);
263268
```
264269

270+
### `allowedNames`
271+
272+
You may pass function/method names you would like this rule to ignore, like so:
273+
274+
```json
275+
{
276+
"@typescript-eslint/explicit-function-return-type": [
277+
"error",
278+
{
279+
"allowedNames": ["ignoredFunctionName", "ignoredMethodName"]
280+
}
281+
]
282+
}
283+
```
284+
265285
## When Not To Use It
266286

267287
If you don't wish to prevent calling code from using function return values in unexpected ways, then

‎packages/eslint-plugin/src/rules/explicit-function-return-type.ts

+67
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@ type Options = [
1313
allowHigherOrderFunctions?: boolean;
1414
allowDirectConstAssertionInArrowFunctions?: boolean;
1515
allowConciseArrowFunctionExpressionsStartingWithVoid?: boolean;
16+
allowedNames?: string[];
1617
},
1718
];
1819
type MessageIds = 'missingReturnType';
@@ -48,6 +49,12 @@ export default util.createRule<Options, MessageIds>({
4849
allowConciseArrowFunctionExpressionsStartingWithVoid: {
4950
type: 'boolean',
5051
},
52+
allowedNames: {
53+
type: 'array',
54+
items: {
55+
type: 'string',
56+
},
57+
},
5158
},
5259
additionalProperties: false,
5360
},
@@ -60,11 +67,64 @@ export default util.createRule<Options, MessageIds>({
6067
allowHigherOrderFunctions: true,
6168
allowDirectConstAssertionInArrowFunctions: true,
6269
allowConciseArrowFunctionExpressionsStartingWithVoid: false,
70+
allowedNames: [],
6371
},
6472
],
6573
create(context, [options]) {
6674
const sourceCode = context.getSourceCode();
75+
function isAllowedName(
76+
node:
77+
| TSESTree.ArrowFunctionExpression
78+
| TSESTree.FunctionExpression
79+
| TSESTree.FunctionDeclaration,
80+
): boolean {
81+
if (!options.allowedNames || !options.allowedNames.length) {
82+
return false;
83+
}
6784

85+
if (
86+
node.type === AST_NODE_TYPES.ArrowFunctionExpression ||
87+
node.type === AST_NODE_TYPES.FunctionExpression
88+
) {
89+
const parent = node.parent;
90+
let funcName;
91+
if (node.id?.name) {
92+
funcName = node.id.name;
93+
} else if (parent) {
94+
switch (parent.type) {
95+
case AST_NODE_TYPES.VariableDeclarator: {
96+
if (parent.id.type === AST_NODE_TYPES.Identifier) {
97+
funcName = parent.id.name;
98+
}
99+
break;
100+
}
101+
case AST_NODE_TYPES.MethodDefinition:
102+
case AST_NODE_TYPES.PropertyDefinition:
103+
case AST_NODE_TYPES.Property: {
104+
if (
105+
parent.key.type === AST_NODE_TYPES.Identifier &&
106+
parent.computed === false
107+
) {
108+
funcName = parent.key.name;
109+
}
110+
break;
111+
}
112+
}
113+
}
114+
if (!!funcName && !!options.allowedNames.includes(funcName)) {
115+
return true;
116+
}
117+
}
118+
if (
119+
node.type === AST_NODE_TYPES.FunctionDeclaration &&
120+
node.id &&
121+
node.id.type === AST_NODE_TYPES.Identifier &&
122+
!!options.allowedNames.includes(node.id.name)
123+
) {
124+
return true;
125+
}
126+
return false;
127+
}
68128
return {
69129
'ArrowFunctionExpression, FunctionExpression'(
70130
node: TSESTree.ArrowFunctionExpression | TSESTree.FunctionExpression,
@@ -79,6 +139,10 @@ export default util.createRule<Options, MessageIds>({
79139
return;
80140
}
81141

142+
if (isAllowedName(node)) {
143+
return;
144+
}
145+
82146
if (
83147
options.allowTypedFunctionExpressions &&
84148
(isValidFunctionExpressionReturnType(node, options) ||
@@ -96,6 +160,9 @@ export default util.createRule<Options, MessageIds>({
96160
);
97161
},
98162
FunctionDeclaration(node): void {
163+
if (isAllowedName(node)) {
164+
return;
165+
}
99166
if (options.allowTypedFunctionExpressions && node.returnType) {
100167
return;
101168
}

‎packages/eslint-plugin/tests/rules/explicit-function-return-type.test.ts

+188
Original file line numberDiff line numberDiff line change
@@ -400,6 +400,99 @@ new Foo(1, () => {});
400400
code: 'const log = (message: string) => void console.log(message);',
401401
options: [{ allowConciseArrowFunctionExpressionsStartingWithVoid: true }],
402402
},
403+
{
404+
filename: 'test.ts',
405+
options: [
406+
{
407+
allowedNames: ['test1', 'test2'],
408+
},
409+
],
410+
code: `
411+
function test1() {
412+
return;
413+
}
414+
415+
const foo = function test2() {
416+
return;
417+
};
418+
`,
419+
},
420+
{
421+
filename: 'test.ts',
422+
options: [
423+
{
424+
allowedNames: ['test1', 'test2'],
425+
},
426+
],
427+
code: `
428+
const test1 = function () {
429+
return;
430+
};
431+
const foo = function () {
432+
return function test2() {};
433+
};
434+
`,
435+
},
436+
{
437+
filename: 'test.ts',
438+
options: [
439+
{
440+
allowedNames: ['test1', 'test2'],
441+
},
442+
],
443+
code: `
444+
const test1 = () => {
445+
return;
446+
};
447+
export const foo = {
448+
test2() {
449+
return 0;
450+
},
451+
};
452+
`,
453+
},
454+
{
455+
filename: 'test.ts',
456+
code: `
457+
class Test {
458+
constructor() {}
459+
get prop() {
460+
return 1;
461+
}
462+
set prop() {}
463+
method() {
464+
return;
465+
}
466+
arrow = () => 'arrow';
467+
private method() {
468+
return;
469+
}
470+
}
471+
`,
472+
options: [
473+
{
474+
allowedNames: ['prop', 'method', 'arrow'],
475+
},
476+
],
477+
},
478+
{
479+
filename: 'test.ts',
480+
code: `
481+
const x = {
482+
arrowFn: () => {
483+
return;
484+
},
485+
fn: function () {
486+
return;
487+
},
488+
};
489+
`,
490+
options: [
491+
{
492+
allowedNames: ['arrowFn', 'fn'],
493+
},
494+
],
495+
},
403496
{
404497
filename: 'test.ts',
405498
code: `
@@ -1226,5 +1319,100 @@ const func = (value: number) => ({ type: 'X', value } as const);
12261319
},
12271320
],
12281321
},
1322+
{
1323+
filename: 'test.ts',
1324+
options: [
1325+
{
1326+
allowedNames: ['test', '1'],
1327+
},
1328+
],
1329+
code: `
1330+
function hoge() {
1331+
return;
1332+
}
1333+
const foo = () => {
1334+
return;
1335+
};
1336+
const baz = function () {
1337+
return;
1338+
};
1339+
let [test, test] = function () {
1340+
return;
1341+
};
1342+
class X {
1343+
[test] = function () {
1344+
return;
1345+
};
1346+
}
1347+
const x = {
1348+
1: function () {
1349+
reutrn;
1350+
},
1351+
};
1352+
`,
1353+
errors: [
1354+
{
1355+
messageId: 'missingReturnType',
1356+
line: 2,
1357+
endLine: 2,
1358+
column: 1,
1359+
endColumn: 16,
1360+
},
1361+
{
1362+
messageId: 'missingReturnType',
1363+
line: 5,
1364+
endLine: 5,
1365+
column: 13,
1366+
endColumn: 18,
1367+
},
1368+
{
1369+
messageId: 'missingReturnType',
1370+
line: 8,
1371+
endLine: 8,
1372+
column: 13,
1373+
endColumn: 24,
1374+
},
1375+
{
1376+
messageId: 'missingReturnType',
1377+
line: 11,
1378+
endLine: 11,
1379+
column: 20,
1380+
endColumn: 31,
1381+
},
1382+
{
1383+
line: 15,
1384+
column: 12,
1385+
messageId: 'missingReturnType',
1386+
endLine: 15,
1387+
endColumn: 23,
1388+
},
1389+
{
1390+
messageId: 'missingReturnType',
1391+
line: 20,
1392+
endLine: 20,
1393+
column: 6,
1394+
endColumn: 17,
1395+
},
1396+
],
1397+
},
1398+
{
1399+
filename: 'test.ts',
1400+
code: `
1401+
const ignoredName = 'notIgnoredName';
1402+
class Foo {
1403+
[ignoredName]() {}
1404+
}
1405+
`,
1406+
options: [{ allowedNames: ['ignoredName'] }],
1407+
errors: [
1408+
{
1409+
messageId: 'missingReturnType',
1410+
line: 4,
1411+
endLine: 4,
1412+
column: 3,
1413+
endColumn: 18,
1414+
},
1415+
],
1416+
},
12291417
],
12301418
});

0 commit comments

Comments
 (0)
Please sign in to comment.