eslint-plugin-sonarjs
Version:
SonarJS rules for ESLint
116 lines (115 loc) • 4.23 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/S4634/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, {
hasSuggestions: true,
messages: {
promiseAction: 'Replace this trivial promise with "Promise.{{action}}".',
suggestPromiseAction: 'Replace with "Promise.{{action}}"',
},
}),
create(context) {
return {
NewExpression: (node) => {
const newExpr = node;
const executor = getPromiseExecutor(newExpr, context);
if (executor) {
checkExecutor(newExpr, executor, context);
}
},
};
},
};
function getPromiseExecutor(node, context) {
if (node.callee.type === 'Identifier' &&
context.sourceCode.getText(node.callee) === 'Promise' &&
node.arguments.length === 1) {
return node.arguments[0];
}
return undefined;
}
function checkExecutor(newExpr, executor, context) {
if (!(0, index_js_1.isFunctionNode)(executor)) {
return;
}
const { params, body } = executor;
const [resolveParameterDeclaration, rejectParameterDeclaration] = params;
const resolveParameterName = getParameterName(resolveParameterDeclaration);
const rejectParameterName = getParameterName(rejectParameterDeclaration);
const bodyExpression = getOnlyBodyExpression(body);
if (bodyExpression && bodyExpression.type === 'CallExpression') {
const { callee, arguments: args } = bodyExpression;
if (callee.type === 'Identifier') {
const action = getPromiseAction(callee.name, resolveParameterName, rejectParameterName);
if (action && args.length === 1) {
context.report({
messageId: 'promiseAction',
data: {
action,
},
node: newExpr.callee,
suggest: [
{
messageId: 'suggestPromiseAction',
data: {
action,
},
fix: fixer => {
const argText = context.sourceCode.getText(args[0]);
return fixer.replaceText(newExpr, `Promise.${action}(${argText})`);
},
},
],
});
}
}
}
}
function getOnlyBodyExpression(node) {
let bodyExpression;
if (node.type === 'BlockStatement') {
if (node.body.length === 1) {
const statement = node.body[0];
if (statement.type === 'ExpressionStatement') {
bodyExpression = statement.expression;
}
}
}
else {
bodyExpression = node;
}
return bodyExpression;
}
function getPromiseAction(callee, resolveParameterName, rejectParameterName) {
switch (callee) {
case resolveParameterName:
return 'resolve';
case rejectParameterName:
return 'reject';
default:
return undefined;
}
}
function getParameterName(node) {
return node && node.type === 'Identifier' ? node.name : undefined;
}
;