OpenZeppelin/openzeppelin-contracts

Consider adding an ESLint rule for no async in describe blocks

Closed

#4,943 opened on Mar 6, 2024

View on GitHubContributor guide
 (6 comments) (0 reactions) (0 assignees)JavaScript (11,560 forks)batch import
good first issuetests

Repository metrics

Stars
 (23,941 stars)
PR merge metrics
 (Avg merge 42d 15h) (16 merged PRs in 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.

Contributor guide

Research direction
Install eslint plugin mocha and add the 'no async describe' rule to the ESLint configuration.
Tech stack
javascript
Domain
developer experiencetooling
Issue type
Chore
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
javascript
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
90