Define rules to enforce using our own assertions

Author: alcuadrado

config-v-next/eslint.cjs

@@ -10,10 +10,13 @@ const path = require("path");
  * The only packages that should not use this config are our own eslint plugins/rules.
  *
  * @param {string} configFilePath The path to the config file that is using this function.
- * @param {{ onlyHardhatError?: boolean }} options An object with options to enable/disable certain rules.
+ * @param {{ onlyHardhatError?: boolean, enforceHardhatTestUtils?: boolean }} options An object with options to enable/disable certain rules.
  * @returns {import("eslint").Linter.Config}
  */
-function createConfig(configFilePath, options = { onlyHardhatError: true }) {
+function createConfig(
+  configFilePath,
+  options = { onlyHardhatError: true, enforceHardhatTestUtils: true }
+) {
   /**
    * @type {import("eslint").Linter.Config}
    */
@@ -425,6 +428,21 @@ function createConfig(configFilePath, options = { onlyHardhatError: true }) {
     });
   }
 
+  if (options.enforceHardhatTestUtils) {
+    config.rules["no-restricted-syntax"].push(
+      {
+        selector:
+          "CallExpression[callee.object.name='assert'][callee.property.name=throws]",
+        message: "Don't use assert.throws. Use our test helpers instead.",
+      },
+      {
+        selector:
+          "CallExpression[callee.object.name='assert'][callee.property.name=rejects]",
+        message: "Don't use assert.rejects. Use our test helpers instead.",
+      }
+    );
+  }
+
   return config;
 }
 

v-next/hardhat-test-utils/.eslintrc.cjs

@@ -1,3 +1,3 @@
 const { createConfig } = require("../../config-v-next/eslint.cjs");
 
-module.exports = createConfig(__filename);
+module.exports = createConfig(__filename, { enforceHardhatTestUtils: false });