eslint-plugin-sonarjs
Version:
SonarJS rules for ESLint
71 lines (70 loc) • 2.53 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/S4139/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, {
messages: {
useForOf: 'Use "for...of" to iterate over this "{{iterable}}".',
},
}),
create(context) {
const services = context.sourceCode.parserServices;
if (!(0, index_js_1.isRequiredParserServices)(services)) {
return {};
}
return {
ForInStatement: (node) => {
const type = (0, index_js_1.getTypeFromTreeNode)(node.right, services);
if (isIterable(type)) {
const iterable = type.symbol ? type.symbol.name : 'String';
context.report({
messageId: 'useForOf',
data: { iterable },
loc: context.sourceCode.getFirstToken(node).loc,
});
}
},
};
function isIterable(type) {
return isCollection(type) || (0, index_js_1.isStringType)(type) || (0, index_js_1.isArrayLikeType)(type, services);
}
},
};
function isCollection(type) {
return (type.symbol !== undefined &&
[
'Array',
'Int8Array',
'Uint8Array',
'Uint8ClampedArray',
'Int16Array',
'Uint16Array',
'Int32Array',
'Uint32Array',
'Float32Array',
'Float64Array',
'BigInt64Array',
'BigUint64Array',
'Set',
'Map',
].includes(type.symbol.name));
}