eslint-plugin-sonarjs
Version:
SonarJS rules for ESLint
148 lines (147 loc) • 6.48 kB
JavaScript
;
/*
* eslint-plugin-sonarjs
* Copyright (C) 2018-2021 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.
*/
// https://sonarsource.github.io/rspec/#/rspec/S1871
var __importDefault = (this && this.__importDefault) || function (mod) {
return (mod && mod.__esModule) ? mod : { "default": mod };
};
const nodes_1 = require("../utils/nodes");
const equivalence_1 = require("../utils/equivalence");
const conditions_1 = require("../utils/conditions");
const locations_1 = require("../utils/locations");
const docs_url_1 = __importDefault(require("../utils/docs-url"));
const message = "This {{type}}'s code block is the same as the block for the {{type}} on line {{line}}.";
const rule = {
defaultOptions: [],
meta: {
messages: {
sameConditionalBlock: message,
sonarRuntime: '{{sonarRuntimeData}}',
},
type: 'problem',
docs: {
description: 'Two branches in a conditional structure should not have exactly the same implementation',
recommended: 'recommended',
url: (0, docs_url_1.default)(__filename),
},
schema: [
{
// internal parameter
type: 'string',
enum: ['sonar-runtime'],
},
],
},
create(context) {
return {
IfStatement(node) {
visitIfStatement(node);
},
SwitchStatement(node) {
visitSwitchStatement(node);
},
};
function visitIfStatement(ifStmt) {
if ((0, nodes_1.isIfStatement)(ifStmt.parent)) {
return;
}
const { branches, endsWithElse } = (0, conditions_1.collectIfBranches)(ifStmt);
if (allEquivalentWithoutDefault(branches, endsWithElse)) {
branches.slice(1).forEach((branch, i) => reportIssue(branch, branches[i], 'branch'));
return;
}
for (let i = 1; i < branches.length; i++) {
if (hasRequiredSize([branches[i]])) {
for (let j = 0; j < i; j++) {
if (compareIfBranches(branches[i], branches[j])) {
break;
}
}
}
}
}
function visitSwitchStatement(switchStmt) {
const { cases } = switchStmt;
const { endsWithDefault } = (0, conditions_1.collectSwitchBranches)(switchStmt);
const nonEmptyCases = cases.filter(c => (0, conditions_1.takeWithoutBreak)(expandSingleBlockStatement(c.consequent)).length > 0);
const casesWithoutBreak = nonEmptyCases.map(c => (0, conditions_1.takeWithoutBreak)(expandSingleBlockStatement(c.consequent)));
if (allEquivalentWithoutDefault(casesWithoutBreak, endsWithDefault)) {
nonEmptyCases
.slice(1)
.forEach((caseStmt, i) => reportIssue(caseStmt, nonEmptyCases[i], 'case'));
return;
}
for (let i = 1; i < cases.length; i++) {
const firstClauseWithoutBreak = (0, conditions_1.takeWithoutBreak)(expandSingleBlockStatement(cases[i].consequent));
if (hasRequiredSize(firstClauseWithoutBreak)) {
for (let j = 0; j < i; j++) {
const secondClauseWithoutBreak = (0, conditions_1.takeWithoutBreak)(expandSingleBlockStatement(cases[j].consequent));
if ((0, equivalence_1.areEquivalent)(firstClauseWithoutBreak, secondClauseWithoutBreak, context.sourceCode)) {
reportIssue(cases[i], cases[j], 'case');
break;
}
}
}
}
}
function hasRequiredSize(nodes) {
if (nodes.length > 0) {
const tokens = [
...context.sourceCode.getTokens(nodes[0]),
...context.sourceCode.getTokens(nodes[nodes.length - 1]),
].filter(token => token.value !== '{' && token.value !== '}');
return (tokens.length > 0 && tokens[tokens.length - 1].loc.end.line > tokens[0].loc.start.line);
}
return false;
}
function compareIfBranches(a, b) {
const equivalent = (0, equivalence_1.areEquivalent)(a, b, context.sourceCode);
if (equivalent && b.loc) {
reportIssue(a, b, 'branch');
}
return equivalent;
}
function expandSingleBlockStatement(nodes) {
if (nodes.length === 1) {
const node = nodes[0];
if ((0, nodes_1.isBlockStatement)(node)) {
return node.body;
}
}
return nodes;
}
function allEquivalentWithoutDefault(branches, endsWithDefault) {
return (!endsWithDefault &&
branches.length > 1 &&
branches
.slice(1)
.every((branch, index) => (0, equivalence_1.areEquivalent)(branch, branches[index], context.sourceCode)));
}
function reportIssue(node, equivalentNode, type) {
const equivalentNodeLoc = equivalentNode.loc;
(0, locations_1.report)(context, {
messageId: 'sameConditionalBlock',
data: { type, line: String(equivalentNode.loc.start.line) },
node,
}, [(0, locations_1.issueLocation)(equivalentNodeLoc, equivalentNodeLoc, 'Original')], message);
}
},
};
module.exports = rule;