OpenZeppelin/openzeppelin-contracts

Consider adding an ESLint rule for no async in describe blocks

Open

#4.943 aberto em 6 de mar. de 2024

Ver no GitHub
 (6 comments) (0 reactions) (0 assignees)JavaScript (11.560 forks)batch import
good first issuetests

Métricas do repositório

Stars
 (23.941 stars)
Métricas de merge de PR
 (Mesclagem média 42d 15h) (16 fundiu PRs em 30d)

Description

From @fvictorio:

I forgot to mention:

  • The wrong async keywords in describe functions can be prevented with this rule.
  • The missing await keywords are harder. Ideally you'd use typescript and the no-floating-promises rule, but I understand that that would be a huge undertaking.

Originally posted by @fvictorio in https://github.com/OpenZeppelin/openzeppelin-contracts/issues/4942#issuecomment-1980874051

We're considering adding only the ESLint rule and not migrating to Typescript to catch floating promises. However, we're open to alternatives.

Guia do colaborador

Direção de pesquisa
Instale o eslint plugin mocha e adicione a regra 'no async describe' à configuração do ESLint.
Pilha de tecnologia
javascript
Domain
developer experiencetooling
Tipo Issue
Manutençã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.
1
Tempo estimadoUm intervalo de tempo aproximado para um colaborador experiente investigar, implementar, testar e preparar um pull request.
Menos de 1 hora
Status da atividadeQuão disponível o issue aparece agora: novo, ativo, obsoleto, bloqueado ou aguardando entrada do mantenedor.
Ativo
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
Claro
Prerequisites
javascript
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
90