The project use Solhint as linter for Solidity language that has its configuration in ./.solhint.json file.

To run with node:

npm run solhint

Prettier is a fantastic tool that automatically formats the codebase according to a predefined style guide. Just agree on the rules beforehand at the team level, and then Prettier will then autoformat everyone’s code in the same way.

Prettier-solidity is a Prettier for solidity files that works hand-in-hand with Solhint. It helps to automatically fix many of the errors that Solhint finds, especially simple ones like indentation and code style.

Prettier is configured in ./.prettierrc file.

The project has installed as dependency solhint-plugin-prettier, that allows Solhint to play nicely with Prettier-Solidity.

The is an script that yoyuu can run with npm:

npm run prettier:solidity

Take care that the command has --write flag will format and overwrite your existing files. As per the Prettier documentation, it’s a good idea to commit your code first.

In an ideal world, we’d always remember to run our linter and formatter before pushing code to our team’s codebase. Fortunately for us, we can automate this process with Git Hooks. To do that, we have Husky as dev dependency in package.json. husky runs every time any of Us push to Github.