eslint rule for no async in describe blocks via eslint-plugin-mocha (#6438)

Co-authored-by: Andile Sizophila Mchunu <andilexmchunu@gmail.com>
Co-authored-by: Hadrien Croubois <hadrien.croubois@gmail.com>

Author: 3 people

eslint.config.mjs

@@ -1,5 +1,6 @@
 import js from '@eslint/js';
 import { includeIgnoreFile } from '@eslint/compat';
+import mocha from 'eslint-plugin-mocha';
 import prettier from 'eslint-config-prettier';
 import globals from 'globals';
 import path from 'path';
@@ -10,6 +11,12 @@ const __dirname = path.dirname(fileURLToPath(import.meta.url));
 export default [
   js.configs.recommended,
   prettier,
+  {
+    plugins: { mocha },
+    rules: {
+      'mocha/no-async-suite': 'error',
+    },
+  },
   {
     languageOptions: {
       ecmaVersion: 2022,

package-lock.json

@@ -69,6 +69,7 @@
     "chai": "^4.2.0",
     "eslint": "^9.0.0",
     "eslint-config-prettier": "^10.0.0",
+    "eslint-plugin-mocha": "^11.2.0",
     "ethers": "^6.16.0",
     "glob": "^13.0.0",
     "globals": "^17.0.0",

package.json

@@ -1108,7 +1108,7 @@ describe('AccessManager', function () {
           expect(await this.manager.isTargetClosed(this.target)).to.be.false;
         });
 
-        describe('when the target is the manager', async function () {
+        describe('when the target is the manager', function () {
           it('closes and opens the manager', async function () {
             await expect(this.manager.connect(this.admin).setTargetClosed(this.manager, true))
               .to.emit(this.manager, 'TargetClosed')

test/access/manager/AccessManager.test.js

@@ -27,7 +27,7 @@ function shouldBehaveLikeBridgeERC1155({ chainAIsCustodial = false, chainBIsCust
       ]);
     });
 
-    describe('crosschain send (both direction)', async function () {
+    describe('crosschain send (both direction)', function () {
       it('single', async function () {
         const [alice, bruce, chris] = this.accounts;
 

test/crosschain/BridgeERC1155.behavior.js

@@ -142,7 +142,7 @@ function shouldBehaveLikeERC6909() {
         await expect(this.token.balanceOf(this.recipient, firstTokenId)).to.eventually.equal(amount);
       });
 
-      describe('with approval', async function () {
+      describe('with approval', function () {
         beforeEach(async function () {
           await this.token.connect(this.holder).approve(this.operator, firstTokenId, amount);
         });