Expand description
Library used by tidy and other tools.
This library contains the tidy lints and exposes it to be used by tools.
Modules§
- alphabetical
- Checks that a list of items is in alphabetical order
- bins
- Tidy check to ensure that there are no binaries checked into the source tree by accident.
- debug_
artifacts - Tidy check to prevent creation of unnecessary debug artifacts while running tests.
- deps
- Checks the licenses of third-party dependencies.
- edition
- Tidy check to ensure that crate
edition
is ‘2021’ or ‘2024’. - error_
codes - Tidy check to ensure error codes are properly documented and tested.
- ext_
tool_ checks - Optional checks for file types other than Rust source
- extdeps
- Check for external package sources. Allow only vendorable packages.
- features
- Tidy check to ensure that unstable features are all in order.
- fluent_
alphabetical - Checks that all Flunt files have messages in alphabetical order
- fluent_
period - Checks that no Fluent messages or attributes end in periods (except ellipses)
- fluent_
used 🔒 - Checks that all Fluent messages appear at least twice
- iter_
header 🔒 - known_
bug - Tidy check to ensure that tests inside ‘tests/crashes’ have a ‘@known-bug’ directive.
- mir_
opt_ tests - Tidy check to ensure that mir opt directories do not have stale files or dashes in file names
- pal
- Tidy check to enforce rules about platform-specific code in std.
- run_
make_ tests - Tidy check to ensure that no new Makefiles are added under
tests/run-make/
. - rustdoc_
css_ themes - Tidy check to make sure light and dark themes are synchronized between JS-controlled rustdoc.css and noscript.css
- rustdoc_
gui_ tests - Tidy check to ensure that rustdoc GUI tests start with a small description.
- rustdoc_
templates - Tidy check to ensure that rustdoc templates didn’t forget a
{# #}
to strip extra whitespace characters. - style
- Tidy check to enforce various stylistic guidelines on the Rust codebase.
- target_
policy - Tests for target tier policy compliance.
- target_
specific_ tests - Tidy check to ensure that all target specific tests (those that require a
--target
flag) also require the pre-requisite LLVM components to run. - tests_
placement - tests_
revision_ unpaired_ stdout_ stderr - Checks that there are no unpaired
.stderr
or.stdout
for a test with and without revisions. - ui_
tests - Tidy check to ensure below in UI test directories:
- unit_
tests - Tidy check to ensure
#[test]
and#[bench]
are not used directly insidecore
. - unknown_
revision - Checks that test revision names appearing in header directives and error
annotations have actually been declared in
revisions
. - unstable_
book - walk
- x_
version
Macros§
- static_
regex 🔒 - t
- A helper macro to
unwrap
a result except also print out details like: - tidy_
error 🔒 - tidy_
error_ 🔒ext