ui¶
User interfaces of any toolkit: theme colours and sizes, disabled controls with a reason, confirmed destructive actions, no blocking or raw spawns on the UI thread, wording.
Use it with extends = "ui" in spirit_level.toml.
Lints enabled (with what it extends)¶
| Code | Lint | Level | Reason | Set in |
|---|---|---|---|---|
| U0001 | ui-raw-spawn | warn |
work started outside the spawn wrapper has no name, no crash report and no repaint; warn while toolkits ship no wrapper | ui |
| U0002 | ui-blocking-call | warn |
a blocking call on the UI thread freezes the window; an estimate, since a function may run on a worker that the lint does not see | ui |
| U0003 | ui-colour-literal | warn |
a colour written as a value ignores the theme and the light and dark modes | ui |
| U0004 | ui-size-literal | warn |
sizes written as numbers drift apart between screens and apps | ui |
| U0005 | ui-disabled-without-reason | warn |
a greyed-out control that does not say why leaves the person guessing | ui |
| U0006 | ui-destructive-unconfirmed | warn |
one tap must not throw work away; an estimate, since the confirmation may live elsewhere | ui |
| U0007 | ui-more-count | warn |
"N more" hides items the person may need; a fold shows them on demand | ui |
| U0008 | ui-label-punctuation | deny |
one way to write the ellipsis and button labels; certain, rare, and spl check --fix applies it |
ui |
| U0009 | ui-debug-text | warn |
Rust's debug form is for developers; a person reads what happened and what to do | ui |
| U0014 | ui-unwrap-external-data | warn |
panic-in-library skips binary crates; a UI app's bad file, parse or connection still deserves an error, not a crash; an estimate, since the chain may be known good or already checked | ui |
| U0017 | ui-tooltip-repeats-label | warn |
a tooltip that only repeats the label cost the person a hover for nothing; certain, since the match is exact | ui |
| U0019 | ui-hover-text | warn |
an icon-only button with no tooltip has no words at all; a candidate, since a short label may be a real word or get help another way | ui |
The file¶
# Beside the size tiers: an app with a user interface extends ["medium", "ui"]. The practices of any UI, as lints
# that know no toolkit: the calls each looks for are parameters, empty here where they name a toolkit's calls. The
# egui tier fills them. Most lints start at warn: they fire on code written before the practice was written down
# (colours and sizes by the dozen per app), and most are estimates (they cannot see types).
[tier]
description = "User interfaces of any toolkit: theme colours and sizes, disabled controls with a reason, confirmed destructive actions, no blocking or raw spawns on the UI thread, wording"
[lints.ui-raw-spawn]
level = "warn"
reason = "work started outside the spawn wrapper has no name, no crash report and no repaint; warn while toolkits ship no wrapper"
[lints.ui-blocking-call]
level = "warn"
reason = "a blocking call on the UI thread freezes the window; an estimate, since a function may run on a worker that the lint does not see"
[lints.ui-colour-literal]
level = "warn"
reason = "a colour written as a value ignores the theme and the light and dark modes"
[lints.ui-size-literal]
level = "warn"
reason = "sizes written as numbers drift apart between screens and apps"
[lints.ui-disabled-without-reason]
level = "warn"
reason = "a greyed-out control that does not say why leaves the person guessing"
[lints.ui-destructive-unconfirmed]
level = "warn"
reason = "one tap must not throw work away; an estimate, since the confirmation may live elsewhere"
[lints.ui-more-count]
level = "warn"
reason = "\"N more\" hides items the person may need; a fold shows them on demand"
[lints.ui-label-punctuation]
level = "deny"
reason = "one way to write the ellipsis and button labels; certain, rare, and `spl check --fix` applies it"
[lints.ui-debug-text]
level = "warn"
reason = "Rust's debug form is for developers; a person reads what happened and what to do"
[lints.ui-unwrap-external-data]
level = "warn"
reason = "panic-in-library skips binary crates; a UI app's bad file, parse or connection still deserves an error, not a crash; an estimate, since the chain may be known good or already checked"
[lints.ui-tooltip-repeats-label]
level = "warn"
reason = "a tooltip that only repeats the label cost the person a hover for nothing; certain, since the match is exact"
[lints.ui-locale-strings]
level = "allow"
reason = "opt-in: a project that has not started translating its UI would see this fire on every label; a project that translates turns it on"
[lints.ui-hover-text]
level = "warn"
reason = "an icon-only button with no tooltip has no words at all; a candidate, since a short label may be a real word or get help another way"