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
|
/*
* SonarQube
* Copyright (C) 2009-2024 SonarSource SA
* mailto:info AT sonarsource DOT com
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 3 of the License, or (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with this program; if not, write to the Free Software Foundation,
* Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
*/
// For now lets enable it on this extension
// once we have made the refactoring we can add it to sonar-web and all other extension.
module.exports = {
meta: {
type: 'problem',
docs: {
description: 'Prevent unsing within from testing library',
category: 'Best Practices',
},
messages: {
noWithin: "Don't use within as it may hide DOM update. Prefer using chain selector.",
},
},
// eslint-disable-next-line object-shorthand
create: function (context) {
const fnNames = [];
const currentFilePath = context.getFilename();
const sourceCode = context.sourceCode;
return {
// eslint-disable-next-line object-shorthand
CallExpression: function (node) {
if (node.callee.name === 'within') {
let scope = sourceCode.getScope(node);
while (node.callee.name && scope && scope.set.get(node.callee.name) === undefined) {
scope = scope.upper;
}
if (node.callee.name && scope) {
let variable = scope.set.get(node.callee.name);
if (variable.defs[0] && variable.defs[0].parent.source) {
const importPath = variable.defs[0].parent.source.value;
if (importPath.startsWith('@testing-library')) {
context.report({
node: node.callee,
messageId: 'noWithin',
});
}
}
}
}
},
};
},
};
|
