nomicfoundation/hardhat-ts-plugin-boilerplate

Hardhat TypeScript plugin boilerplate

Hardhat TypeScript plugin boilerplate

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

Installation

To start working on your project, just run

npm install

Plugin development

Make sure to read our Plugin Development Guide to learn how to build a plugin.

Testing

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.

Linting and autoformat

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.

Building the project

Just run npm run build ️👷

README file

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.

Migrating from Buidler?

Take a look at the migration guide!

hardhat-ts-plugin-boilerplate's Issues

Broken link in https://github.com/nomiclabs/hardhat-ts-plugin-boilerplate/blob/master/README.md

https://github.com/nomiclabs/hardhat-ts-plugin-boilerplate/blob/master/README.md has a link to https://hardhat.org/guides/create-plugin.html. That link returns 404, and it's not clear where the link should point.

Use ESLint instead of TSLint

TSLint is getting deprecated.

My hardhat-packager plugin uses ESLint, maybe you could use it as an example to follow when refactoring this repo?

bug: incorrect include files

The boilerplate references a ./dist/src folder in multiple places, but that folder does not exist.

Opening a PR shortly.

Add readme template