Rule proposal: `proper-object-iterable-methods`

Métriques du dépôt

Stars

5 022 étoiles (5 022 étoiles)

Métriques de merge PR

Merge moyen 4h 30m (Merge moyen 4h 30m)26 PRs mergées en 30 j (26 PRs mergées en 30 j)

Description

// Should use `Object.values`
for (const key of Object.keys(foo)) {
	bar(foo[key]);
}

// Should use `Object.entries`
for (const key of Object.keys(foo)) {
	bar(foo[key], key);
}

// Should use `Object.values`
const foo = Object.keys(bar).map(key => baz(bar[key]));

// Should use `Object.entries`
const foo = Object.keys(bar).map(key => baz(bar[key], key));

// Should use `Object.keys`
for (const [key] of Object.entries(foo)) {
	bar(key);
}

for (const key of Object.keys(foo)) {
	foo[key] = 'new value';
	delete foo[key];
	foo[key]++;
}

Guide contributeur

Direction de recherche

Tout d'abord, examinez les règles existantes dans eslint plugin unicorn (par exemple `prefer object spread`) pour comprendre la structure des règles et les helpers AST. La nouvelle règle doit détecter des motifs comme `for (const key of Object.keys(foo)) { bar(foo[key]); }` et suggérer `for (const value of Object.values(foo)) { bar(value); }`. Détectez également `Object.keys().map()` et suggérez `Object.values()` ou `Object.entries()`. Pour le cas inverse, détectez `Object.entries()` utilisé uniquement pour les clés et suggérez `Object.keys()`. Les cas limites incluent des mutations comme l'assignation ou delete sur `foo[key]`, qui ne doivent pas déclencher la règle. Implémentez l'auto fix lorsque c'est sûr. Écrivez des tests couvrant tous les exemples d'échec et de réussite de l'issue.

Stack technique

javascript

Domaine

developer experiencetooling

Type d'issue

Fonctionnalité

DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.

3

Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.

1-2 jours

Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.

Ancienne

ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.

Claire

Prérequis

ESLint plugin developmentAST knowledgeJavaScript

Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.

60