sindresorhus/eslint-plugin-unicorn

Create comment utility

Geschlossen

#370 geöffnet am 16.09.2019

Auf GitHub ansehenContributor Guide
 (3 Kommentare) (1 Reaktion) (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

See discussion here: https://github.com/sindresorhus/eslint-plugin-unicorn/pull/225#discussion_r294262451

We need to make handling comments easier. The current suggestions are:

  1. Comments should be preserved (may be non-trivial)
  2. Comments should be moved above a suitable node
  3. Do not fix if comments are detected

At the very least, we should add some notes in our documentation around creating rules since this comes up frequently.

Contributor Guide

Research-Richtung
Überprüfe die Diskussion in PR #225 für den Hintergrund. Erkunde die Kommentar Anhänge API von ESLint (z.B. `getCommentsBefore`, `getCommentsAfter`). Bestimme den besten Ansatz: Kommentare erhalten, verschieben oder das Beheben überspringen. Falls implementiert, konzentriere dich auf eine Hilfsfunktion, die über Regeln hinweg wiederverwendet werden kann. Andernfalls füge der Regel Erstellungsanleitung Dokumentationshinweise hinzu, die den Umgang mit Kommentaren erklären.
Tech Stack
javascript
Domain
toolingdeveloper experience
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.
Halber Tag
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
ESLint plugin developmentJavaScript ASTComments handling
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
25