eslint-plugin-sonarjs
Version:
SonarJS rules for ESLint
101 lines (100 loc) • 3.98 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/S6079/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");
exports.rule = {
meta: (0, index_js_1.generateMeta)(meta_js_1.meta, undefined, true),
create(context) {
let currentDoneVariable;
let doneCall;
let doneSegment;
let currentSegment;
let currentCase;
const segmentFirstStatement = new Map();
function checkForTestCase(node) {
const testCase = index_js_1.Mocha.extractTestCase(node);
if (!testCase) {
return;
}
currentCase = testCase;
currentDoneVariable = undefined;
if (testCase.callback.params.length === 0) {
return;
}
const [done] = testCase.callback.params;
if (done.type !== 'Identifier') {
return;
}
const callbackScope = context.sourceCode
.getScope(node)
.childScopes.find(scope => scope.block === testCase.callback);
if (!callbackScope) {
return;
}
currentDoneVariable = (0, index_js_1.getVariableFromIdentifier)(done, callbackScope);
}
function checkForDoneCall(node) {
const { callee } = node;
if (currentDoneVariable?.references.some(ref => ref.identifier === callee)) {
doneCall = node;
doneSegment = currentSegment;
}
}
function report(statementAfterDone) {
(0, index_js_1.report)(context, {
node: statementAfterDone,
message: `Move this code before the call to "done".`,
}, [(0, index_js_1.toSecondaryLocation)(doneCall)]);
doneSegment = undefined;
doneCall = undefined;
currentDoneVariable = undefined;
}
return {
CallExpression: (node) => {
checkForTestCase(node);
checkForDoneCall(node);
},
ExpressionStatement: (node) => {
if (currentSegment && currentSegment === doneSegment) {
report(node);
}
if (currentSegment && !segmentFirstStatement.has(currentSegment)) {
segmentFirstStatement.set(currentSegment, node);
}
},
onCodePathSegmentStart(segment) {
currentSegment = segment;
},
onCodePathEnd(_codePath, node) {
currentSegment = undefined;
if (currentCase?.callback === node && doneSegment) {
// we report an issue if one of 'doneSegment.nextSegments' is not empty
const statementAfterDone = doneSegment.nextSegments
.map(segment => segmentFirstStatement.get(segment))
.find(stmt => !!stmt);
if (statementAfterDone) {
report(statementAfterDone);
}
}
},
};
},
};