eslint-plugin-sonarjs
Version:
SonarJS rules for ESLint
60 lines (59 loc) • 2.35 kB
JavaScript
;
/*
* SonarQube JavaScript Plugin
* Copyright (C) 2011-2024 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 GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 3 of the License, or (at your option) any later version.
*
* 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 GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with this program; if not, write to the Free Software Foundation,
* Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
*/
// https://sonarsource.github.io/rspec/#/rspec/S2692/javascript
Object.defineProperty(exports, "__esModule", { value: true });
exports.rule = void 0;
const helpers_1 = require("../helpers");
const meta_1 = require("./meta");
exports.rule = {
meta: (0, helpers_1.generateMeta)(meta_1.meta, {
messages: {
considerIncludes: "This check ignores index 0; consider using 'includes' method to make this check safe and explicit.",
},
}),
create(context) {
const services = context.sourceCode.parserServices;
if (!(0, helpers_1.isRequiredParserServices)(services)) {
return {};
}
return {
BinaryExpression(node) {
const expression = node;
if (expression.operator === '>' &&
isZero(expression.right) &&
isArrayIndexOfCall(expression.left, services)) {
context.report({ node, messageId: 'considerIncludes' });
}
},
};
},
};
function isZero(node) {
return node.type === 'Literal' && node.value === 0;
}
function isArrayIndexOfCall(node, services) {
return (node.type === 'CallExpression' &&
node.arguments.length === 1 &&
node.callee.type === 'MemberExpression' &&
node.callee.property.type === 'Identifier' &&
node.callee.property.name === 'indexOf' &&
(0, helpers_1.isArray)(node.callee.object, services));
}