This is a sample Hardhat plugin written in TypeScript. Creating a Hardhat plugin can be as easy as extracting a part of your config into a different file and publishing it to npm.
This sample project contains an example on how to do that, but also comes with many more features:
- A mocha test suite ready to use
- TravisCI already setup
- A package.json with scripts and publishing info
- Examples on how to do different things
To start working on your project, just run
npm installMake sure to read our Plugin Development Guide to learn how to build a plugin.
Running npm run test will run every test located in the test/ folder. They
use mocha and chai,
but you can customize them.
We recommend creating unit tests for your own modules, and integration tests for the interaction of the plugin with Hardhat and its dependencies.
All of Hardhat projects use prettier and tslint.
You can check if your code style is correct by running npm run lint, and fix
it with npm run lint:fix.
Just run npm run build ️👷
This README describes this boilerplate project, but won't be very useful to your plugin users.
Take a look at README-TEMPLATE.md for an example of what a Hardhat plugin's
README should look like.
Take a look at the migration guide!