sindresorhus/eslint-plugin-unicorn

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

Fermée

#881 ouverte le 20 oct. 2020

Voir sur GitHubGuide contributeur
 (1 commentaire) (1 réaction) (0 personne assignée)JavaScript (468 forks)user submission
docsenhancementhelp wanted

Métriques du dépôt

Stars
 (5 022 étoiles)
Métriques de merge PR
 (Merge moyen 4h 30m) (26 PRs mergées en 30 j)

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

Direction de recherche
Examinez les options de règle listées dans l'issue, puis examinez le code source de chaque règle (par exemple, rules/prevent abbreviations.js, rules/no null.js) pour identifier toutes les occurrences des préfixes 'check' et 'ignore'. Déterminez la convention préférée (checkFoo) et renommez toutes les options 'ignoreFoo' en conséquence. Mettez à jour la documentation pour chaque règle. Envisagez d'utiliser un codemod pour automatiser le renommage pour les utilisateurs. Aucune PR liée ou commentaires indiquant un travail en cours.
Stack technique
javascriptnodejs
Domaine
toolingdeveloper experience
Type d'issue
Refactorisation
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.
Une demi journée
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Ancienne
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Plutôt claire
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