Merge pull request #5096 from NomicFoundation/no-async-describe

Add eslint rule to forbid describes with async functions

Author: fvictorio

config/eslint/eslintrc.js

@@ -12,7 +12,7 @@ module.exports = {
   plugins: [
     "@nomicfoundation/hardhat-internal-rules",
     "import",
-    "no-only-tests",
+    "mocha",
     "@typescript-eslint",
     "@nomicfoundation/slow-imports",
   ],
@@ -206,7 +206,6 @@ module.exports = {
     "no-extra-bind": "error",
     "no-new-func": "error",
     "no-new-wrappers": "error",
-    "no-only-tests/no-only-tests": "error",
     "no-return-await": "off",
     "@typescript-eslint/return-await": "error",
     "no-sequences": "error",
@@ -238,5 +237,7 @@ module.exports = {
         patterns: ["hardhat/src", "@nomiclabs/*/src"],
       },
     ],
+    "mocha/no-exclusive-tests": "error",
+    "mocha/no-async-describe": "error",
   },
 };

packages/hardhat-chai-matchers/package.json

@@ -55,7 +55,7 @@
     "eslint": "^8.44.0",
     "eslint-config-prettier": "8.3.0",
     "eslint-plugin-import": "2.27.5",
-    "eslint-plugin-no-only-tests": "3.0.0",
+    "eslint-plugin-mocha": "10.4.1",
     "eslint-plugin-prettier": "3.4.0",
     "ethers": "^6.1.0",
     "get-port": "^5.1.1",

packages/hardhat-chai-matchers/test/bigNumber.ts

@@ -860,7 +860,7 @@ describe("BigNumber matchers", function () {
       });
     });
 
-    describe("deep equal", async function () {
+    describe("deep equal", function () {
       checkAll(1, 1, (a, b) => {
         it(`should work with ${typestr(a)} and ${typestr(b)}`, function () {
           // successful assertions

packages/hardhat-chai-matchers/test/events.ts

@@ -405,7 +405,7 @@ describe(".to.emit (contract events)", () => {
           );
         });
 
-        describe("nested predicate", async function () {
+        describe("nested predicate", function () {
           it("Should succeed when predicate passes", async function () {
             await expect(contract.emitUintArray(1, 2))
               .to.emit(contract, "WithUintArray")
@@ -630,7 +630,7 @@ describe(".to.emit (contract events)", () => {
           "WithStringArg"
         );
       });
-      describe("When detecting two events from one call (chaining)", async function () {
+      describe("When detecting two events from one call (chaining)", function () {
         it("Should succeed when both expected events are indeed emitted", async function () {
           await expect(contract.emitUintAndString(1, "a string"))
             .to.emit(contract, "WithUintArg")
@@ -663,7 +663,7 @@ describe(".to.emit (contract events)", () => {
             );
           });
         });
-        describe("When specifying .withArgs()", async function () {
+        describe("When specifying .withArgs()", function () {
           it("Should pass when expecting the correct args from the first event", async function () {
             await expect(contract.emitUintAndString(1, "a string"))
               .to.emit(contract, "WithUintArg")

packages/hardhat-chai-matchers/test/reverted/revertedWithCustomError.ts

@@ -223,7 +223,7 @@ describe("INTEGRATION: Reverted with custom error", function () {
     });
 
     describe("with args", function () {
-      describe("one argument", async function () {
+      describe("one argument", function () {
         it("Should match correct argument", async function () {
           await expect(matchers.revertWithCustomErrorWithUint(1))
             .to.be.revertedWithCustomError(matchers, "CustomErrorWithUint")
@@ -348,7 +348,7 @@ describe("INTEGRATION: Reverted with custom error", function () {
         });
       });
 
-      describe("array of different lengths", async function () {
+      describe("array of different lengths", function () {
         it("Should fail if the expected array is bigger", async function () {
           await expect(
             expect(matchers.revertWithCustomErrorWithPair(1, 2))

packages/hardhat-core/package.json

@@ -92,7 +92,7 @@
     "eslint": "^8.44.0",
     "eslint-config-prettier": "8.3.0",
     "eslint-plugin-import": "2.27.5",
-    "eslint-plugin-no-only-tests": "3.0.0",
+    "eslint-plugin-mocha": "10.4.1",
     "eslint-plugin-prettier": "3.4.0",
     "ethers": "^6.1.0",
     "ethers-v5": "npm:ethers@5",

packages/hardhat-core/test/internal/hardhat-network/stack-traces/test.ts

@@ -153,7 +153,7 @@ function defineTest(
   ) {
     it.skip(desc, func);
   } else if (testDefinition.only !== undefined && testDefinition.only) {
-    // eslint-disable-next-line no-only-tests/no-only-tests
+    // eslint-disable-next-line mocha/no-exclusive-tests
     it.only(desc, func);
   } else {
     it(desc, func);
@@ -773,7 +773,7 @@ describe("Stack traces", function () {
       process.exit(1);
     }
 
-    // eslint-disable-next-line no-only-tests/no-only-tests
+    // eslint-disable-next-line mocha/no-exclusive-tests
     describe.only(`Use compiler at ${customSolcPath} with version ${customSolcVersion}`, function () {
       const compilerOptions = {
         solidityVersion: customSolcVersion,
@@ -867,7 +867,7 @@ function defineTestForSolidityMajorVersion(
   testsPath: string
 ) {
   for (const compilerOptions of solcVersionsCompilerOptions) {
-    // eslint-disable-next-line no-only-tests/no-only-tests
+    // eslint-disable-next-line mocha/no-exclusive-tests
     const describeFn = compilerOptions.only === true ? describe.only : describe;
 
     describeFn(`Use compiler ${compilerOptions.compilerPath}`, function () {

packages/hardhat-ethers/package.json

@@ -61,7 +61,7 @@
     "eslint": "^8.44.0",
     "eslint-config-prettier": "8.3.0",
     "eslint-plugin-import": "2.27.5",
-    "eslint-plugin-no-only-tests": "3.0.0",
+    "eslint-plugin-mocha": "10.4.1",
     "eslint-plugin-prettier": "3.4.0",
     "ethers": "^6.1.0",
     "hardhat": "workspace:^2.0.0",

packages/hardhat-foundry/package.json

@@ -48,6 +48,7 @@
     "eslint": "^8.44.0",
     "eslint-config-prettier": "8.3.0",
     "eslint-plugin-import": "2.27.5",
+    "eslint-plugin-mocha": "10.4.1",
     "eslint-plugin-prettier": "3.4.0",
     "hardhat": "workspace:^2.17.2",
     "mocha": "^10.0.0",

packages/hardhat-ledger/package.json

@@ -63,7 +63,7 @@
     "eslint": "^8.44.0",
     "eslint-config-prettier": "8.3.0",
     "eslint-plugin-import": "2.27.5",
-    "eslint-plugin-no-only-tests": "3.0.0",
+    "eslint-plugin-mocha": "10.4.1",
     "eslint-plugin-prettier": "3.4.0",
     "hardhat": "workspace:^2.16.0",
     "mocha": "^10.0.0",

packages/hardhat-network-helpers/package.json

@@ -55,7 +55,7 @@
     "eslint": "^8.44.0",
     "eslint-config-prettier": "8.3.0",
     "eslint-plugin-import": "2.27.5",
-    "eslint-plugin-no-only-tests": "3.0.0",
+    "eslint-plugin-mocha": "10.4.1",
     "eslint-plugin-prettier": "3.4.0",
     "ethers-v5": "npm:ethers@5",
     "hardhat": "workspace:^2.9.5",

packages/hardhat-shorthand/package.json

@@ -49,7 +49,7 @@
     "eslint": "^8.44.0",
     "eslint-config-prettier": "8.3.0",
     "eslint-plugin-import": "2.27.5",
-    "eslint-plugin-no-only-tests": "3.0.0",
+    "eslint-plugin-mocha": "10.4.1",
     "eslint-plugin-prettier": "3.4.0",
     "hardhat": "workspace:^2.0.0",
     "mocha": "^10.0.0",

packages/hardhat-solhint/package.json

@@ -52,7 +52,7 @@
     "eslint": "^8.44.0",
     "eslint-config-prettier": "8.3.0",
     "eslint-plugin-import": "2.27.5",
-    "eslint-plugin-no-only-tests": "3.0.0",
+    "eslint-plugin-mocha": "10.4.1",
     "eslint-plugin-prettier": "3.4.0",
     "fs-extra": "^7.0.1",
     "hardhat": "workspace:^2.0.0",

packages/hardhat-solpp/package.json

@@ -52,7 +52,7 @@
     "eslint": "^8.44.0",
     "eslint-config-prettier": "8.3.0",
     "eslint-plugin-import": "2.27.5",
-    "eslint-plugin-no-only-tests": "3.0.0",
+    "eslint-plugin-mocha": "10.4.1",
     "eslint-plugin-prettier": "3.4.0",
     "hardhat": "workspace:^2.0.0",
     "mocha": "^10.0.0",

packages/hardhat-solpp/test/tests.ts

@@ -19,8 +19,8 @@ export async function expectErrorAsync(
   }
 }
 
-describe("Solpp plugin", async function () {
-  describe("js-config-project", async function () {
+describe("Solpp plugin", function () {
+  describe("js-config-project", function () {
     useEnvironment("js-config-project");
 
     it("should evaluate symbols as javascript functions", async function () {
@@ -36,7 +36,7 @@ describe("Solpp plugin", async function () {
     });
   });
 
-  describe("json-config-project", async function () {
+  describe("json-config-project", function () {
     useEnvironment("json-config-project");
 
     it("should load definitions from json", async function () {
@@ -54,7 +54,7 @@ describe("Solpp plugin", async function () {
     });
   });
 
-  describe("hardhat-project", async function () {
+  describe("hardhat-project", function () {
     useEnvironment("hardhat-project");
 
     it("should create processed contracts in the cache directory", async function () {
@@ -102,7 +102,7 @@ describe("Solpp plugin", async function () {
     });
 
     // This test skipped because solpp won't fail if a contract has an non-defined symbol.
-    describe.skip("fail-project", async function () {
+    describe.skip("fail-project", function () {
       useEnvironment("fail-project");
 
       it("should fail when symbol does not exist", async function () {

packages/hardhat-toolbox-viem/package.json

@@ -59,7 +59,7 @@
     "eslint": "^8.44.0",
     "eslint-config-prettier": "8.3.0",
     "eslint-plugin-import": "2.27.5",
-    "eslint-plugin-no-only-tests": "3.0.0",
+    "eslint-plugin-mocha": "10.4.1",
     "eslint-plugin-prettier": "3.4.0",
     "hardhat": "workspace:^2.11.0",
     "hardhat-gas-reporter": "^1.0.8",

packages/hardhat-toolbox/package.json

@@ -58,7 +58,7 @@
     "eslint": "^8.44.0",
     "eslint-config-prettier": "8.3.0",
     "eslint-plugin-import": "2.27.5",
-    "eslint-plugin-no-only-tests": "3.0.0",
+    "eslint-plugin-mocha": "10.4.1",
     "eslint-plugin-prettier": "3.4.0",
     "ethers": "^6.4.0",
     "hardhat": "workspace:^2.11.0",

packages/hardhat-truffle4/package.json

@@ -55,7 +55,7 @@
     "eslint": "^8.44.0",
     "eslint-config-prettier": "8.3.0",
     "eslint-plugin-import": "2.27.5",
-    "eslint-plugin-no-only-tests": "3.0.0",
+    "eslint-plugin-mocha": "10.4.1",
     "eslint-plugin-prettier": "3.4.0",
     "hardhat": "workspace:^2.6.4",
     "mocha": "^10.0.0",

packages/hardhat-truffle5/package.json

@@ -55,7 +55,7 @@
     "eslint": "^8.44.0",
     "eslint-config-prettier": "8.3.0",
     "eslint-plugin-import": "2.27.5",
-    "eslint-plugin-no-only-tests": "3.0.0",
+    "eslint-plugin-mocha": "10.4.1",
     "eslint-plugin-prettier": "3.4.0",
     "hardhat": "workspace:^2.6.4",
     "mocha": "^10.0.0",

packages/hardhat-verify/package.json

@@ -70,7 +70,7 @@
     "eslint": "^8.44.0",
     "eslint-config-prettier": "8.3.0",
     "eslint-plugin-import": "2.27.5",
-    "eslint-plugin-no-only-tests": "3.0.0",
+    "eslint-plugin-mocha": "10.4.1",
     "eslint-plugin-prettier": "3.4.0",
     "ethers": "^5.0.0",
     "hardhat": "workspace:^2.0.4",

packages/hardhat-viem/package.json

@@ -55,7 +55,7 @@
     "eslint": "^8.44.0",
     "eslint-config-prettier": "8.3.0",
     "eslint-plugin-import": "2.27.5",
-    "eslint-plugin-no-only-tests": "3.0.0",
+    "eslint-plugin-mocha": "10.4.1",
     "eslint-plugin-prettier": "3.4.0",
     "hardhat": "workspace:^2.17.0",
     "jest-diff": "^29.7.0",

packages/hardhat-vyper/package.json

@@ -58,7 +58,7 @@
     "eslint": "^8.44.0",
     "eslint-config-prettier": "8.3.0",
     "eslint-plugin-import": "2.27.5",
-    "eslint-plugin-no-only-tests": "3.0.0",
+    "eslint-plugin-mocha": "10.4.1",
     "eslint-plugin-prettier": "3.4.0",
     "hardhat": "workspace:^2.8.3",
     "mocha": "^10.0.0",

packages/hardhat-vyper/test/tests.ts

@@ -242,7 +242,7 @@ describe("Vyper plugin", function () {
     });
   });
 
-  describe("Mixed language", async function () {
+  describe("Mixed language", function () {
     useFixtureProject("mixed-language");
     useEnvironment();
 

packages/hardhat-web3-legacy/package.json

@@ -46,7 +46,7 @@
     "eslint": "^8.44.0",
     "eslint-config-prettier": "8.3.0",
     "eslint-plugin-import": "2.27.5",
-    "eslint-plugin-no-only-tests": "3.0.0",
+    "eslint-plugin-mocha": "10.4.1",
     "eslint-plugin-prettier": "3.4.0",
     "hardhat": "workspace:^2.0.0",
     "mocha": "^10.0.0",

packages/hardhat-web3-v4/package.json

@@ -47,7 +47,7 @@
     "eslint": "^8.44.0",
     "eslint-config-prettier": "8.3.0",
     "eslint-plugin-import": "2.27.5",
-    "eslint-plugin-no-only-tests": "3.0.0",
+    "eslint-plugin-mocha": "10.4.1",
     "eslint-plugin-prettier": "3.4.0",
     "hardhat": "workspace:^2.0.0",
     "mocha": "^10.0.0",

packages/hardhat-web3/package.json

@@ -46,7 +46,7 @@
     "eslint": "^8.44.0",
     "eslint-config-prettier": "8.3.0",
     "eslint-plugin-import": "2.27.5",
-    "eslint-plugin-no-only-tests": "3.0.0",
+    "eslint-plugin-mocha": "10.4.1",
     "eslint-plugin-prettier": "3.4.0",
     "hardhat": "workspace:^2.0.0",
     "mocha": "^10.0.0",