eslint-plugin-sonarjs
Version:
SonarJS rules for ESLint
106 lines (105 loc) • 3.87 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/S3796/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 = `Add a "return" statement to this callback.`;
const methodsWithCallback = [
'every',
'filter',
'find',
'findLast',
'findIndex',
'findLastIndex',
'map',
'flatMap',
'reduce',
'reduceRight',
'some',
'sort',
'toSorted',
];
function hasCallBackWithoutReturn(argument, services) {
const checker = services.program.getTypeChecker();
const type = checker.getTypeAtLocation(services.esTreeNodeToTSNodeMap.get(argument));
const signatures = type.getCallSignatures();
return (signatures.length > 0 &&
signatures.every(sig => checker.typeToString(sig.getReturnType()) === 'void'));
}
exports.rule = {
meta: (0, index_js_1.generateMeta)(meta_js_1.meta),
create(context) {
const services = context.sourceCode.parserServices;
if (!(0, index_js_1.isRequiredParserServices)(services)) {
return {};
}
return {
'CallExpression[callee.type="MemberExpression"]'(node) {
const callExpression = node;
const args = callExpression.arguments;
const memberExpression = callExpression.callee;
const { object } = memberExpression;
const propName = extractPropName(memberExpression);
if (propName === null || args.length === 0) {
return;
}
if (methodsWithCallback.includes(propName) &&
((0, index_js_1.isArray)(object, services) || (0, index_js_1.isTypedArray)(object, services)) &&
hasCallBackWithoutReturn(args[0], services)) {
context.report({
message,
...getNodeToReport(args[0], node, context),
});
}
else if ((0, index_js_1.isMemberExpression)(callExpression.callee, 'Array', 'from') &&
args.length > 1 &&
hasCallBackWithoutReturn(args[1], services)) {
context.report({
message,
...getNodeToReport(args[1], node, context),
});
}
},
};
},
};
function extractPropName(memberExpression) {
if ((0, index_js_1.isDotNotation)(memberExpression)) {
return memberExpression.property.name;
}
else if ((0, index_js_1.isIndexNotation)(memberExpression)) {
return memberExpression.property.value;
}
else {
return null;
}
}
function getNodeToReport(node, parent, context) {
if (node.type === 'FunctionDeclaration' ||
node.type === 'FunctionExpression' ||
node.type === 'ArrowFunctionExpression') {
return {
loc: (0, index_js_1.getMainFunctionTokenLocation)(node, parent, context),
};
}
return {
node,
};
}