/
handle-done-callback.js
76 lines (65 loc) · 2.51 KB
/
handle-done-callback.js
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
'use strict';
const { find } = require('rambda');
const createAstUtils = require('../util/ast');
module.exports = {
meta: {
type: 'problem',
docs: {
description: 'Enforces handling of callbacks for async tests',
url: 'https://github.com/lo1tuma/eslint-plugin-mocha/blob/main/docs/rules/handle-done-callback.md'
},
schema: [
{
type: 'object',
properties: {
ignoreSkipped: {
type: 'boolean',
default: false
}
},
additionalProperties: false
}
]
},
create(context) {
const astUtils = createAstUtils(context.settings);
const [ { ignoreSkipped = false } = {} ] = context.options;
const modifiersToCheck = ignoreSkipped ? [ 'only' ] : [ 'only', 'skip' ];
function isAsyncFunction(functionExpression) {
return functionExpression.params.length === 1;
}
function findParamInScope(paramName, scope) {
return find(function (variable) {
return variable.name === paramName && variable.defs[0].type === 'Parameter';
}, scope.variables);
}
function isReferenceHandled(reference) {
const parent = context.getSourceCode().getNodeByRangeIndex(reference.identifier.range[0]).parent;
return parent.type === 'CallExpression';
}
function hasHandledReferences(references) {
return references.some(isReferenceHandled);
}
function checkAsyncMochaFunction(functionExpression) {
const scope = context.getScope();
const callback = functionExpression.params[0];
const callbackName = callback.name;
const callbackVariable = findParamInScope(callbackName, scope);
if (callbackVariable && !hasHandledReferences(callbackVariable.references)) {
context.report({
node: callback,
message: 'Expected "{{name}}" callback to be handled.', data: { name: callbackName }
});
}
}
function check(node) {
if (astUtils.hasParentMochaFunctionCall(node, { modifiers: modifiersToCheck }) && isAsyncFunction(node)) {
checkAsyncMochaFunction(node);
}
}
return {
FunctionExpression: check,
ArrowFunctionExpression: check
};
}
};