eslint-plugin-sonarjs
Version:
SonarJS rules for ESLint
133 lines (132 loc) • 5.39 kB
JavaScript
;
/*
* SonarQube JavaScript Plugin
* Copyright (C) 2011-2025 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 Sonar Source-Available License Version 1, as published by SonarSource SA.
*
* 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 Sonar Source-Available License for more details.
*
* You should have received a copy of the Sonar Source-Available License
* along with this program; if not, see https://sonarsource.com/license/ssal/
*/
// https://sonarsource.github.io/rspec/#/rspec/S6092/javascript
Object.defineProperty(exports, "__esModule", { value: true });
exports.rule = void 0;
const index_js_1 = require("../helpers/index.js");
const meta_js_1 = require("./meta.js");
const message = 'Refactor this uncertain assertion; it can succeed for multiple reasons.';
exports.rule = {
meta: (0, index_js_1.generateMeta)(meta_js_1.meta),
create(context) {
if (!index_js_1.Chai.isImported(context)) {
return {};
}
return {
ExpressionStatement: (node) => {
const elements = retrieveAssertionChainElements(node.expression);
if (elements.length > 1 &&
((0, index_js_1.isIdentifier)(elements[0].identifier, 'expect') ||
getElementIndex(elements, 'should') >= 0)) {
checkNotThrow(context, elements);
checkNotInclude(context, elements);
checkNotHaveProperty(context, elements);
checkNotHaveOwnPropertyDescriptor(context, elements);
checkNotHaveMembers(context, elements);
checkChangeBy(context, elements);
checkNotIncDec(context, elements);
checkNotBy(context, elements);
checkNotFinite(context, elements);
}
},
};
},
};
function checkNotThrow(context, elements) {
checkWithCondition(context, elements, 'not', 'throw', args => !!args && args.length > 0);
}
function checkNotInclude(context, elements) {
checkWithCondition(context, elements, 'not', 'include', args => !!args && args.length > 0 && args[0].type === 'ObjectExpression');
}
function checkNotHaveProperty(context, elements) {
checkWithCondition(context, elements, 'not', 'property', args => !!args && args.length > 1);
}
function checkNotHaveOwnPropertyDescriptor(context, elements) {
checkWithCondition(context, elements, 'not', 'ownPropertyDescriptor', args => !!args && args.length > 1);
}
function checkNotHaveMembers(context, elements) {
checkWithCondition(context, elements, 'not', 'members');
}
function checkChangeBy(context, elements) {
checkWithCondition(context, elements, 'change', 'by');
}
function checkNotIncDec(context, elements) {
checkWithCondition(context, elements, 'not', 'increase');
checkWithCondition(context, elements, 'not', 'decrease');
}
function checkNotBy(context, elements) {
checkWithCondition(context, elements, 'not', 'by');
}
function checkNotFinite(context, elements) {
checkWithCondition(context, elements, 'not', 'finite');
}
function checkWithCondition(context, elements, first, second, condition = () => true) {
const firstIndex = getElementIndex(elements, first);
const firstElement = elements[firstIndex];
const secondIndex = getElementIndex(elements, second);
const secondElement = elements[secondIndex];
if (firstElement &&
secondElement &&
neighborIndexes(firstIndex, secondIndex, elements) &&
condition(secondElement.arguments)) {
context.report({
message,
loc: locFromTwoNodes(firstElement.identifier, secondElement.identifier),
});
}
}
// first element is not applied to second if between them function call (e.g. fist.foo().second())
function neighborIndexes(firstIndex, secondIndex, elements) {
if (firstIndex === secondIndex - 2) {
return !elements[firstIndex + 1].arguments;
}
return firstIndex === secondIndex - 1;
}
function retrieveAssertionChainElements(node) {
let currentNode = node;
const result = [];
let currentArguments = undefined;
while (true) {
if ((0, index_js_1.isDotNotation)(currentNode)) {
result.push({ identifier: currentNode.property, arguments: currentArguments });
currentNode = currentNode.object;
currentArguments = undefined;
}
else if (currentNode.type === 'CallExpression') {
currentArguments = currentNode.arguments;
currentNode = currentNode.callee;
}
else if ((0, index_js_1.isIdentifier)(currentNode)) {
result.push({ identifier: currentNode, arguments: currentArguments });
break;
}
else {
break;
}
}
return result.reverse();
}
function getElementIndex(elements, name) {
return elements.findIndex(element => (0, index_js_1.isIdentifier)(element.identifier, name));
}
function locFromTwoNodes(start, end) {
return {
start: start.loc.start,
end: end.loc.end,
};
}