eslint-plugin-sonarjs
Version:
SonarJS rules for ESLint
101 lines (100 loc) • 4.36 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/S4619/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 index_js_1 = require("../helpers/index.js");
const meta = __importStar(require("./generated-meta.js"));
exports.rule = {
meta: (0, index_js_1.generateMeta)(meta, {
hasSuggestions: true,
messages: {
inMisuse: 'Use "indexOf" or "includes" (available from ES2016) instead.',
suggestIndexOf: 'Replace with "indexOf" method',
suggestIncludes: 'Replace with "includes" method',
},
}),
create(context) {
const services = context.sourceCode.parserServices;
function prototypeProperty(expr) {
if (expr.type !== 'Literal' || typeof expr.value !== 'string') {
return false;
}
return ['indexOf', 'lastIndexOf', 'forEach', 'map', 'filter', 'every', 'some'].includes(expr.value);
}
if ((0, index_js_1.isRequiredParserServices)(services)) {
return {
"BinaryExpression[operator='in']": (node) => {
const { left, right } = node;
if ((0, index_js_1.isArray)(right, services) && !prototypeProperty(left) && !(0, index_js_1.isNumber)(left, services)) {
const leftText = context.sourceCode.getText(left);
const rightText = context.sourceCode.getText(right);
context.report({
messageId: 'inMisuse',
node,
suggest: [
{
messageId: 'suggestIndexOf',
fix: fixer => fixer.replaceText(node, `${rightText}.indexOf(${leftText}) > -1`),
},
{
messageId: 'suggestIncludes',
fix: fixer => fixer.replaceText(node, `${rightText}.includes(${leftText})`),
},
],
});
}
},
};
}
return {};
},
};