sindresorhus/eslint-plugin-unicorn

prevent-abbreviations renames parameter, but not reference to parameter in type guard signature

Geschlossen

#765 geöffnet am 02.06.2020

Auf GitHub ansehenContributor Guide
 (3 Kommentare) (1 Reaktion) (0 zugewiesene Personen)JavaScript (468 Forks)user submission
bughelp wanted

Repository-Metriken

Stars
 (5.022 Sterne)
PR-Merge-Metriken
 (Durchschn. Merge 1T 16h) (399 gemergte PRs in 30 T)

Beschreibung

Repro:

const isString = (val: unknown): val is string => typeof val === 'string'

gets autofixed to

const isString = (value: unknown): val is string => typeof value === 'string'

which no longer compiles because the signature still mentions val.

Contributor Guide

Research-Richtung
Das Problem meldet, dass die Regel `prevent abbreviations` den Parameter `val` im Funktionskörper fälschlicherweise in `value` umbenennt, aber den Parameter in der Type Guard Signatur unverändert lässt, was zu einem Kompilierungsfehler führt. Zur Behebung suchen Sie die Quelldatei der Regel (wahrscheinlich in `rules/prevent abbreviations.js` oder `.ts`). Die Korrektur sollte sicherstellen, dass beim Umbenennen eines Parameters alle Referenzen in der Funktionssignatur, einschließlich Type Predicates, aktualisiert werden. Überprüfen Sie die Implementierung der Parameterumbenennung in der Regel und erwägen Sie die Verwendung von AST Traversal, um alle Bezeichner in der Type Guard Signatur zu ersetzen. Prüfen Sie vorhandene Tests auf ähnliche Fälle und fügen Sie einen Testfall für Type Guard Parameter hinzu.
Tech Stack
javascripttypescriptnodejs
Domain
tooling
Issue Type
Fehler
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
Basic understanding of ESLintFamiliarity with TypeScript type guards
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
55