no-debugging-utils.js
5.6 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
"use strict";
Object.defineProperty(exports, "__esModule", { value: true });
exports.RULE_NAME = void 0;
const utils_1 = require("@typescript-eslint/utils");
const create_testing_library_rule_1 = require("../create-testing-library-rule");
const node_utils_1 = require("../node-utils");
const utils_2 = require("../utils");
exports.RULE_NAME = 'no-debugging-utils';
exports.default = (0, create_testing_library_rule_1.createTestingLibraryRule)({
name: exports.RULE_NAME,
meta: {
type: 'problem',
docs: {
description: 'Disallow the use of debugging utilities like `debug`',
recommendedConfig: {
dom: false,
angular: 'error',
react: 'error',
vue: 'error',
marko: 'error',
},
},
messages: {
noDebug: 'Unexpected debug statement',
},
schema: [
{
type: 'object',
properties: {
utilsToCheckFor: {
type: 'object',
properties: utils_2.DEBUG_UTILS.reduce((obj, name) => (Object.assign({ [name]: { type: 'boolean' } }, obj)), {}),
additionalProperties: false,
},
},
additionalProperties: false,
},
],
},
defaultOptions: [
{ utilsToCheckFor: { debug: true, logTestingPlaygroundURL: true } },
],
create(context, [{ utilsToCheckFor = {} }], helpers) {
const suspiciousDebugVariableNames = [];
const suspiciousReferenceNodes = [];
const renderWrapperNames = [];
const builtInConsoleNodes = [];
const utilsToReport = Object.entries(utilsToCheckFor)
.filter(([, shouldCheckFor]) => shouldCheckFor)
.map(([name]) => name);
function detectRenderWrapper(node) {
const innerFunction = (0, node_utils_1.getInnermostReturningFunction)(context, node);
if (innerFunction) {
renderWrapperNames.push((0, node_utils_1.getFunctionName)(innerFunction));
}
}
return {
VariableDeclarator(node) {
if (!node.init) {
return;
}
const initIdentifierNode = (0, node_utils_1.getDeepestIdentifierNode)(node.init);
if (!initIdentifierNode) {
return;
}
if (initIdentifierNode.name === 'console') {
builtInConsoleNodes.push(node);
return;
}
const isRenderWrapperVariableDeclarator = renderWrapperNames.includes(initIdentifierNode.name);
if (!helpers.isRenderVariableDeclarator(node) &&
!isRenderWrapperVariableDeclarator) {
return;
}
if ((0, node_utils_1.isObjectPattern)(node.id)) {
for (const property of node.id.properties) {
if ((0, node_utils_1.isProperty)(property) &&
utils_1.ASTUtils.isIdentifier(property.key) &&
utilsToReport.includes(property.key.name)) {
const identifierNode = (0, node_utils_1.getDeepestIdentifierNode)(property.value);
if (identifierNode) {
suspiciousDebugVariableNames.push(identifierNode.name);
}
}
}
}
if (utils_1.ASTUtils.isIdentifier(node.id)) {
suspiciousReferenceNodes.push(node.id);
}
},
CallExpression(node) {
const callExpressionIdentifier = (0, node_utils_1.getDeepestIdentifierNode)(node);
if (!callExpressionIdentifier) {
return;
}
if (helpers.isRenderUtil(callExpressionIdentifier)) {
detectRenderWrapper(callExpressionIdentifier);
}
const referenceNode = (0, node_utils_1.getReferenceNode)(node);
const referenceIdentifier = (0, node_utils_1.getPropertyIdentifierNode)(referenceNode);
if (!referenceIdentifier) {
return;
}
const isDebugUtil = helpers.isDebugUtil(callExpressionIdentifier, utilsToReport);
const isDeclaredDebugVariable = suspiciousDebugVariableNames.includes(callExpressionIdentifier.name);
const isChainedReferenceDebug = suspiciousReferenceNodes.some((suspiciousReferenceIdentifier) => {
return (utilsToReport.includes(callExpressionIdentifier.name) &&
suspiciousReferenceIdentifier.name === referenceIdentifier.name);
});
const isVariableFromBuiltInConsole = builtInConsoleNodes.some((variableDeclarator) => {
const variables = context.getDeclaredVariables(variableDeclarator);
return variables.some(({ name }) => name === callExpressionIdentifier.name &&
(0, node_utils_1.isCallExpression)(callExpressionIdentifier.parent));
});
if (!isVariableFromBuiltInConsole &&
(isDebugUtil || isDeclaredDebugVariable || isChainedReferenceDebug)) {
context.report({
node: callExpressionIdentifier,
messageId: 'noDebug',
});
}
},
};
},
});