OpenZeppelin/openzeppelin-contracts

Consider adding an ESLint rule for no async in describe blocks

Open

#4943 opened on Mar 6, 2024

View on GitHub
 (6 comments) (0 reactions) (0 assignees)JavaScript (23,941 stars) (11,560 forks)batch import
good first issuetests

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

Tech stack
javascript
Domain
testing
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
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
basic ESLint knowledgefamiliarity with Mocha test framework
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
80
Research direction
The issue suggests adding the 'no async describe' rule from eslint plugin mocha. First, check the existing ESLint configuration in the repository (likely .eslintrc or eslint config in package.json). Install or ensure eslint plugin mocha is a dev dependency. Then add the rule 'mocha/no async describe': 'error' to the rules section. The rule prevents async functions in describe blocks. No code changes needed, only config. See linked comment for context.