eslint-plugin-sonarjs
Version:
SonarJS rules for ESLint
110 lines (109 loc) • 4.26 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/S1529/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 typescript_1 = __importDefault(require("typescript"));
const index_js_1 = require("../helpers/index.js");
const meta_js_1 = require("./meta.js");
const BITWISE_AND_OR = ['&', '|'];
const BITWISE_OPERATORS = [
'&',
'|',
'^',
'~',
'<<',
'>>',
'>>>',
'&=',
'|=',
'^=',
'<<=',
'>>=',
'>>>=',
];
exports.rule = {
meta: (0, index_js_1.generateMeta)(meta_js_1.meta),
create(context) {
const isNumeric = getNumericTypeChecker(context);
let lonelyBitwiseAndOr = null;
let lonelyBitwiseAndOrAncestors = [];
let fileContainsSeveralBitwiseOperations = false;
return {
BinaryExpression(node) {
const expression = node;
if (!lonelyBitwiseAndOr &&
BITWISE_AND_OR.includes(expression.operator) &&
!isNumeric(expression.left) &&
!isNumeric(expression.right)) {
lonelyBitwiseAndOr = expression;
lonelyBitwiseAndOrAncestors = [...context.sourceCode.getAncestors(node)];
}
else if (BITWISE_OPERATORS.includes(expression.operator)) {
fileContainsSeveralBitwiseOperations = true;
}
},
'Program:exit'() {
if (!fileContainsSeveralBitwiseOperations &&
lonelyBitwiseAndOr &&
insideCondition(lonelyBitwiseAndOr, lonelyBitwiseAndOrAncestors)) {
const op = lonelyBitwiseAndOr.operator;
const operatorToken = context.sourceCode.getTokenAfter(lonelyBitwiseAndOr.left);
if (operatorToken) {
context.report({
loc: operatorToken.loc,
message: `Review this use of bitwise "${op}" operator; conditional "${op}${op}" might have been intended.`,
});
}
}
},
};
},
};
function insideCondition(node, ancestors) {
let child = node;
for (let i = ancestors.length - 1; i >= 0; i--) {
const parent = ancestors[i];
if (parent.type === 'IfStatement' ||
parent.type === 'ForStatement' ||
parent.type === 'WhileStatement' ||
parent.type === 'DoWhileStatement' ||
parent.type === 'ConditionalExpression') {
return parent.test === child;
}
child = parent;
}
return false;
}
function getNumericTypeChecker(context) {
const services = context.sourceCode.parserServices;
if (!!services && !!services.program && !!services.esTreeNodeToTSNodeMap) {
return (node) => isNumericType((0, index_js_1.getTypeFromTreeNode)(node, services));
}
else {
const numericTypes = ['number', 'bigint'];
return (node) => node.type === 'Literal' ? numericTypes.includes(typeof node.value) : false;
}
function isNumericType(type) {
return ((type.getFlags() & (typescript_1.default.TypeFlags.NumberLike | typescript_1.default.TypeFlags.BigIntLike)) !== 0 ||
(type.isUnionOrIntersection() && !!type.types.find(isNumericType)));
}
}