https://github.com/ahmedali8/hardhat-test-suite-generator
Hardhat plugin for generating a test suite structure for smart contracts
https://github.com/ahmedali8/hardhat-test-suite-generator
fixtures hardhat-plugin npm-package test-suite typechain
Last synced: 6 months ago
JSON representation
Hardhat plugin for generating a test suite structure for smart contracts
- Host: GitHub
- URL: https://github.com/ahmedali8/hardhat-test-suite-generator
- Owner: ahmedali8
- License: mit
- Created: 2022-09-26T05:11:39.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2023-07-07T11:52:43.000Z (about 2 years ago)
- Last Synced: 2025-03-16T19:18:46.708Z (7 months ago)
- Topics: fixtures, hardhat-plugin, npm-package, test-suite, typechain
- Language: TypeScript
- Homepage:
- Size: 2.39 MB
- Stars: 7
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# Hardhat Test Suite Generator [![GitHub Actions][gha-badge]][gha] [![Coverage Status][coveralls-badge]][coveralls] [![Styled with Prettier][prettier-badge]][prettier] [![License: MIT][license-badge]][license]
[gha]: https://github.com/ahmedali8/hardhat-test-suite-generator/actions
[gha-badge]:
https://github.com/ahmedali8/hardhat-test-suite-generator/actions/workflows/ci.yml/badge.svg
[coveralls]: https://coveralls.io/github/ahmedali8/hardhat-test-suite-generator
[coveralls-badge]:
https://coveralls.io/repos/github/ahmedali8/hardhat-test-suite-generator/badge.svg?branch=main
[prettier]: https://prettier.io
[prettier-badge]: https://img.shields.io/badge/Code_Style-Prettier-ff69b4.svg
[license]: https://opensource.org/licenses/MIT
[license-badge]: https://img.shields.io/badge/License-MIT-blue.svg
Hardhat plugin for generating a test suite structure for smart contracts
## Description
This plugin builds on top the
[TypeChain plugin](https://github.com/ethereum-ts/TypeChain/tree/master/packages/hardhat),
[Hardhat toolbox](https://github.com/NomicFoundation/hardhat/tree/main/packages/hardhat-toolbox),
[Hardhat network helpers](https://github.com/NomicFoundation/hardhat/tree/main/packages/hardhat-network-helpers)
and
[Hardhat chai matchers](https://github.com/NomicFoundation/hardhat/tree/main/packages/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:
```sh
yarn add --dev hardhat-test-suite-generator @nomicfoundation/hardhat-toolbox
```
or if you are using `npm`, run:
```sh
npm install --save-dev hardhat-test-suite-generator @nomicfoundation/hardhat-toolbox
```
Second, import the plugin in your `hardhat.config.ts`:
```typescript
import "@nomicfoundation/hardhat-toolbox";
import "hardhat-test-suite-generator";
```
## Required plugins
- [@typechain/hardhat](https://github.com/ethereum-ts/TypeChain/tree/master/packages/hardhat)
- [@nomicfoundation/hardhat-toolbox](https://github.com/NomicFoundation/hardhat/tree/main/packages/hardhat-toolbox)
## Tasks
This plugin adds the _generate-test-suite_ task to Hardhat:
```text
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:
```javascript
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:
```sh
yarn hardhat generate-test-suite
```
or if you are using `npm`, run this:
```sh
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](./README.md#configuration) section above.
## FAQ
### I get an error when using Yarn
make sure these packages are present in your `dependencies` or `devDependencies`:
```sh
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](https://github.com/ahmedali8/hardhat-ts-template), and
[foundry-hardhat-template](https://github.com/ahmedali8/foundry-hardhat-template).
## License
[MIT](./LICENSE.md) © Ahmed Ali