sindresorhus/eslint-plugin-unicorn

prevent-abbreviations: when multiple replacements are defined, suggest each through ESLint's suggest API

Geschlossen

#767 geöffnet am 03.06.2020

Auf GitHub ansehenContributor Guide
 (4 Kommentare) (3 Reaktionen) (0 zugewiesene Personen)JavaScript (468 Forks)user submission
enhancementhelp wanted

Repository-Metriken

Stars
 (5.022 Sterne)
PR-Merge-Metriken
 (Durchschn. Merge 4h 30m) (26 gemergte PRs in 30 T)

Beschreibung

Currently, the prevent-abbreviations autofixer only applies when there is only a single replacement defined. But when multiple replacements are there (if the abbreviation is ambiguous) the violation has to be fixed manually.

It would be nice if the replacements were all suggested to the user in the editor/IDE to pick from. ESLint has the suggest API for this: https://eslint.org/docs/developer-guide/working-with-rules#providing-suggestions

Contributor Guide

Research-Richtung
Untersuche die aktuelle Implementierung der `prevent abbreviations` Regel in eslint plugin unicorn, um zu verstehen, wie sie Ersetzungen behandelt. Implementiere dann die ESLint Vorschlags API (https://eslint.org/docs/developer guide/working with rules#providing suggestions), um jeden möglichen Ersatz als Vorschlag anzubieten, wenn mehrere Ersetzungen für eine Abkürzung definiert sind. Siehe die Issue Diskussion und den Quellcode der Regel.
Tech Stack
javascript
Domain
developer experiencetooling
Issue Type
Funktion
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
3
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
1-3 Stunden
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Veraltet
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Meist klar
Voraussetzungen
familiarity with ESLint plugin developmentunderstanding of suggestion API
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
40