Skip to content
This repository was archived by the owner on Feb 5, 2025. It is now read-only.
This repository was archived by the owner on Feb 5, 2025. It is now read-only.

Feature Request: Add linting to template/contracts/ #443

@kyhyco

Description

@kyhyco

Describe the solution you'd like

Took a look at linters for solidity:

solhint

solhint is a linter with rules. Similar control mechanisms to eslint, supporting disabling rules via comments and allow you to create new rules.

solhint provides additional styling rules that augments forge fmt or prettier-solidity-plugin. Pretty neat.

ethlint

Project appears to be inactive


ethlint is out as it is inactive.

For solhint, we need to add two files: .solhint.json and .solhintignore.

In .solhint.json, we need to decide which rules sets to follow. solhint:recommended option looks good but would like to hear from more experienced solidity developers on which rule sets to enable / how their experience with solhint has been.

In .solhintignore, lib should be added as we don't want to lint third party imports.

Been using solhint for a couple days and it's been decent so far.

Describe alternatives you've considered.

No response

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions