A simple and opinionated tool designed to for basic formatting/linting of Solidity and TOML code in foundry projects.
Solidity formatting uses the configuration in foundry.toml, and TOML formatting has a hardcoded configuration.
Formatting and checking does the following:
- Runs
forge fmtto format Solidity. - Uses the
taplocrate to format TOML. - Validates test names follow a convention of
test(Fork)?(Fuzz)?_(Revert(If_|When_){1})?\w{1,}. - Validates constants and immutables are in
ALL_CAPS. - Validates function names and visibility in forge scripts to 1 public
runmethod per script. - Validates internal functions in
src/start with a leading underscore.
- Install with
cargo install scopelint. - Format code with
scopelint fmt. - Validate formatting with
scopelint check. - Use the ScopeLift foundry template to automatically run scopelint and slither in CI.
- This tool is currently opinionated and does not let you configure it's behavior.
- It's regex-based, so it may not be perfect—for example, it doesn't care that code is commented out.