eslint-plugin-sonarjs
Version:
SonarJS rules for ESLint
95 lines (94 loc) • 4.07 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/S4144
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 DEFAULT_MIN_LINES = 3;
const message = 'Update this function so that its implementation is not identical to the one on line {{line}}.';
exports.rule = {
meta: (0, index_js_1.generateMeta)(meta_js_1.meta, {
messages: {
identicalFunctions: message,
},
schema: meta_js_1.schema,
}, true),
create(context) {
const functions = [];
const minLines = context.options[0] ?? DEFAULT_MIN_LINES;
return {
FunctionDeclaration(node) {
visitFunction(node);
},
'VariableDeclarator > FunctionExpression, MethodDefinition > FunctionExpression': (node) => {
visitFunction(node);
},
'VariableDeclarator > ArrowFunctionExpression, MethodDefinition > ArrowFunctionExpression': (node) => {
visitFunction(node);
},
'Program:exit'() {
processFunctions();
},
};
function visitFunction(node) {
if (isBigEnough(node.body)) {
functions.push({ function: node, parent: node.parent });
}
}
function processFunctions() {
for (let i = 1; i < functions.length; i++) {
const duplicatingFunction = functions[i].function;
for (let j = 0; j < i; j++) {
const originalFunction = functions[j].function;
if ((0, index_js_1.areEquivalent)(duplicatingFunction.body, originalFunction.body, context.sourceCode) &&
originalFunction.loc) {
const loc = (0, index_js_1.getMainFunctionTokenLocation)(duplicatingFunction, functions[i].parent, context);
const originalFunctionLoc = (0, index_js_1.getMainFunctionTokenLocation)(originalFunction, functions[j].parent, context);
const secondaryLocations = [
(0, index_js_1.toSecondaryLocation)({ loc: originalFunctionLoc }, 'Original implementation'),
];
(0, index_js_1.report)(context, {
message,
data: {
line: originalFunction.loc.start.line,
},
loc,
}, secondaryLocations);
break;
}
}
}
}
function isBigEnough(node) {
const tokens = context.sourceCode.getTokens(node);
if (tokens.length > 0 && tokens[0].value === '{') {
tokens.shift();
}
if (tokens.length > 0 && tokens[tokens.length - 1].value === '}') {
tokens.pop();
}
if (tokens.length > 0) {
const firstLine = tokens[0].loc.start.line;
const lastLine = tokens[tokens.length - 1].loc.end.line;
return lastLine - firstLine + 1 >= minLines;
}
return false;
}
},
};