eslint-plugin-sonarjs
Version:
128 lines (127 loc) • 5.4 kB
JavaScript
;
/*
* SonarQube JavaScript Plugin
* Copyright (C) SonarSource Sàrl
* mailto:info AT sonarsource DOT com
*
* You can redistribute and/or modify this program under the terms of
* the Sonar Source-Available License Version 1, as published by SonarSource Sàrl.
*
* 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/S3735/javascript
var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
if (k2 === undefined) k2 = k;
var desc = Object.getOwnPropertyDescriptor(m, k);
if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
desc = { enumerable: true, get: function() { return m[k]; } };
}
Object.defineProperty(o, k2, desc);
}) : (function(o, m, k, k2) {
if (k2 === undefined) k2 = k;
o[k2] = m[k];
}));
var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
Object.defineProperty(o, "default", { enumerable: true, value: v });
}) : function(o, v) {
o["default"] = v;
});
var __importStar = (this && this.__importStar) || (function () {
var ownKeys = function(o) {
ownKeys = Object.getOwnPropertyNames || function (o) {
var ar = [];
for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
return ar;
};
return ownKeys(o);
};
return function (mod) {
if (mod && mod.__esModule) return mod;
var result = {};
if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
__setModuleDefault(result, mod);
return result;
};
})();
Object.defineProperty(exports, "__esModule", { value: true });
exports.rule = void 0;
const expect_call_chain_js_1 = require("../helpers/expect-call-chain.js");
const generate_meta_js_1 = require("../helpers/generate-meta.js");
const parser_services_js_1 = require("../helpers/parser-services.js");
const type_js_1 = require("../helpers/type.js");
const meta = __importStar(require("./generated-meta.js"));
exports.rule = {
meta: (0, generate_meta_js_1.generateMeta)(meta, {
messages: {
removeVoid: 'Remove this use of the "void" operator.',
},
}),
create(context) {
return {
'UnaryExpression[operator="void"]': (node) => {
const unaryExpression = node;
if (isVoid0(unaryExpression) ||
isIIFE(unaryExpression) ||
isPromiseLike(context, unaryExpression)) {
return;
}
const operatorToken = context.sourceCode.getTokenBefore(unaryExpression.argument);
context.report({
loc: operatorToken.loc, // cannot be null due to previous checks
messageId: 'removeVoid',
});
},
};
},
};
function isVoid0(expr) {
return expr.argument.type === 'Literal' && expr.argument.value === 0;
}
function isIIFE(expr) {
return (expr.argument.type === 'CallExpression' &&
['ArrowFunctionExpression', 'FunctionExpression'].includes(expr.argument.callee.type));
}
function isPromiseLike(context, expr) {
const services = context.sourceCode.parserServices;
if ((0, parser_services_js_1.isRequiredParserServices)(services)) {
return ((0, type_js_1.isThenableOrVoidUnion)(expr.argument, services) ||
(isShortCircuitExpression(expr.argument) &&
(0, type_js_1.isThenableOrGuardUnion)(expr.argument, services)) ||
(isCallLikeExpression(expr.argument) && hasIndeterminateType(expr.argument, services)));
}
else {
// No type info: treat any call-like expression as a possible promise and don't raise.
return isCallLikeExpression(expr.argument);
}
}
/**
* Returns true when `node` is a short-circuit expression whose result depends on a guard.
* @param node The expression used with `void`.
* @return Whether the expression is a logical (`||`, `&&`, `??`) or conditional (`?:`) expression.
*/
function isShortCircuitExpression(node) {
return node.type === 'LogicalExpression' || node.type === 'ConditionalExpression';
}
/**
* Returns true when `node` is a direct call or an optionally chained call.
* @param node The expression used with `void`.
* @return Whether the expression has a callable shape.
*/
function isCallLikeExpression(node) {
return (0, expect_call_chain_js_1.unwrapChainExpression)(node).type === 'CallExpression';
}
/**
* Returns true when TypeScript cannot determine whether `node` resolves to a promise.
* @param node The expression used with `void`.
* @param services The TypeScript parser services.
* @return Whether the resolved type is `any` or `unknown`.
*/
function hasIndeterminateType(node, services) {
return (0, type_js_1.isAnyOrUnknownType)((0, type_js_1.getTypeFromTreeNode)(node, services));
}