Getting started¶
Install¶
It installs the spl command. Shell completion: source <(COMPLETE=bash spl) in ~/.bashrc (zsh and fish alike).
Pick a tier¶
| Project | Tier |
|---|---|
| one crate | small |
| a few crates in a workspace | small-workspace |
| tens of crates, internal crates, an MSRV | medium |
| a big workspace with declared layers | big (needs a crate map) |
spl init --tier small-workspace # writes spirit_level.toml
spl check # runs it
spl check --tier big # tries another tier without editing the file
Read a finding¶
deny workspace-lints crates/foo/Cargo.toml
foo does not inherit the workspace lints
help: add `[lints]` with `workspace = true` to its Cargo.toml
fix (--fix): add [lints] workspace = true
spl explain workspace-lints prints the lint's page. spl check --fix applies the exact fixes and checks again.
Change what does not fit¶
Every change says why (configuration):
extends = "small-workspace"
[lints.duplicate-versions]
level = "allow"
reason = "syn 2 and 3 until clap moves; checked monthly"
expires = "2027-01-31"
A single finding is allowed where it is, with a waiver.