sindresorhus/eslint-plugin-unicorn

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

Fechada

#881 aberto em 20 de out. de 2020

Ver no GitHubGuia do colaborador
 (1 comentário) (1 reação) (0 responsável)JavaScript (468 forks)user submission
docsenhancementhelp wanted

Métricas do repositório

Stars
 (5.022 estrelas)
Métricas de merge de PR
 (Mesclagem média 1d 16h) (399 fundiu PRs em 30d)

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.

Guia do colaborador

Direção de pesquisa
Revise as opções de regra listadas na issue, em seguida, examine o código fonte de cada regra (por exemplo, rules/prevent abbreviations.js, rules/no null.js) para identificar todas as ocorrências dos prefixos 'check' e 'ignore'. Determine a convenção preferida (checkFoo) e renomeie todas as opções 'ignoreFoo' de acordo. Atualize a documentação de cada regra. Considere usar um codemod para automatizar a renomeação para os usuários. Nenhum PR vinculado ou comentários indicando trabalho em andamento.
Pilha de tecnologia
javascriptnodejs
Domain
toolingdeveloper experience
Tipo Issue
Refatoração
DifficultyDificuldade de implementação estimada para um novo contribuidor, de 1 para alterações muito pequenas a 5 para trabalho de nível especializado.
3
Tempo estimadoUm intervalo de tempo aproximado para um colaborador experiente investigar, implementar, testar e preparar um pull request.
Meio dia
Status da atividadeQuão disponível o issue aparece agora: novo, ativo, obsoleto, bloqueado ou aguardando entrada do mantenedor.
Antigo
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
Principalmente claro
Prerequisites
ESLint plugin developmentknowledge of unicorn rules
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
30