181 lines
3.9 KiB
JavaScript
181 lines
3.9 KiB
JavaScript
import {findVariable} from '@eslint-community/eslint-utils';
|
|
import {getVariableIdentifiers} from './utils/index.js';
|
|
import {isCallOrNewExpression, isMethodCall} from './ast/index.js';
|
|
|
|
const MESSAGE_ID_ERROR = 'error';
|
|
const MESSAGE_ID_SUGGESTION = 'suggestion';
|
|
const messages = {
|
|
[MESSAGE_ID_ERROR]: '`{{name}}` should be a `Set`, and use `{{name}}.has()` to check existence or non-existence.',
|
|
[MESSAGE_ID_SUGGESTION]: 'Switch `{{name}}` to `Set`.',
|
|
};
|
|
|
|
const arrayMethodsReturnsArray = [
|
|
'concat',
|
|
'copyWithin',
|
|
'fill',
|
|
'filter',
|
|
'flat',
|
|
'flatMap',
|
|
'map',
|
|
'reverse',
|
|
'slice',
|
|
'sort',
|
|
'splice',
|
|
'toReversed',
|
|
'toSorted',
|
|
'toSpliced',
|
|
'with',
|
|
];
|
|
|
|
const isIncludesCall = node =>
|
|
isMethodCall(node.parent.parent, {
|
|
method: 'includes',
|
|
optionalCall: false,
|
|
optionalMember: false,
|
|
argumentsLength: 1,
|
|
})
|
|
&& node.parent.object === node;
|
|
|
|
const multipleCallNodeTypes = new Set([
|
|
'ForOfStatement',
|
|
'ForStatement',
|
|
'ForInStatement',
|
|
'WhileStatement',
|
|
'DoWhileStatement',
|
|
'FunctionDeclaration',
|
|
'FunctionExpression',
|
|
'ArrowFunctionExpression',
|
|
]);
|
|
|
|
const isMultipleCall = (identifier, node) => {
|
|
const root = node.parent.parent.parent;
|
|
let {parent} = identifier.parent; // `.include()` callExpression
|
|
while (
|
|
parent
|
|
&& parent !== root
|
|
) {
|
|
if (multipleCallNodeTypes.has(parent.type)) {
|
|
return true;
|
|
}
|
|
|
|
parent = parent.parent;
|
|
}
|
|
|
|
return false;
|
|
};
|
|
|
|
/** @param {import('eslint').Rule.RuleContext} context */
|
|
const create = context => ({
|
|
Identifier(node) {
|
|
const {parent} = node;
|
|
|
|
if (!(
|
|
parent.type === 'VariableDeclarator'
|
|
&& parent.id === node
|
|
&& Boolean(parent.init)
|
|
&& parent.parent.type === 'VariableDeclaration'
|
|
&& parent.parent.declarations.includes(parent)
|
|
// Exclude `export const foo = [];`
|
|
&& !(
|
|
parent.parent.parent.type === 'ExportNamedDeclaration'
|
|
&& parent.parent.parent.declaration === parent.parent
|
|
)
|
|
&& (
|
|
// `[]`
|
|
parent.init.type === 'ArrayExpression'
|
|
// `Array()` and `new Array()`
|
|
|| isCallOrNewExpression(parent.init, {
|
|
name: 'Array',
|
|
optional: false,
|
|
})
|
|
// `Array.from()` and `Array.of()`
|
|
|| isMethodCall(parent.init, {
|
|
object: 'Array',
|
|
methods: ['from', 'of'],
|
|
optionalCall: false,
|
|
optionalMember: false,
|
|
})
|
|
// Array methods that return an array
|
|
|| isMethodCall(parent.init, {
|
|
methods: arrayMethodsReturnsArray,
|
|
optionalCall: false,
|
|
optionalMember: false,
|
|
})
|
|
)
|
|
)) {
|
|
return;
|
|
}
|
|
|
|
const variable = findVariable(context.sourceCode.getScope(node), node);
|
|
|
|
// This was reported https://github.com/sindresorhus/eslint-plugin-unicorn/issues/1075#issuecomment-768073342
|
|
// But can't reproduce, just ignore this case
|
|
/* c8 ignore next 3 */
|
|
if (!variable) {
|
|
return;
|
|
}
|
|
|
|
const identifiers = getVariableIdentifiers(variable).filter(identifier => identifier !== node);
|
|
|
|
if (
|
|
identifiers.length === 0
|
|
|| identifiers.some(identifier => !isIncludesCall(identifier))
|
|
) {
|
|
return;
|
|
}
|
|
|
|
if (
|
|
identifiers.length === 1
|
|
&& identifiers.every(identifier => !isMultipleCall(identifier, node))
|
|
) {
|
|
return;
|
|
}
|
|
|
|
const problem = {
|
|
node,
|
|
messageId: MESSAGE_ID_ERROR,
|
|
data: {
|
|
name: node.name,
|
|
},
|
|
};
|
|
|
|
const fix = function * (fixer) {
|
|
yield fixer.insertTextBefore(node.parent.init, 'new Set(');
|
|
yield fixer.insertTextAfter(node.parent.init, ')');
|
|
|
|
for (const identifier of identifiers) {
|
|
yield fixer.replaceText(identifier.parent.property, 'has');
|
|
}
|
|
};
|
|
|
|
if (node.typeAnnotation) {
|
|
problem.suggest = [
|
|
{
|
|
messageId: MESSAGE_ID_SUGGESTION,
|
|
fix,
|
|
},
|
|
];
|
|
} else {
|
|
problem.fix = fix;
|
|
}
|
|
|
|
return problem;
|
|
},
|
|
});
|
|
|
|
/** @type {import('eslint').Rule.RuleModule} */
|
|
const config = {
|
|
create,
|
|
meta: {
|
|
type: 'suggestion',
|
|
docs: {
|
|
description: 'Prefer `Set#has()` over `Array#includes()` when checking for existence or non-existence.',
|
|
recommended: 'unopinionated',
|
|
},
|
|
fixable: 'code',
|
|
hasSuggestions: true,
|
|
messages,
|
|
},
|
|
};
|
|
|
|
export default config;
|