sindresorhus/eslint-plugin-unicorn

Inconsistency in rule option names ("checkFoo" vs "ignoreFoo")

Chiusa

#881 aperta il 20 ott 2020

Vedi su GitHubGuida contributor
 (1 commento) (1 reazione) (0 assegnatari)JavaScript (468 fork)user submission
docsenhancementhelp wanted

Metriche repository

Star
 (5022 stelle)
Metriche merge PR
 (Merge medio 4h 30m) (26 PR mergiate in 30 g)

Descrizione

Grepping the docs for "ignore" and "check" I find these option names:

  • With "ignore":
    • expiring-todo-comments:
      • ignoreDatesOnPullRequests
    • import-index:
      • ignoreImports
  • With "check":
    • prevent-abbreviations:
      • checkDefaultAndNamespaceImports
      • checkShorthandImports
      • checkProperties
      • checkDefaultAndNamespaceImports
      • checkVariables
      • checkFilenames
    • no-null:
      • checkStrictEquality
    • import-style:
      • checkImport
      • checkDynamicImport
      • checkExportFrom
      • checkRequire
    • no-keyword-prefix:
      • checkProperties

The "check" names seem to win for now, so I think all new options should be named like "checkFoo" instead of "ignoreFoo". Not sure should we and how to automatically enforce this, maybe with a prevent-abbreviations replacement.

Guida contributor

Direzione di ricerca
Rivedi le opzioni delle regole elencate nell'issue, quindi esamina il codice sorgente di ciascuna regola (ad es. rules/prevent abbreviations.js, rules/no null.js) per identificare tutte le occorrenze dei prefissi 'check' e 'ignore'. Determina la convenzione preferita (checkFoo) e rinomina di conseguenza tutte le opzioni 'ignoreFoo'. Aggiorna la documentazione per ciascuna regola. Considera l'uso di un codemod per automatizzare la rinomina per gli utenti. Nessun PR collegato o commenti che indichino lavori in corso.
Tech stack
javascriptnodejs
Dominio
toolingdeveloper experience
Tipo issue
Refactoring
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 developmentknowledge of unicorn rules
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
30