README.md

Hardhat Test Suite Generator

Hardhat plugin for generating a test suite structure for smart contracts

Description

This plugin builds on top the TypeChain plugin, Hardhat toolbox, Hardhat network helpers and Hardhat chai matchers. More specifically, it creates a separate file for each function of the contract that is not in the exclude contract list generating a directory structure for each contract and a shared folder for types.

Installation

First, install the plugin and its peer dependencies.

if you are using Yarn, run:

yarn add --dev hardhat-test-suite-generator @nomicfoundation/hardhat-toolbox

or if you are using npm, run:

npm install --save-dev hardhat-test-suite-generator @nomicfoundation/hardhat-toolbox

Second, import the plugin in your hardhat.config.ts:

import "@nomicfoundation/hardhat-toolbox";
import "hardhat-test-suite-generator";

Required plugins

• @typechain/hardhat
• @nomicfoundation/hardhat-toolbox

Tasks

This plugin adds the generate-test-suite task to Hardhat:

Generates a test suite structure for smart contracts

Environment Extensions

This plugin does not extend the Hardhat Runtime Environment.

Configuration

This plugin extends the HardhatUserConfig object with an optional testSuiteGenerator object. This object contains two fields, excludeContracts and outDirName. excludeContracts is an array of strings that represent the names of the smart contracts in your project to exclude. The plugin uses this array and eliminates these contracts from the test suite structure. outDirName is a string name e.g. "test".

An example for how to set it:

module.exports = {
  testSuiteGenerator: {
    // What contracts to exclude from the test suite
    // Defaults to []
    excludeContracts: ["MyToken", "ERC20"],
    // Out directory name for the test suite
    // Must not contain "/"
    // Defaults to "test"
    outDirName: "test",
  },
};

Usage

If you are using Yarn, run this:

yarn hardhat generate-test-suite

or if you are using npm, run this:

npx hardhat generate-test-suite

And go look what you got in the test directory. For excluding any contract or renaming the test folder name refer to the configuration section above.

FAQ

I get an error when using Yarn

make sure these packages are present in your dependencies or devDependencies:

yarn add --dev \
  @nomicfoundation/hardhat-chai-matchers \
  @nomicfoundation/hardhat-ethers \
  @nomicfoundation/hardhat-network-helpers \
  @nomicfoundation/hardhat-toolbox \
  @nomicfoundation/hardhat-verify \
  @typechain/ethers-v6 \
  @typechain/hardhat \
  @types/chai \
  @types/mocha \
  chai \
  hardhat-gas-reporter \
  solidity-coverage \
  ts-node \
  typescript

Tips

• See how the plugin is used in hardhat-ts-template, and foundry-hardhat-template.

License

MIT © Ahmed Ali