sindresorhus/eslint-plugin-unicorn

Create comment utility

Chiusa

#370 aperta il 16 set 2019

Vedi su GitHubGuida contributor
 (3 commenti) (1 reazione) (0 assegnatari)JavaScript (468 fork)user submission
enhancementhelp wanted

Metriche repository

Star
 (5022 stelle)
Metriche merge PR
 (Merge medio 1g 16h) (399 PR mergiate in 30 g)

Descrizione

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.

Guida contributor

Direzione di ricerca
Rivedi la discussione nella PR #225 per il contesto. Esplora l'API di allegazione commenti di ESLint (ad es. `getCommentsBefore`, `getCommentsAfter`). Determina l'approccio migliore: preservare i commenti, spostarli o saltare la correzione. Se si implementa, concentrati su una funzione di utilità che possa essere riutilizzata tra le regole. Altrimenti, aggiungi note di documentazione alla guida di creazione delle regole che spieghino la gestione dei commenti.
Tech stack
javascript
Dominio
toolingdeveloper experience
Tipo issue
Funzionalità
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
3
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
Mezza giornata
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Datata
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Abbastanza chiara
Prerequisiti
ESLint plugin developmentJavaScript ASTComments handling
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
25