promise-function-async.js
4.92 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
"use strict";
var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
if (k2 === undefined) k2 = k;
Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
}) : (function(o, m, k, k2) {
if (k2 === undefined) k2 = k;
o[k2] = m[k];
}));
var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
Object.defineProperty(o, "default", { enumerable: true, value: v });
}) : function(o, v) {
o["default"] = v;
});
var __importStar = (this && this.__importStar) || function (mod) {
if (mod && mod.__esModule) return mod;
var result = {};
if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
__setModuleDefault(result, mod);
return result;
};
Object.defineProperty(exports, "__esModule", { value: true });
const experimental_utils_1 = require("@typescript-eslint/experimental-utils");
const util = __importStar(require("../util"));
exports.default = util.createRule({
name: 'promise-function-async',
meta: {
type: 'suggestion',
docs: {
description: 'Requires any function or method that returns a Promise to be marked async',
category: 'Best Practices',
recommended: false,
requiresTypeChecking: true,
},
messages: {
missingAsync: 'Functions that return promises must be async.',
},
schema: [
{
type: 'object',
properties: {
allowAny: {
type: 'boolean',
},
allowedPromiseNames: {
type: 'array',
items: {
type: 'string',
},
},
checkArrowFunctions: {
type: 'boolean',
},
checkFunctionDeclarations: {
type: 'boolean',
},
checkFunctionExpressions: {
type: 'boolean',
},
checkMethodDeclarations: {
type: 'boolean',
},
},
additionalProperties: false,
},
],
},
defaultOptions: [
{
allowAny: true,
allowedPromiseNames: [],
checkArrowFunctions: true,
checkFunctionDeclarations: true,
checkFunctionExpressions: true,
checkMethodDeclarations: true,
},
],
create(context, [{ allowAny, allowedPromiseNames, checkArrowFunctions, checkFunctionDeclarations, checkFunctionExpressions, checkMethodDeclarations, },]) {
const allAllowedPromiseNames = new Set([
'Promise',
...allowedPromiseNames,
]);
const parserServices = util.getParserServices(context);
const checker = parserServices.program.getTypeChecker();
function validateNode(node) {
const originalNode = parserServices.esTreeNodeToTSNodeMap.get(node);
const signatures = checker
.getTypeAtLocation(originalNode)
.getCallSignatures();
if (!signatures.length) {
return;
}
const returnType = checker.getReturnTypeOfSignature(signatures[0]);
if (!util.containsAllTypesByName(returnType, allowAny, allAllowedPromiseNames)) {
return;
}
if (node.parent &&
(node.parent.type === experimental_utils_1.AST_NODE_TYPES.Property ||
node.parent.type === experimental_utils_1.AST_NODE_TYPES.MethodDefinition) &&
(node.parent.kind === 'get' || node.parent.kind === 'set')) {
return;
}
context.report({
messageId: 'missingAsync',
node,
});
}
return {
'ArrowFunctionExpression[async = false]'(node) {
if (checkArrowFunctions) {
validateNode(node);
}
},
'FunctionDeclaration[async = false]'(node) {
if (checkFunctionDeclarations) {
validateNode(node);
}
},
'FunctionExpression[async = false]'(node) {
if (node.parent &&
'kind' in node.parent &&
node.parent.kind === 'method') {
if (checkMethodDeclarations) {
validateNode(node.parent);
}
}
else if (checkFunctionExpressions) {
validateNode(node);
}
},
};
},
});
//# sourceMappingURL=promise-function-async.js.map