OpenZeppelin/openzeppelin-contracts

Consider adding an ESLint rule for no async in describe blocks

Open

#4,943 opened on 2024年3月6日

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

説明

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.

コントリビューターガイド

技術スタック
javascript
領域
testing
Issue 種別
feature
難度新しい貢献者にとっての実装難度です。1 は非常に小さな変更、5 は専門的な作業です。
2
推定時間経験ある貢献者が調査、実装、テスト、pull request 準備にかけるおおよその時間範囲です。
under 1 hour
活動状況Issue が今どれだけ取り組みやすいかを示します。新しい、活発、古い、ブロック中、またはメンテナー入力待ちなどです。
active
明確さ期待される変更、受け入れ条件、次の手順がどれだけ明確かを示します。
clear
前提条件
basic ESLint knowledgefamiliarity with Mocha test framework
初心者向け度初回貢献者にどれだけ取り組みやすいかを 1-100 で推定したスコアです。
80
調査方針
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.
Consider adding an ESLint rule for no async in describe blocks · OpenZeppelin/openzeppelin-contracts#4943 | Good First Issue