sindresorhus/eslint-plugin-unicorn

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

Open

#881 ouverte le 20 oct. 2020

Voir sur GitHub
 (1 commentaire) (1 réaction) (0 assignés)JavaScript (5 022 stars) (468 forks)user submission
docsenhancementhelp wanted

Description

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.

Guide contributeur

Stack technique
javascriptnodejs
Domaine
toolingdeveloper experience
Type d'issue
refactor
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
3
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
half day
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
stale
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
mostly clear
Prérequis
ESLint plugin developmentknowledge of unicorn rules
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
30
Direction de recherche
Review the rule options listed in the issue, then examine the source code of each rule (e.g., rules/prevent abbreviations.js, rules/no null.js) to identify all occurrences of 'check' and 'ignore' prefixes. Determine the preferred convention (checkFoo) and rename all 'ignoreFoo' options accordingly. Update the documentation for each rule. Consider using a codemod to automate renaming for users. No linked PRs or comments indicating ongoing work.