eslint-plugin-sonarjs
Version:
SonarJS rules for ESLint
84 lines (83 loc) • 3.54 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/S4324/javascript
var __importDefault = (this && this.__importDefault) || function (mod) {
return (mod && mod.__esModule) ? mod : { "default": mod };
};
Object.defineProperty(exports, "__esModule", { value: true });
exports.rule = void 0;
const index_js_1 = require("../helpers/index.js");
const typescript_1 = __importDefault(require("typescript"));
const meta_js_1 = require("./meta.js");
exports.rule = {
meta: (0, index_js_1.generateMeta)(meta_js_1.meta, {
messages: {
removeOrChangeType: 'Remove this return type or change it to a more specific.',
},
}),
create(context) {
const services = context.sourceCode.parserServices;
if ((0, index_js_1.isRequiredParserServices)(services)) {
const returnedExpressions = [];
return {
ReturnStatement(node) {
if (returnedExpressions.length > 0) {
returnedExpressions[returnedExpressions.length - 1].push(node.argument);
}
},
FunctionDeclaration() {
returnedExpressions.push([]);
},
'FunctionDeclaration:exit'(node) {
const returnType = node.returnType;
if (returnType &&
returnType.typeAnnotation.type === 'TSAnyKeyword' &&
returnedExpressions.length > 0 &&
allReturnTypesEqual(returnedExpressions[returnedExpressions.length - 1], services)) {
context.report({
messageId: 'removeOrChangeType',
loc: returnType.loc,
});
}
returnedExpressions.pop();
},
};
}
return {};
},
};
function allReturnTypesEqual(returns, services) {
const firstReturnType = getTypeFromTreeNode(returns.pop(), services);
if (!!firstReturnType && !!isPrimitiveType(firstReturnType)) {
return returns.every(nextReturn => {
const nextReturnType = getTypeFromTreeNode(nextReturn, services);
return !!nextReturnType && nextReturnType.flags === firstReturnType.flags;
});
}
return false;
}
function getTypeFromTreeNode(node, services) {
const checker = services.program.getTypeChecker();
return checker.getTypeAtLocation(services.esTreeNodeToTSNodeMap.get(node));
}
function isPrimitiveType({ flags }) {
return (flags & typescript_1.default.TypeFlags.BooleanLike ||
flags & typescript_1.default.TypeFlags.NumberLike ||
flags & typescript_1.default.TypeFlags.StringLike ||
flags & typescript_1.default.TypeFlags.EnumLike);
}