OpenZeppelin/openzeppelin-contracts

Consider adding an ESLint rule for no async in describe blocks

Open

#4.943 geöffnet am 6. März 2024

Auf GitHub ansehen
 (6 Kommentare) (0 Reaktionen) (0 zugewiesene Personen)JavaScript (11.560 Forks)batch import
good first issuetests

Repository-Metriken

Stars
 (23.941 Stars)
PR-Merge-Metriken
 (Durchschn. Merge 42T 15h) (16 gemergte PRs in 30 T)

Beschreibung

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.

Contributor Guide

Research-Richtung
Installieren Sie eslint plugin mocha und fügen Sie die Regel 'no async describe' zur ESLint Konfiguration hinzu.
Tech Stack
javascript
Domain
developer experiencetooling
Issue Type
Wartung
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
1
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
Unter 1 Stunde
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Aktiv
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Klar
Voraussetzungen
javascript
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
90