Lints
Every lint, grouped by category, with its stable code and its level in each shipped tier (off: the tier does not enable it). A project changes any of them in its spirit_level.toml (configuration).
agents
| Code |
Lint |
Rule |
small |
small-workspace |
medium |
big |
ai |
embedded |
ui |
egui |
units-strict |
units-paranoid |
| P0001 |
agent-file-lines |
an agent file stays under its line limit |
warn |
warn |
warn |
warn |
deny |
off |
off |
off |
off |
off |
| P0002 |
agent-file-links |
links and @imports in agent files resolve |
off |
off |
off |
off |
deny |
off |
off |
off |
off |
off |
| P0003 |
agent-rules-match-lints |
limits an agent file states are the limits the lints check |
off |
off |
off |
warn |
deny |
off |
off |
off |
off |
off |
| P0004 |
claude-md-duplicate |
CLAUDE.md points to AGENTS.md instead of copying it |
off |
off |
off |
off |
deny |
off |
off |
off |
off |
off |
api
| Code |
Lint |
Rule |
small |
small-workspace |
medium |
big |
ai |
embedded |
ui |
egui |
units-strict |
units-paranoid |
| C0001 |
pub-surface |
a library's public surface stays small for its size |
off |
off |
off |
warn |
off |
off |
off |
off |
off |
off |
audit
| Code |
Lint |
Rule |
small |
small-workspace |
medium |
big |
ai |
embedded |
ui |
egui |
units-strict |
units-paranoid |
| X0001 |
audit-unmaintained |
no dependency is marked unmaintained or replaced in the RustSec database |
off |
off |
off |
off |
off |
off |
off |
off |
off |
off |
| X0002 |
audit-unsound |
no dependency is marked unsound in the RustSec database |
off |
off |
off |
off |
off |
off |
off |
off |
off |
off |
| X0003 |
audit-vulnerabilities |
no dependency has a published security vulnerability |
off |
off |
off |
off |
off |
off |
off |
off |
off |
off |
| X0004 |
audit-yanked |
Cargo.lock holds no yanked version |
off |
off |
off |
off |
off |
off |
off |
off |
off |
off |
book
| Code |
Lint |
Rule |
small |
small-workspace |
medium |
big |
ai |
embedded |
ui |
egui |
units-strict |
units-paranoid |
| D0008 |
nav-entries |
the book's navigation names pages that exist |
deny |
deny |
deny |
deny |
off |
off |
off |
off |
off |
off |
| D0009 |
orphan-pages |
every page of the book is in the navigation or linked from another page |
warn |
warn |
warn |
warn |
off |
off |
off |
off |
off |
off |
| D0010 |
page-title |
every page of the book has one title |
warn |
warn |
warn |
warn |
off |
off |
off |
off |
off |
off |
| D0011 |
admonition-syntax |
admonitions use a type Zensical styles and a body indented four spaces |
deny |
deny |
deny |
deny |
off |
off |
off |
off |
off |
off |
| D0017 |
book-build-stamp |
the book's footer shows the crate's version, commit and build age |
warn |
warn |
warn |
warn |
off |
off |
off |
off |
off |
off |
| D0018 |
readme-index-clash |
no docs folder holds both README.md and index.md |
deny |
deny |
deny |
deny |
off |
off |
off |
off |
off |
off |
| D0019 |
theme-feature-conflicts |
theme features that exclude each other are not both on |
deny |
deny |
deny |
deny |
off |
off |
off |
off |
off |
off |
| D0020 |
zensical-keys |
zensical.toml names only keys Zensical reads |
deny |
deny |
deny |
deny |
off |
off |
off |
off |
off |
off |
| D0022 |
book-deploy |
a book with a site_url is built strict and published with actions/deploy-pages by one workflow |
warn |
warn |
warn |
warn |
off |
off |
off |
off |
off |
off |
boot
| Code |
Lint |
Rule |
small |
small-workspace |
medium |
big |
ai |
embedded |
ui |
egui |
units-strict |
units-paranoid |
| F0001 |
boot-1 |
a firmware entered by a jump detects it and resets once |
off |
off |
off |
off |
off |
deny |
off |
off |
off |
off |
| F0002 |
boot-10 |
backup-domain helpers restore what they found |
off |
off |
off |
off |
off |
warn |
off |
off |
off |
off |
| F0003 |
boot-2 |
the H7 supply configuration is read back, never written blind |
off |
off |
off |
off |
off |
deny |
off |
off |
off |
off |
brd
| Code |
Lint |
Rule |
small |
small-workspace |
medium |
big |
ai |
embedded |
ui |
egui |
units-strict |
units-paranoid |
| F0099 |
brd-1 |
a board description reads, follows the schema, and the chip data and PCB it names read |
off |
off |
off |
off |
off |
deny |
off |
off |
off |
off |
| F0100 |
brd-2 |
every pin of a board description has one job in each configuration |
off |
off |
off |
off |
off |
deny |
off |
off |
off |
off |
| F0101 |
brd-3 |
of MCU pins joined on the board, at most one is used |
off |
off |
off |
off |
off |
deny |
off |
off |
off |
off |
| F0102 |
brd-4 |
the pins, package, peripherals and signals a board description names exist on its chip |
off |
off |
off |
off |
off |
deny |
off |
off |
off |
off |
| F0103 |
brd-5 |
every peripheral signal sits on a pin that can carry it |
off |
off |
off |
off |
off |
deny |
off |
off |
off |
off |
| F0104 |
brd-6 |
the MCU pins are connected on the PCB as the board description says |
off |
off |
off |
off |
off |
deny |
off |
off |
off |
off |
| F0105 |
brd-7 |
every connected MCU pin of the PCB is in the board description, and no free pin is unconnected |
off |
off |
off |
off |
off |
warn |
off |
off |
off |
off |
build
| Code |
Lint |
Rule |
small |
small-workspace |
medium |
big |
ai |
embedded |
ui |
egui |
units-strict |
units-paranoid |
| X0005 |
cargo-doc |
cargo doc builds the workspace's documentation without a warning |
warn |
warn |
deny |
deny |
off |
off |
off |
off |
off |
off |
| X0006 |
cargo-msrv |
every crate builds with the toolchain of its declared rust-version |
off |
off |
warn |
deny |
off |
off |
off |
off |
off |
off |
| X0007 |
cargo-no-std |
every crate the map marks no_std builds for targets without std |
off |
off |
off |
deny |
off |
off |
off |
off |
off |
off |
| X0008 |
cargo-wasm |
every crate the map marks wasm builds for wasm32-unknown-unknown |
off |
off |
off |
deny |
off |
off |
off |
off |
off |
off |
cfg
| Code |
Lint |
Rule |
small |
small-workspace |
medium |
big |
ai |
embedded |
ui |
egui |
units-strict |
units-paranoid |
| F0004 |
cfg-1 |
every probe-rs runner and recipe names its probe with --probe VID:PID |
off |
off |
off |
off |
off |
deny |
off |
off |
off |
off |
| F0005 |
cfg-2 |
F0/G0/L0 firmware is flashed by a runner that halts the core first |
off |
off |
off |
off |
off |
warn |
off |
off |
off |
off |
| F0006 |
cfg-4 |
every crate is in the tree from one source |
off |
off |
off |
off |
off |
deny |
off |
off |
off |
off |
| F0007 |
cfg-5 |
the HAL's chip feature names the part on the board |
off |
off |
off |
off |
off |
deny |
off |
off |
off |
off |
| F0008 |
cfg-6 |
thumbv6m firmware that needs compare-and-swap uses portable-atomic with critical-section |
off |
off |
off |
off |
off |
warn |
off |
off |
off |
off |
| F0009 |
cfg-7 |
the build info carries the git SHA and a dirty flag |
off |
off |
off |
off |
off |
warn |
off |
off |
off |
off |
cli
| Code |
Lint |
Rule |
small |
small-workspace |
medium |
big |
ai |
embedded |
ui |
egui |
units-strict |
units-paranoid |
| C0020 |
cli-help-examples |
--help of a CLI and of each of its leaf commands ends in an Examples block |
warn |
warn |
warn |
warn |
off |
off |
off |
off |
off |
off |
| C0021 |
cli-help-text |
every command and argument of a CLI has a help line |
warn |
warn |
warn |
warn |
off |
off |
off |
off |
off |
off |
| C0022 |
cli-help-clean |
a CLI's help holds no rustdoc leftovers |
warn |
warn |
deny |
deny |
off |
off |
off |
off |
off |
off |
| C0023 |
cli-completion |
a CLI prints its shell completion registration for bash, zsh and fish |
warn |
warn |
warn |
warn |
off |
off |
off |
off |
off |
off |
| C0024 |
cli-plain-when-piped |
a CLI writes no colour escapes into a pipe |
warn |
warn |
deny |
deny |
off |
off |
off |
off |
off |
off |
| C0025 |
cli-color-flag |
a CLI takes a global --color flag with auto, always and never |
warn |
warn |
warn |
warn |
off |
off |
off |
off |
off |
off |
| C0026 |
cli-usage-error |
a CLI answers an unknown flag with exit code 2 and a message on stderr only |
warn |
warn |
deny |
deny |
off |
off |
off |
off |
off |
off |
| C0027 |
cli-version-line |
--version prints the binary's name, version, git SHA and commit time |
warn |
warn |
warn |
warn |
off |
off |
off |
off |
off |
off |
| C0028 |
cli-json-output |
every leaf command of a CLI has a machine-readable output flag |
off |
off |
off |
off |
off |
off |
off |
off |
off |
off |
| C0029 |
cli-standard-flags |
a CLI's short flags keep their standard meaning |
warn |
warn |
warn |
warn |
off |
off |
off |
off |
off |
off |
| C0037 |
cli-secret-flags |
no option takes a secret as its value |
warn |
warn |
warn |
warn |
off |
off |
off |
off |
off |
off |
| C0038 |
cli-no-abbreviations |
a CLI runs no subcommand from a unique prefix |
warn |
warn |
deny |
deny |
off |
off |
off |
off |
off |
off |
| C0039 |
command-registry |
a CLI with many commands registers each command group in its own module |
warn |
warn |
warn |
warn |
off |
off |
off |
off |
off |
off |
clippy
| Code |
Lint |
Rule |
small |
small-workspace |
medium |
big |
ai |
embedded |
ui |
egui |
units-strict |
units-paranoid |
| X0009 |
clippy-build |
the workspace builds under clippy without compiler errors or warnings |
off |
off |
off |
off |
off |
off |
off |
off |
off |
off |
| X0010 |
clippy-cargo |
no finding of the cargo-group clippy lints the project turned on |
off |
off |
off |
off |
off |
off |
off |
off |
off |
off |
| X0011 |
clippy-complexity |
no finding of clippy's complexity group: simple things done simply |
off |
off |
off |
off |
off |
off |
off |
off |
off |
off |
| X0012 |
clippy-correctness |
no finding of clippy's correctness group: code that is outright wrong |
off |
off |
off |
off |
off |
off |
off |
off |
off |
off |
| X0013 |
clippy-nursery |
no finding of the nursery clippy lints the project turned on |
off |
off |
off |
off |
off |
off |
off |
off |
off |
off |
| X0014 |
clippy-pedantic |
no finding of the pedantic clippy lints the project turned on |
off |
off |
off |
off |
off |
off |
off |
off |
off |
off |
| X0015 |
clippy-perf |
no finding of clippy's perf group: no needlessly slow code |
off |
off |
off |
off |
off |
off |
off |
off |
off |
off |
| X0016 |
clippy-restriction |
no finding of the restriction clippy lints the project turned on |
off |
off |
off |
off |
off |
off |
off |
off |
off |
off |
| X0017 |
clippy-style |
no finding of clippy's style group: code written the idiomatic way |
off |
off |
off |
off |
off |
off |
off |
off |
off |
off |
| X0018 |
clippy-suspicious |
no finding of clippy's suspicious group: code that is most likely wrong |
off |
off |
off |
off |
off |
off |
off |
off |
off |
off |
clk
| Code |
Lint |
Rule |
small |
small-workspace |
medium |
big |
ai |
embedded |
ui |
egui |
units-strict |
units-paranoid |
| F0010 |
clk-2 |
the embassy time driver names a timer that nothing else uses |
off |
off |
off |
off |
off |
deny |
off |
off |
off |
off |
| F0011 |
clk-3 |
the clock security system watches HSE and LSE, with a handler |
off |
off |
off |
off |
off |
warn |
off |
off |
off |
off |
| F0012 |
clk-5 |
USB has an exact 48 MHz clock |
off |
off |
off |
off |
off |
deny |
off |
off |
off |
off |
cls
| Code |
Lint |
Rule |
small |
small-workspace |
medium |
big |
ai |
embedded |
ui |
egui |
units-strict |
units-paranoid |
| F0106 |
cls-1 |
every file that holds an executor task has a task class in [embedded.classes] |
off |
off |
off |
off |
off |
warn |
off |
off |
off |
off |
| F0107 |
cls-2 |
a service module denies the Clippy lints that find panics at its top |
off |
off |
off |
off |
off |
deny |
off |
off |
off |
off |
cnt
| Code |
Lint |
Rule |
small |
small-workspace |
medium |
big |
ai |
embedded |
ui |
egui |
units-strict |
units-paranoid |
| F0013 |
cnt-1 |
every error branch counts what happened with cnt! |
off |
off |
off |
off |
off |
warn |
off |
off |
off |
off |
| F0014 |
cnt-2 |
counter buffers an interrupt updates are never borrowed mutably or read unaligned |
off |
off |
off |
off |
off |
warn |
off |
off |
off |
off |
| F0015 |
cnt-3 |
a proc-macro crate and its runtime crate are pinned to the same exact version |
off |
off |
off |
off |
off |
warn |
off |
off |
off |
off |
code
| Code |
Lint |
Rule |
small |
small-workspace |
medium |
big |
ai |
embedded |
ui |
egui |
units-strict |
units-paranoid |
| C0002 |
allow-without-reason |
every allow or expect of a lint says why |
warn |
warn |
warn |
deny |
deny |
off |
off |
off |
off |
off |
| C0003 |
cli-subprocess |
workspace crates call each other as libraries, never by running the workspace's own binaries |
off |
off |
deny |
deny |
off |
off |
off |
off |
off |
off |
| C0004 |
float-determinism |
deterministic crates compute float transcendentals through libm |
off |
off |
off |
deny |
off |
off |
off |
off |
off |
off |
| C0005 |
panic-in-library |
library code returns errors for what can fail and says why where it panics |
off |
off |
warn |
warn |
off |
deny |
off |
off |
off |
off |
| C0006 |
print-in-library |
library code does not print |
warn |
warn |
warn |
warn |
off |
off |
off |
off |
off |
off |
| C0007 |
random-state-hash |
deterministic crates use no randomly seeded hash maps |
off |
off |
off |
deny |
off |
off |
off |
off |
off |
off |
| C0008 |
todo-macros |
no todo!() or unimplemented!() outside tests |
warn |
warn |
warn |
deny |
deny |
off |
off |
off |
off |
off |
| C0014 |
build-info-env |
library code reads build info at run time, not through env! |
off |
off |
warn |
warn |
off |
off |
off |
off |
off |
off |
| C0015 |
test-support-gated |
test fakes and testing modules compile only for tests or behind the test-support feature |
off |
off |
warn |
warn |
off |
off |
off |
off |
off |
off |
| C0017 |
sized-ints-in-contracts |
serde types of a contract crate use sized integers, not usize or isize |
off |
off |
warn |
deny |
off |
off |
off |
off |
off |
off |
| C0018 |
unit-suffix |
a numeric field or constant that holds a time or a size names its unit |
off |
off |
off |
off |
warn |
off |
off |
off |
off |
off |
| C0019 |
unbounded-read |
a read to the end of a stream is bounded with take() |
off |
off |
off |
warn |
warn |
off |
off |
off |
off |
off |
| C0030 |
compound-assert |
an assertion checks one condition, so a failure names the one that broke |
off |
off |
off |
warn |
off |
warn |
off |
off |
off |
off |
| C0031 |
assert-message |
every assertion says in words what it checks |
off |
off |
off |
warn |
off |
warn |
off |
off |
off |
off |
| C0032 |
float-partial-cmp-unwrap |
floats are ordered with total_cmp, not partial_cmp that panics on NaN |
warn |
warn |
warn |
warn |
off |
off |
off |
off |
off |
off |
| C0040 |
build-script-clock |
build.rs reads no clock and resolves git through the real git dir |
warn |
warn |
warn |
warn |
off |
off |
off |
off |
off |
off |
commits
| Code |
Lint |
Rule |
small |
small-workspace |
medium |
big |
ai |
embedded |
ui |
egui |
units-strict |
units-paranoid |
| P0005 |
commit-body-lines |
a commit body stays short |
off |
off |
off |
off |
warn |
off |
off |
off |
off |
off |
| P0006 |
commit-prose |
commit messages use no filler, narration or emoji and do not describe the diff |
off |
off |
off |
off |
warn |
off |
off |
off |
off |
off |
| P0007 |
commit-subject-length |
a commit subject stays under its length limit |
off |
off |
warn |
warn |
deny |
off |
off |
off |
off |
off |
| P0017 |
fixes-tag |
a Fixes: trailer names its culprit by a hash that resolves and the culprit's subject |
off |
off |
warn |
warn |
deny |
off |
off |
off |
off |
off |
| P0018 |
fix-without-test |
a commit that fixes code adds a test |
off |
off |
off |
warn |
warn |
off |
off |
off |
off |
off |
| P0019 |
commit-tested-line |
a commit says how it was tested in a Tested: trailer |
off |
off |
off |
off |
warn |
off |
off |
off |
off |
off |
| P0020 |
commit-mixed-move |
a commit that moves a file does not also edit it beyond its paths |
off |
off |
off |
off |
warn |
off |
off |
off |
off |
off |
dead-code
| Code |
Lint |
Rule |
small |
small-workspace |
medium |
big |
ai |
embedded |
ui |
egui |
units-strict |
units-paranoid |
| C0009 |
dead-pub |
public items of workspace libraries are used outside their crate |
off |
off |
off |
warn |
off |
off |
off |
off |
off |
off |
deny
| Code |
Lint |
Rule |
small |
small-workspace |
medium |
big |
ai |
embedded |
ui |
egui |
units-strict |
units-paranoid |
| X0019 |
deny-advisories |
no dependency has a security advisory, is unmaintained, unsound or yanked |
warn |
warn |
deny |
deny |
off |
off |
off |
off |
off |
off |
| X0020 |
deny-bans |
the dependency graph holds no banned crate and no duplicate deny.toml refuses |
off |
off |
off |
deny |
off |
off |
off |
off |
off |
off |
| X0021 |
deny-licenses |
every crate's licence is one deny.toml allows |
off |
off |
warn |
deny |
off |
off |
off |
off |
off |
off |
| X0022 |
deny-sources |
every crate comes from a registry or git source deny.toml allows |
off |
off |
off |
deny |
off |
off |
off |
off |
off |
off |
dependencies
| Code |
Lint |
Rule |
small |
small-workspace |
medium |
big |
ai |
embedded |
ui |
egui |
units-strict |
units-paranoid |
| M0001 |
default-features-off |
third-party dependencies are declared with default-features = false |
warn |
warn |
warn |
deny |
off |
off |
off |
off |
off |
off |
| M0002 |
duplicate-versions |
no crate is in the dependency graph in two versions |
off |
warn |
warn |
deny |
off |
off |
off |
off |
off |
off |
| M0003 |
git-dependency-pins |
git dependencies are pinned the way the project's policy says: a branch by default |
warn |
warn |
deny |
deny |
off |
off |
off |
off |
off |
off |
| M0004 |
no-sys-crates |
the dependency graph has no -sys crates and no C build steps |
deny |
deny |
deny |
deny |
off |
off |
off |
off |
off |
off |
| M0005 |
path-outside-workspace |
path dependencies stay inside the workspace |
deny |
deny |
deny |
deny |
off |
off |
off |
off |
off |
off |
| M0027 |
patch-outside-workspace |
no committed [patch] or [replace] override takes a path outside the workspace |
deny |
deny |
deny |
deny |
off |
off |
off |
off |
off |
off |
dma
| Code |
Lint |
Rule |
small |
small-workspace |
medium |
big |
ai |
embedded |
ui |
egui |
units-strict |
units-paranoid |
| F0016 |
dma-1 |
DMA buffers sit in memory the DMA master can reach |
off |
off |
off |
off |
off |
deny |
off |
off |
off |
off |
| F0017 |
dma-2 |
DMA buffers in cacheable RAM are cleaned and invalidated, or not cacheable |
off |
off |
off |
off |
off |
deny |
off |
off |
off |
off |
| F0018 |
dma-4 |
every DMA ring consumer counts its overruns |
off |
off |
off |
off |
off |
warn |
off |
off |
off |
off |
| F0019 |
dma-6 |
where an erratum asks for DMA, the code uses DMA instead of polling |
off |
off |
off |
off |
off |
warn |
off |
off |
off |
off |
egui
| Code |
Lint |
Rule |
small |
small-workspace |
medium |
big |
ai |
embedded |
ui |
egui |
units-strict |
units-paranoid |
| U0010 |
egui-shared-theme |
every egui app installs the shared theme |
off |
off |
off |
off |
off |
off |
off |
warn |
off |
off |
| U0011 |
egui-status-glyph |
a status glyph is painted in its tone, never written into a label |
off |
off |
off |
off |
off |
off |
off |
deny |
off |
off |
| U0012 |
egui-id-in-loop |
a widget made in a loop gets an id that differs per iteration |
off |
off |
off |
off |
off |
off |
off |
warn |
off |
off |
| U0013 |
egui-repaint-every-frame |
UI code asks for a repaint when something changed, not on every frame |
off |
off |
off |
off |
off |
off |
off |
warn |
off |
off |
| U0015 |
egui-panel-api |
egui panel and App code uses the API the version in use ships, never one it replaced |
off |
off |
off |
off |
off |
off |
off |
warn |
off |
off |
| U0016 |
egui-checklist-menu |
a checklist of checkboxes sits in the shared checklist widget, not a menu_button that closes on each click |
off |
off |
off |
off |
off |
off |
off |
warn |
off |
off |
embedded
| Code |
Lint |
Rule |
small |
small-workspace |
medium |
big |
ai |
embedded |
ui |
egui |
units-strict |
units-paranoid |
| F0020 |
firmware-readable |
every file of a firmware crate that the embedded lints read can be read |
off |
off |
off |
off |
off |
deny |
off |
off |
off |
off |
err
| Code |
Lint |
Rule |
small |
small-workspace |
medium |
big |
ai |
embedded |
ui |
egui |
units-strict |
units-paranoid |
| F0021 |
err-11 |
the silicon revision is read from a source that tells every revision apart |
off |
off |
off |
off |
off |
warn |
off |
off |
off |
off |
| F0022 |
err-2 |
every register poke for an erratum quotes the erratum next to it |
off |
off |
off |
off |
off |
deny |
off |
off |
off |
off |
| F0023 |
err-3 |
flash prefetch is off where code crosses into bank 2 on G0B0/G0B1/G0C1 |
off |
off |
off |
off |
off |
deny |
off |
off |
off |
off |
| F0024 |
err-4 |
FDCAN edge filtering and dedicated Tx buffers stay off |
off |
off |
off |
off |
off |
deny |
off |
off |
off |
off |
| F0025 |
err-5 |
FDCAN one-shot mode retransmits after a lost arbitration |
off |
off |
off |
off |
off |
warn |
off |
off |
off |
off |
| F0026 |
err-6 |
RP2350 A2 pads with a pull-down enable their input only for the read |
off |
off |
off |
off |
off |
warn |
off |
off |
off |
off |
| F0027 |
err-7 |
RP2350 ROM reboots use a delay and only the allowed FRCE_OFF bits |
off |
off |
off |
off |
off |
warn |
off |
off |
off |
off |
| F0028 |
err-8 |
G0 ADC calibration waits two ADC clocks after the disable |
off |
off |
off |
off |
off |
warn |
off |
off |
off |
off |
errors
| Code |
Lint |
Rule |
small |
small-workspace |
medium |
big |
ai |
embedded |
ui |
egui |
units-strict |
units-paranoid |
| C0010 |
error-enum-growth |
a big error enum wraps the errors it comes from instead of listing every failure flat |
off |
off |
warn |
warn |
off |
off |
off |
off |
off |
off |
exe
| Code |
Lint |
Rule |
small |
small-workspace |
medium |
big |
ai |
embedded |
ui |
egui |
units-strict |
units-paranoid |
| F0029 |
exe-1 |
a task with a hard answer deadline runs on its own executor, not beside bulk work on the thread executor |
off |
off |
off |
off |
off |
deny |
off |
off |
off |
off |
| F0030 |
exe-10 |
one crate provides the executor and its pender |
off |
off |
off |
off |
off |
deny |
off |
off |
off |
off |
| F0031 |
exe-12 |
every async fn awaits something |
off |
off |
off |
off |
off |
warn |
off |
off |
off |
off |
| F0032 |
exe-13 |
a ring-buffered reader in a loop batches its reads |
off |
off |
off |
off |
off |
warn |
off |
off |
off |
off |
| F0033 |
exe-2 |
tasks on an interrupt executor and interrupt handlers never block |
off |
off |
off |
off |
off |
deny |
off |
off |
off |
off |
| F0034 |
exe-3 |
an interrupt executor's priority is set before it is started |
off |
off |
off |
off |
off |
deny |
off |
off |
off |
off |
| F0035 |
exe-4 |
an interrupt executor runs below the interrupts that wake its tasks |
off |
off |
off |
off |
off |
warn |
off |
off |
off |
off |
| F0036 |
exe-5 |
an interrupt executor uses a vector no driver binds and no used peripheral raises |
off |
off |
off |
off |
off |
deny |
off |
off |
off |
off |
| F0037 |
exe-6 |
state shared between an interrupt executor and thread mode sits behind a critical-section mutex |
off |
off |
off |
off |
off |
deny |
off |
off |
off |
off |
| F0038 |
exe-7 |
a loop that drains a queue in a shared task is bounded and yields |
off |
off |
off |
off |
off |
warn |
off |
off |
off |
off |
| F0039 |
exe-8 |
a request handler answers without waiting on a bus or a slow peripheral |
off |
off |
off |
off |
off |
warn |
off |
off |
off |
off |
| F0040 |
exe-9 |
no future that reaches embassy-time is polled with a no-op waker |
off |
off |
off |
off |
off |
deny |
off |
off |
off |
off |
ext
| Code |
Lint |
Rule |
small |
small-workspace |
medium |
big |
ai |
embedded |
ui |
egui |
units-strict |
units-paranoid |
| F0041 |
ext-12 |
an RCC enable is read back before the peripheral's first access |
off |
off |
off |
off |
off |
warn |
off |
off |
off |
off |
| F0042 |
ext-4 |
external chip registers are written from shadow copies, not read-modify-write |
off |
off |
off |
off |
off |
warn |
off |
off |
off |
off |
| F0043 |
ext-7 |
register fields are range-checked before they are encoded |
off |
off |
off |
off |
off |
warn |
off |
off |
off |
off |
fls
| Code |
Lint |
Rule |
small |
small-workspace |
medium |
big |
ai |
embedded |
ui |
egui |
units-strict |
units-paranoid |
| F0044 |
fls-1 |
flash a power cut can tear is read through ECC-aware access on parts with flash ECC |
off |
off |
off |
off |
off |
deny |
off |
off |
off |
off |
| F0045 |
fls-2 |
the flash peripheral has one owner |
off |
off |
off |
off |
off |
deny |
off |
off |
off |
off |
| F0046 |
fls-3 |
RP flash is erased and written from core 0 with nothing else reading flash |
off |
off |
off |
off |
off |
deny |
off |
off |
off |
off |
| F0047 |
fls-4 |
the image in flash is checked by a periodic CRC, and ECC is on where the part has it |
off |
off |
off |
off |
off |
warn |
off |
off |
off |
off |
flt
| Code |
Lint |
Rule |
small |
small-workspace |
medium |
big |
ai |
embedded |
ui |
egui |
units-strict |
units-paranoid |
| F0048 |
flt-1 |
the HardFault handler records the crash and resets instead of spinning |
off |
off |
off |
off |
off |
deny |
off |
off |
off |
off |
| F0049 |
flt-2 |
HardFault and DefaultHandler do nothing that can panic or log |
off |
off |
off |
off |
off |
deny |
off |
off |
off |
off |
| F0050 |
flt-3 |
bedrock_crash::exc_return!() is the first statement of HardFault |
off |
off |
off |
off |
off |
warn |
off |
off |
off |
off |
| F0051 |
flt-4 |
UsageFault, MemManage and BusFault have handlers and are enabled where the core has them |
off |
off |
off |
off |
off |
warn |
off |
off |
off |
off |
| F0052 |
flt-5 |
the reset cause is read and reported at boot |
off |
off |
off |
off |
off |
warn |
off |
off |
off |
off |
| F0053 |
flt-7 |
a watchdog runs, fed from a bounded loop of the main work |
off |
off |
off |
off |
off |
deny |
off |
off |
off |
off |
| F0054 |
flt-8 |
a boot-loop rescue falls back to the ROM bootloader after repeated unhealthy boots |
off |
off |
off |
off |
off |
warn |
off |
off |
off |
off |
| F0055 |
flt-9 |
the healthy mark is set on the transport in use |
off |
off |
off |
off |
off |
warn |
off |
off |
off |
off |
| F0108 |
flt-11 |
the panic and HardFault handlers put the board into its safe state before anything else |
off |
off |
off |
off |
off |
warn |
off |
off |
off |
off |
| F0109 |
flt-12 |
the boot counter is read before the first output is enabled |
off |
off |
off |
off |
off |
warn |
off |
off |
off |
off |
geiger
| Code |
Lint |
Rule |
small |
small-workspace |
medium |
big |
ai |
embedded |
ui |
egui |
units-strict |
units-paranoid |
| X0023 |
geiger-unsafe-deps |
every dependency that uses unsafe code is one the project accepted |
off |
off |
off |
off |
off |
off |
off |
off |
off |
off |
graph
| Code |
Lint |
Rule |
small |
small-workspace |
medium |
big |
ai |
embedded |
ui |
egui |
units-strict |
units-paranoid |
| G0001 |
core-crate-deps |
a _core crate depends only on other _core crates, the allowed layers and listed vocabulary crates |
off |
off |
warn |
deny |
off |
off |
off |
off |
off |
off |
| G0002 |
core-crate-types |
a _core crate holds types: no I/O, no threads, no async runtime |
off |
off |
off |
deny |
off |
off |
off |
off |
off |
off |
| G0003 |
crate-cycles |
workspace crates form no cycle, dev-dependencies included |
off |
warn |
deny |
deny |
off |
off |
off |
off |
off |
off |
| G0004 |
crate-table |
the crate table in the README is the one generated from the manifests and the map |
off |
off |
off |
deny |
off |
off |
off |
off |
off |
off |
| G0005 |
external-form |
crates of other projects come by git as the map lists them, used only where their role allows |
off |
off |
off |
deny |
off |
off |
off |
off |
off |
off |
| G0006 |
forbidden-closure |
a crate never reaches the crates the map forbids it, directly or through others |
off |
off |
off |
deny |
off |
off |
off |
off |
off |
off |
| G0007 |
layer-edges |
every dependency edge between workspace crates is allowed by the map |
off |
off |
off |
deny |
off |
off |
off |
off |
off |
off |
| G0008 |
map-complete |
the crate map and the workspaces list the same crates |
off |
off |
off |
deny |
off |
off |
off |
off |
off |
off |
| G0009 |
third-party-placement |
heavy third-party crates are used only by the crates the map names |
off |
off |
off |
deny |
off |
off |
off |
off |
off |
off |
| G0010 |
unsafe-allow-list |
unsafe code is forbidden except in the crates the map marks unsafe |
off |
off |
off |
deny |
off |
off |
off |
off |
off |
off |
| G0011 |
crate-folder-layer |
a crate's folder is its layer in the map, then its discipline where the map gives one |
off |
off |
off |
deny |
off |
off |
off |
off |
off |
off |
| G0012 |
map-licence |
every crate carries the licence the map sets for its layer or for itself |
off |
off |
off |
deny |
off |
off |
off |
off |
off |
off |
hakari
| Code |
Lint |
Rule |
small |
small-workspace |
medium |
big |
ai |
embedded |
ui |
egui |
units-strict |
units-paranoid |
| X0024 |
hakari-generate |
the workspace-hack package's dependencies are the ones hakari computes |
off |
off |
off |
warn |
off |
off |
off |
off |
off |
off |
| X0025 |
hakari-manage-deps |
every member hakari manages depends on the workspace-hack package, and no other |
off |
off |
off |
warn |
off |
off |
off |
off |
off |
off |
host
| Code |
Lint |
Rule |
small |
small-workspace |
medium |
big |
ai |
embedded |
ui |
egui |
units-strict |
units-paranoid |
| F0056 |
host-1 |
nothing reachable from host input can panic |
off |
off |
off |
off |
off |
deny |
off |
off |
off |
off |
| F0057 |
host-3 |
unknown enum values from the host are refused, not mapped to a default |
off |
off |
off |
off |
off |
warn |
off |
off |
off |
off |
| F0058 |
host-5 |
truncated and oversized requests are counted and dropped |
off |
off |
off |
off |
off |
warn |
off |
off |
off |
off |
hygiene
| Code |
Lint |
Rule |
small |
small-workspace |
medium |
big |
ai |
embedded |
ui |
egui |
units-strict |
units-paranoid |
| A0001 |
agent-config-permissions |
committed agent settings grant no blanket permissions |
off |
off |
off |
off |
deny |
off |
off |
off |
off |
off |
| A0002 |
agent-config-secrets |
committed agent configuration holds no secrets |
off |
off |
off |
off |
deny |
off |
off |
off |
off |
off |
| A0003 |
agent-session-files |
no agent transcripts or per-person agent files are committed |
off |
off |
off |
off |
deny |
off |
off |
off |
off |
off |
| A0004 |
leftover-files |
no merge, patch, editor or scratch leftovers are committed |
off |
off |
off |
off |
deny |
off |
off |
off |
off |
off |
| A0012 |
large-blobs |
no git-tracked file is over the size limit outside the allow list |
off |
off |
off |
off |
warn |
off |
off |
off |
off |
off |
irq
| Code |
Lint |
Rule |
small |
small-workspace |
medium |
big |
ai |
embedded |
ui |
egui |
units-strict |
units-paranoid |
| F0059 |
irq-1 |
interrupt handlers clear exactly the flags they handled |
off |
off |
off |
off |
off |
deny |
off |
off |
off |
off |
| F0060 |
irq-2 |
write-1-to-clear flags are cleared with a write, not modify() |
off |
off |
off |
off |
off |
deny |
off |
off |
off |
off |
| F0061 |
irq-4 |
no driver disables a shared interrupt vector that other drivers use |
off |
off |
off |
off |
off |
deny |
off |
off |
off |
off |
| F0062 |
irq-5 |
every routed interrupt line is enabled and has a handler bound |
off |
off |
off |
off |
off |
warn |
off |
off |
off |
off |
| F0063 |
irq-6 |
interrupts are disabled through critical sections, never nested by hand |
off |
off |
off |
off |
off |
warn |
off |
off |
off |
off |
| F0064 |
irq-8 |
the default interrupt handler records which IRQ fired |
off |
off |
off |
off |
off |
warn |
off |
off |
off |
off |
links
| Code |
Lint |
Rule |
small |
small-workspace |
medium |
big |
ai |
embedded |
ui |
egui |
units-strict |
units-paranoid |
| D0021 |
page-links |
a link between pages is a relative path to a Markdown file that exists |
deny |
deny |
deny |
deny |
off |
off |
off |
off |
off |
off |
log
| Code |
Lint |
Rule |
small |
small-workspace |
medium |
big |
ai |
embedded |
ui |
egui |
units-strict |
units-paranoid |
| F0065 |
log-1 |
RTT never blocks |
off |
off |
off |
off |
off |
deny |
off |
off |
off |
off |
| F0066 |
log-2 |
DEFMT_RTT_BUFFER_SIZE and DEFMT_LOG are set in .cargo/config.toml |
off |
off |
off |
off |
off |
warn |
off |
off |
off |
off |
machete
| Code |
Lint |
Rule |
small |
small-workspace |
medium |
big |
ai |
embedded |
ui |
egui |
units-strict |
units-paranoid |
| X0026 |
machete-unused-deps |
no crate declares a dependency its sources never use |
warn |
warn |
warn |
deny |
off |
off |
off |
off |
off |
off |
manifest
| Code |
Lint |
Rule |
small |
small-workspace |
medium |
big |
ai |
embedded |
ui |
egui |
units-strict |
units-paranoid |
| M0006 |
crate-docs |
every crate root opens with crate-level documentation |
warn |
warn |
warn |
deny |
off |
off |
off |
off |
off |
off |
| M0007 |
edition-latest |
every crate is on the current edition |
warn |
warn |
warn |
warn |
off |
off |
off |
off |
off |
off |
| M0008 |
feature-docs |
every cargo feature has a comment saying what it turns on |
off |
off |
off |
warn |
off |
off |
off |
off |
off |
off |
| M0009 |
package-description |
every crate has a description in its Cargo.toml |
warn |
warn |
warn |
deny |
off |
off |
off |
off |
off |
off |
| M0010 |
package-license |
every crate states its licence |
warn |
warn |
warn |
warn |
off |
off |
off |
off |
off |
off |
| M0011 |
publish-false |
workspace crates are publish = false unless listed as published |
off |
off |
warn |
warn |
off |
off |
off |
off |
off |
off |
| M0012 |
readme-per-crate |
every crate has a README |
warn |
deny |
deny |
deny |
off |
off |
off |
off |
off |
off |
| M0013 |
rust-version-set |
every crate declares its minimum Rust version |
off |
off |
warn |
deny |
off |
off |
off |
off |
off |
off |
| M0025 |
tier-clippy-set |
the project's [lints.clippy] and clippy.toml turn on the Clippy set its tiers expect, every opt-out with a reason |
warn |
warn |
deny |
deny |
off |
off |
off |
off |
off |
off |
| M0033 |
manifest-homepage |
the shared package keys set repository, and homepage is the book's site_url when it has one |
warn |
warn |
warn |
warn |
off |
off |
off |
off |
off |
off |
mem
| Code |
Lint |
Rule |
small |
small-workspace |
medium |
big |
ai |
embedded |
ui |
egui |
units-strict |
units-paranoid |
| F0067 |
mem-1 |
the FLASH region of memory.x leaves out the regions kept for other uses |
off |
off |
off |
off |
off |
deny |
off |
off |
off |
off |
| F0068 |
mem-10 |
no LOAD segment is writable and executable, and .rodata holds nothing writable |
off |
off |
off |
off |
off |
warn |
off |
off |
off |
off |
| F0069 |
mem-12 |
a firmware with defmt links with -Tdefmt.x |
off |
off |
off |
off |
off |
deny |
off |
off |
off |
off |
| F0070 |
mem-2 |
extra RAM sections end without a tail ALIGN or symbol |
off |
off |
off |
off |
off |
warn |
off |
off |
off |
off |
| F0071 |
mem-3 |
the RAM init and zeroing ranges stay clear of .uninit |
off |
off |
off |
off |
off |
deny |
off |
off |
off |
off |
| F0072 |
mem-6 |
.cnt_bkp_buffer sits at the backup-register address |
off |
off |
off |
off |
off |
warn |
off |
off |
off |
off |
| F0073 |
mem-7 |
embassy-boot partition symbols are offsets from the flash origin |
off |
off |
off |
off |
off |
warn |
off |
off |
off |
off |
pan
| Code |
Lint |
Rule |
small |
small-workspace |
medium |
big |
ai |
embedded |
ui |
egui |
units-strict |
units-paranoid |
| F0110 |
pan-1 |
every panic site of the release ELF is acknowledged with a reason |
off |
off |
off |
off |
off |
off |
off |
off |
off |
off |
perf
| Code |
Lint |
Rule |
small |
small-workspace |
medium |
big |
ai |
embedded |
ui |
egui |
units-strict |
units-paranoid |
| F0074 |
perf-2 |
hot paths on cores without 64-bit maths avoid it, and float formatting |
off |
off |
off |
off |
off |
warn |
off |
off |
off |
off |
| F0075 |
perf-3 |
RAM functions are #[inline(never)] |
off |
off |
off |
off |
off |
warn |
off |
off |
off |
off |
pin
| Code |
Lint |
Rule |
small |
small-workspace |
medium |
big |
ai |
embedded |
ui |
egui |
units-strict |
units-paranoid |
| F0076 |
pin-1 |
pin drivers live as long as the pin is used |
off |
off |
off |
off |
off |
deny |
off |
off |
off |
off |
| F0077 |
pin-16 |
pins held by a dead-battery pull-down are read only after it is released |
off |
off |
off |
off |
off |
warn |
off |
off |
off |
off |
| F0078 |
pin-2 |
the board is put in its safe state first thing after the HAL init |
off |
off |
off |
off |
off |
deny |
off |
off |
off |
off |
| F0079 |
pin-4 |
peripheral pins stay on their function while the peripheral is enabled |
off |
off |
off |
off |
off |
deny |
off |
off |
off |
off |
| F0080 |
pin-6 |
every pin has one owner |
off |
off |
off |
off |
off |
deny |
off |
off |
off |
off |
| F0081 |
pin-8 |
unused pins are analog or pulled, never floating inputs |
off |
off |
off |
off |
off |
warn |
off |
off |
off |
off |
| F0082 |
pin-9 |
the pin map comes from the board at run time, not from a cargo feature |
off |
off |
off |
off |
off |
deny |
off |
off |
off |
off |
prose
| Code |
Lint |
Rule |
small |
small-workspace |
medium |
big |
ai |
embedded |
ui |
egui |
units-strict |
units-paranoid |
| P0008 |
changelog-describes-diff |
a CHANGELOG entry says what changed for the user, not which code was edited |
off |
off |
off |
off |
warn |
off |
off |
off |
off |
off |
| P0009 |
changelog-entry-length |
a CHANGELOG entry is one short line |
warn |
warn |
warn |
warn |
deny |
off |
off |
off |
off |
off |
| P0010 |
emoji |
docs and comments carry no emoji |
off |
off |
off |
off |
warn |
off |
off |
off |
off |
off |
| P0011 |
filler-phrases |
docs and comments use no filler phrases |
off |
off |
off |
off |
deny |
off |
off |
off |
off |
off |
| P0012 |
narration |
docs and comments state facts, not how they were written |
off |
off |
off |
off |
deny |
off |
off |
off |
off |
off |
| P0013 |
paragraph-sentences |
paragraphs in docs stay short |
off |
off |
off |
off |
warn |
off |
off |
off |
off |
off |
| P0014 |
restating-comments |
a comment says what the code cannot |
off |
off |
off |
off |
warn |
off |
off |
off |
off |
off |
| P0015 |
sentence-words |
sentences in docs stay short |
off |
off |
off |
off |
warn |
off |
off |
off |
off |
off |
| P0016 |
thinking-comments |
comments state conclusions, not a stream of thought |
off |
off |
off |
off |
deny |
off |
off |
off |
off |
off |
| P0021 |
url-tracking-params |
a link in docs or a comment carries no tracking query parameter |
off |
off |
off |
off |
warn |
off |
off |
off |
off |
off |
pwr
| Code |
Lint |
Rule |
small |
small-workspace |
medium |
big |
ai |
embedded |
ui |
egui |
units-strict |
units-paranoid |
| F0083 |
pwr-1 |
a brown-out reset level or voltage detector fits the board's supply |
off |
off |
off |
off |
off |
warn |
off |
off |
off |
off |
| F0084 |
pwr-3 |
the backup domain is reset at boot when nothing keeps state there |
off |
off |
off |
off |
off |
warn |
off |
off |
off |
off |
| F0085 |
pwr-4 |
a firmware that keeps state in the backup domain never changes the RTC clock source |
off |
off |
off |
off |
off |
warn |
off |
off |
off |
off |
reading
| Code |
Lint |
Rule |
small |
small-workspace |
medium |
big |
ai |
embedded |
ui |
egui |
units-strict |
units-paranoid |
| D0001 |
prose-run-words |
prose between two visual breaks stays short |
warn |
warn |
warn |
warn |
off |
off |
off |
off |
off |
off |
| D0002 |
page-reading-time |
a guide reads in a bounded time |
warn |
warn |
warn |
warn |
off |
off |
off |
off |
off |
off |
| D0003 |
heading-words |
a heading is a short name, not a sentence |
warn |
warn |
warn |
warn |
off |
off |
off |
off |
off |
off |
| D0004 |
page-headings |
a long page is divided into sections |
warn |
warn |
warn |
warn |
off |
off |
off |
off |
off |
off |
| D0005 |
code-wall |
code comes with prose that explains it |
warn |
warn |
warn |
warn |
off |
off |
off |
off |
off |
off |
| D0006 |
image-alt |
every image has alternative text |
warn |
warn |
warn |
warn |
off |
off |
off |
off |
off |
off |
| D0007 |
code-block-language |
every code block names its language |
warn |
warn |
warn |
warn |
off |
off |
off |
off |
off |
off |
repo
| Code |
Lint |
Rule |
small |
small-workspace |
medium |
big |
ai |
embedded |
ui |
egui |
units-strict |
units-paranoid |
| M0014 |
changelog-unreleased |
CHANGELOG.md has an Unreleased section |
warn |
warn |
warn |
warn |
off |
off |
off |
off |
off |
off |
| M0015 |
justfile-recipes |
the justfile has the standard recipes |
warn |
warn |
warn |
warn |
off |
off |
off |
off |
off |
off |
| M0016 |
justfile-simple |
justfile recipes only call programs: a few lines, no inline scripts |
off |
off |
off |
warn |
off |
off |
off |
off |
off |
off |
| M0017 |
profile-defaults |
the dev profile splits debug info and a deploy profile builds incrementally |
warn |
warn |
warn |
warn |
off |
off |
off |
off |
off |
off |
| M0018 |
repo-files |
the repo carries its rule files |
warn |
warn |
warn |
warn |
deny |
off |
off |
off |
off |
off |
| M0019 |
toolchain-pinned |
the repo pins its toolchain in rust-toolchain.toml |
off |
off |
warn |
deny |
off |
off |
off |
off |
off |
off |
| M0026 |
profile-no-lto |
the profiles of the edit-build-test loop and the deploy profile build without LTO |
warn |
warn |
warn |
warn |
off |
off |
off |
off |
off |
off |
| M0028 |
test-binaries |
a crate builds its integration tests as one binary |
off |
off |
warn |
warn |
off |
off |
off |
off |
off |
off |
| M0031 |
fuzz-corpus-test |
every fuzz target has a corpus tracked in git and a test that replays it |
off |
off |
warn |
warn |
off |
off |
off |
off |
off |
off |
| M0032 |
ci-workflow |
the repo has a CI workflow and it runs the repo's checks |
off |
warn |
warn |
warn |
off |
off |
off |
off |
off |
off |
| M0034 |
readme-badges |
the README carries a badge for the book, CI and every published crate, each linking to its target |
warn |
warn |
warn |
warn |
off |
off |
off |
off |
off |
off |
rustfmt
| Code |
Lint |
Rule |
small |
small-workspace |
medium |
big |
ai |
embedded |
ui |
egui |
units-strict |
units-paranoid |
| X0027 |
rustfmt-unformatted |
every Rust file is formatted the way cargo fmt writes it |
off |
off |
off |
off |
off |
off |
off |
off |
off |
off |
semver
| Code |
Lint |
Rule |
small |
small-workspace |
medium |
big |
ai |
embedded |
ui |
egui |
units-strict |
units-paranoid |
| X0028 |
semver-checks-breaking |
a stable crate changes its public API only with the version bump the change needs |
off |
off |
off |
deny |
off |
off |
off |
off |
off |
off |
shear
| Code |
Lint |
Rule |
small |
small-workspace |
medium |
big |
ai |
embedded |
ui |
egui |
units-strict |
units-paranoid |
| X0029 |
shear-misplaced-deps |
a dependency only tests use is a dev-dependency |
off |
off |
off |
off |
off |
off |
off |
off |
off |
off |
| X0030 |
shear-unused-deps |
no crate declares a dependency it never uses, and every workspace dependency is used |
off |
off |
off |
off |
off |
off |
off |
off |
off |
off |
siz
| Code |
Lint |
Rule |
small |
small-workspace |
medium |
big |
ai |
embedded |
ui |
egui |
units-strict |
units-paranoid |
| F0086 |
siz-1 |
flash and RAM regions stay under a fill limit |
off |
off |
off |
off |
off |
warn |
off |
off |
off |
off |
| F0087 |
siz-3 |
no per-package opt-level beside lto = "fat" |
off |
off |
off |
off |
off |
warn |
off |
off |
off |
off |
| F0088 |
siz-4 |
the release profile sets codegen-units = 1, lto, panic = "abort" and a measured opt-level |
off |
off |
off |
off |
off |
warn |
off |
off |
off |
off |
| F0089 |
siz-5 |
core::fmt stays out of the firmware |
off |
off |
off |
off |
off |
warn |
off |
off |
off |
off |
| F0090 |
siz-6 |
no large .data initializer |
off |
off |
off |
off |
off |
warn |
off |
off |
off |
off |
size
| Code |
Lint |
Rule |
small |
small-workspace |
medium |
big |
ai |
embedded |
ui |
egui |
units-strict |
units-paranoid |
| S0001 |
crate-lines |
a crate's src/ stays under its line limit |
off |
off |
warn |
warn |
off |
off |
off |
off |
off |
off |
| S0002 |
function-complexity |
a function's cyclomatic complexity stays under its limit |
warn |
warn |
warn |
warn |
off |
off |
off |
off |
off |
off |
| S0003 |
function-lines |
a function stays under its line limit |
warn |
warn |
warn |
warn |
off |
off |
off |
off |
off |
off |
| S0004 |
module-lines |
a source file stays under its line limit |
off |
off |
warn |
warn |
off |
off |
off |
off |
off |
off |
| S0005 |
test-lines |
a crate's test code stays under its line limit |
off |
off |
off |
warn |
off |
off |
off |
off |
off |
off |
| S0006 |
crate-folder-size |
a folder holds no more crate folders than its limit |
off |
off |
warn |
deny |
off |
off |
off |
off |
off |
off |
state
| Code |
Lint |
Rule |
small |
small-workspace |
medium |
big |
ai |
embedded |
ui |
egui |
units-strict |
units-paranoid |
| T0001 |
lock-held-across |
no lock guard is held across an .await or an I/O call |
warn |
warn |
warn |
deny |
off |
off |
off |
off |
off |
off |
| T0002 |
lock-unwrap |
a crate keeps its lock().unwrap() calls under a limit |
off |
off |
warn |
warn |
off |
off |
off |
off |
off |
off |
| T0003 |
nested-locks |
no second lock is taken while a guard is alive |
off |
warn |
warn |
warn |
off |
off |
off |
off |
off |
off |
| T0004 |
static-interior-mutability |
a static with interior mutability has one owner, or a reason why a global lock is right |
warn |
warn |
warn |
deny |
off |
off |
off |
off |
off |
off |
| T0005 |
static-mut |
no static mut |
deny |
deny |
deny |
deny |
off |
off |
off |
off |
off |
off |
| T0006 |
thread-local-state |
thread_local! state has one owner, or a reason |
off |
warn |
warn |
warn |
off |
off |
off |
off |
off |
off |
stk
| Code |
Lint |
Rule |
small |
small-workspace |
medium |
big |
ai |
embedded |
ui |
egui |
units-strict |
units-paranoid |
| F0091 |
stk-1 |
flip-link is the linker |
off |
off |
off |
off |
off |
deny |
off |
off |
off |
off |
| F0092 |
stk-2 |
build.rs prints only directives Cargo knows |
off |
off |
off |
off |
off |
deny |
off |
off |
off |
off |
| F0093 |
stk-3 |
the stack sits below .data and .bss and is not empty |
off |
off |
off |
off |
off |
deny |
off |
off |
off |
off |
| F0094 |
stk-4 |
cortex-m-rt paint-stack stays off |
off |
off |
off |
off |
off |
deny |
off |
off |
off |
off |
| F0095 |
stk-5 |
big state is built in place, not by value and moved into a static |
off |
off |
off |
off |
off |
warn |
off |
off |
off |
off |
| F0096 |
stk-6 |
every stack frame stays within its budget and the deepest call chain within the stack |
off |
off |
off |
off |
off |
warn |
off |
off |
off |
off |
stop-gap
| Code |
Lint |
Rule |
small |
small-workspace |
medium |
big |
ai |
embedded |
ui |
egui |
units-strict |
units-paranoid |
| A0005 |
commented-out-code |
no code is left commented out |
off |
off |
off |
off |
deny |
off |
off |
off |
off |
off |
| A0006 |
dead-features |
every cargo feature enables something or is tested by a cfg |
off |
off |
off |
off |
warn |
off |
off |
off |
off |
off |
| A0007 |
lint-table-allow-reason |
a lint allowed in a Cargo.toml [lints] table says why in a comment |
off |
off |
off |
off |
deny |
off |
off |
off |
off |
off |
| A0008 |
near-duplicate-fns |
no two functions are near copies of each other |
off |
off |
off |
off |
warn |
off |
off |
off |
off |
off |
| A0009 |
near-duplicate-modules |
no two modules are near copies of each other |
off |
off |
off |
off |
deny |
off |
off |
off |
off |
off |
| A0010 |
stop-gap-comments |
comments carry no stop-gap markers: TODO, HACK, for now, workaround |
off |
off |
off |
deny |
deny |
off |
off |
off |
off |
off |
| A0011 |
fixme-before-land |
no FIXME is left when a branch lands |
off |
off |
off |
deny |
deny |
off |
off |
off |
off |
off |
structure
| Code |
Lint |
Rule |
small |
small-workspace |
medium |
big |
ai |
embedded |
ui |
egui |
units-strict |
units-paranoid |
| C0011 |
module-graph-scc |
no module cycle holds most of a crate's code |
off |
off |
warn |
warn |
off |
off |
off |
off |
off |
off |
| C0016 |
orphan-source-file |
every .rs file under src/ is reached by a mod declaration |
off |
off |
warn |
deny |
off |
off |
off |
off |
off |
off |
taplo
| Code |
Lint |
Rule |
small |
small-workspace |
medium |
big |
ai |
embedded |
ui |
egui |
units-strict |
units-paranoid |
| X0031 |
taplo-fmt |
every TOML file parses and is formatted as taplo writes it |
off |
warn |
warn |
deny |
off |
off |
off |
off |
off |
off |
| Code |
Lint |
Rule |
small |
small-workspace |
medium |
big |
ai |
embedded |
ui |
egui |
units-strict |
units-paranoid |
| X0034 |
tool-version |
every external tool an enabled lint runs is a version its output is tested against |
deny |
deny |
deny |
deny |
off |
off |
off |
off |
off |
off |
typos
| Code |
Lint |
Rule |
small |
small-workspace |
medium |
big |
ai |
embedded |
ui |
egui |
units-strict |
units-paranoid |
| X0032 |
typos-misspelling |
no misspelled word in code, comments, docs or file names |
warn |
warn |
warn |
deny |
off |
off |
off |
off |
off |
off |
udeps
| Code |
Lint |
Rule |
small |
small-workspace |
medium |
big |
ai |
embedded |
ui |
egui |
units-strict |
units-paranoid |
| X0033 |
udeps-unused-deps |
no crate declares a dependency the compiler never loads |
off |
off |
off |
off |
off |
off |
off |
off |
off |
off |
ui
| Code |
Lint |
Rule |
small |
small-workspace |
medium |
big |
ai |
embedded |
ui |
egui |
units-strict |
units-paranoid |
| U0001 |
ui-raw-spawn |
UI code starts threads and tasks only through the project's spawn wrapper |
off |
off |
off |
off |
off |
off |
warn |
warn |
off |
off |
| U0002 |
ui-blocking-call |
UI code never blocks the UI thread on files, the network, processes or sleeps |
off |
off |
off |
off |
off |
off |
warn |
warn |
off |
off |
| U0003 |
ui-colour-literal |
UI code takes its colours from the theme, never writes them as values |
off |
off |
off |
off |
off |
off |
warn |
warn |
off |
off |
| U0004 |
ui-size-literal |
UI code takes spacing, sizes, radii and type sizes from the theme, never writes them as numbers |
off |
off |
off |
off |
off |
off |
warn |
warn |
off |
off |
| U0005 |
ui-disabled-without-reason |
a disabled control says why and what would enable it |
off |
off |
off |
off |
off |
off |
warn |
warn |
off |
off |
| U0006 |
ui-destructive-unconfirmed |
a control that throws work away asks first or can be undone |
off |
off |
off |
off |
off |
off |
warn |
warn |
off |
off |
| U0007 |
ui-more-count |
a cut list ends in a fold that opens to every item, never in "N more" |
off |
off |
off |
off |
off |
off |
warn |
warn |
off |
off |
| U0008 |
ui-label-punctuation |
UI text writes the ellipsis as one character and button labels end without a full stop |
off |
off |
off |
off |
off |
off |
deny |
deny |
off |
off |
| U0009 |
ui-debug-text |
text shown to a person never holds Rust's debug formatting |
off |
off |
off |
off |
off |
off |
warn |
warn |
off |
off |
| U0014 |
ui-unwrap-external-data |
UI code returns an error for a bad file, parse or connection, never unwraps or expects it |
off |
off |
off |
off |
off |
off |
warn |
warn |
off |
off |
| U0017 |
ui-tooltip-repeats-label |
a tooltip says more than the label it is attached to |
off |
off |
off |
off |
off |
off |
warn |
warn |
off |
off |
| U0018 |
ui-locale-strings |
string literals shown to a person come from the translation catalogue, not written in the call |
off |
off |
off |
off |
off |
off |
off |
off |
off |
off |
| U0019 |
ui-hover-text |
an icon-only or glyph button says what it does in a tooltip |
off |
off |
off |
off |
off |
off |
warn |
warn |
off |
off |
units
| Code |
Lint |
Rule |
small |
small-workspace |
medium |
big |
ai |
embedded |
ui |
egui |
units-strict |
units-paranoid |
| C0033 |
exact-units-quantity |
a number that holds a physical or dimensionless quantity carries its unit in its type |
warn |
warn |
warn |
warn |
off |
off |
off |
off |
off |
off |
| C0034 |
exact-units-plain-number |
an index, a count, a sequence number or a duration carries what it counts in its type |
off |
off |
off |
off |
off |
off |
off |
off |
warn |
warn |
| C0035 |
exact-units-bounds |
a number whose range the code knows says it in its type |
warn |
warn |
warn |
warn |
off |
off |
off |
off |
off |
off |
| C0036 |
exact-units-in-bodies |
inside functions too, a quantity stays typed: no unit-named locals or literal arguments, casts, float maths, bare comparisons, raw arithmetic, scale constants or conversions by hand |
off |
off |
off |
off |
off |
off |
off |
off |
off |
warn |
usb
| Code |
Lint |
Rule |
small |
small-workspace |
medium |
big |
ai |
embedded |
ui |
egui |
units-strict |
units-paranoid |
| F0097 |
usb-1 |
high-speed bulk endpoints have 512-byte packets and bIntervals in range |
off |
off |
off |
off |
off |
deny |
off |
off |
off |
off |
| F0098 |
usb-3 |
bulk endpoints on a hot path are double-buffered |
off |
off |
off |
off |
off |
warn |
off |
off |
off |
off |
waivers
| Code |
Lint |
Rule |
small |
small-workspace |
medium |
big |
ai |
embedded |
ui |
egui |
units-strict |
units-paranoid |
| C0012 |
waiver-invalid |
a waiver comment names known lints, gives a reason and has not expired |
deny |
deny |
deny |
deny |
off |
off |
off |
off |
off |
off |
| C0013 |
waiver-unused |
every waiver comment allows a finding |
warn |
warn |
warn |
deny |
off |
off |
off |
off |
off |
off |
words
| Code |
Lint |
Rule |
small |
small-workspace |
medium |
big |
ai |
embedded |
ui |
egui |
units-strict |
units-paranoid |
| D0012 |
abbreviation-first-use |
an abbreviation is spelled out at its first use on a page |
warn |
warn |
warn |
warn |
off |
off |
off |
off |
off |
off |
| D0013 |
term-before-definition |
a page defines a term before it uses it |
warn |
warn |
warn |
warn |
off |
off |
off |
off |
off |
off |
| D0014 |
term-synonyms |
one concept has one name |
warn |
warn |
warn |
warn |
off |
off |
off |
off |
off |
off |
| D0015 |
passive-voice |
a guide says who does what: few passive sentences |
warn |
warn |
warn |
warn |
off |
off |
off |
off |
off |
off |
| D0016 |
reading-ease |
a guide reads easily: short sentences of short words |
warn |
warn |
warn |
warn |
off |
off |
off |
off |
off |
off |
workspace
| Code |
Lint |
Rule |
small |
small-workspace |
medium |
big |
ai |
embedded |
ui |
egui |
units-strict |
units-paranoid |
| M0020 |
crate-dir-name |
a member's directory is named after its crate |
off |
warn |
warn |
warn |
off |
off |
off |
off |
off |
off |
| M0021 |
macro-crate-suffix |
proc-macro crates and only they end in _macros or _derive |
off |
warn |
warn |
warn |
off |
off |
off |
off |
off |
off |
| M0022 |
workspace-dependencies |
members take every dependency from [workspace.dependencies] |
off |
warn |
deny |
deny |
off |
off |
off |
off |
off |
off |
| M0023 |
workspace-inheritance |
members inherit the shared package keys from [workspace.package] |
off |
deny |
deny |
deny |
off |
off |
off |
off |
off |
off |
| M0024 |
workspace-lints |
the root declares [workspace.lints] and every member inherits them |
off |
deny |
deny |
deny |
off |
off |
off |
off |
off |
off |
| M0029 |
macro-compile-fail |
every proc-macro crate has compile-fail tests |
off |
off |
warn |
warn |
off |
off |
off |
off |
off |
off |
| M0030 |
contract-snapshot |
a contract crate exports its version and keeps every version's schema snapshot in git, unchanged once in the base |
off |
off |
off |
deny |
off |
off |
off |
off |
off |
off |