OpenZeppelin/openzeppelin-contracts

Consider adding an ESLint rule for no async in describe blocks

Open

#4 943 ouverte le 6 mars 2024

Voir sur GitHub
 (6 commentaires) (0 réactions) (0 assignés)JavaScript (11 560 forks)batch import
good first issuetests

Métriques du dépôt

Stars
 (23 941 stars)
Métriques de merge PR
 (Merge moyen 42j 15h) (16 PRs mergées en 30 j)

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.

Guide contributeur

Direction de recherche
Installez eslint plugin mocha et ajoutez la règle 'no async describe' à la configuration ESLint.
Stack technique
javascript
Domaine
developer experiencetooling
Type d'issue
Maintenance
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
1
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
Moins d'une heure
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Active
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Claire
Prérequis
javascript
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
90