Expand description
Tidy check to enforce various stylistic guidelines on the Rust codebase.
Example checks are:
- No lines over 100 characters (in non-Rust files).
- No files with over 3000 lines (in non-Rust files).
- No tabs.
- No trailing whitespace.
- No CR characters.
- No
TODO
orXXX
directives. - No unexplained
```ignore
or```rust,ignore
doc tests.
Note that some of these rules are excluded from Rust files because we enforce rustfmt. It is preferable to be formatted rather than tidy-clean.
A number of these checks can be opted-out of with various directives of the form:
// ignore-tidy-CHECK-NAME
.
MacrosΒ§
EnumsΒ§
ConstantsΒ§
- ANNOTATIONS_
TO_ πIGNORE - COLS π
- CONFIGURABLE_
CHECKS π - DOUBLE_
SPACE_ πAFTER_ DOT - ERROR_
CODE_ πCOLS - Error code markdown is restricted to 80 columns because they can be displayed on the console with βexample.
- GOML_
COLS π - INTERNAL_
COMPILER_ πDOCS_ LINE - LETTER_
DIGIT π - LINELENGTH_
CHECK π - LINES π
- LLVM_
UNREACHABLE_ πINFO - ROOT_
PROBLEMATIC_ πCONSTS - UNEXPLAINED_
IGNORE_ πDOCTEST_ INFO
StaticsΒ§
FunctionsΒ§
- check
- contains_
ignore_ πdirectives - contains_
problematic_ πconst - generate_
problematic_ πstrings - generate_
problems π - is_in
- is_
unexplained_ πignore - line_
is_ πurl - Returns
true
ifline
appears to be a line comment containing a URL, possibly with a Markdown link label in front, and nothing else. The Markdown link label, if present, may not contain whitespace. Lines of this form are allowed to be overlength, because Markdown offers no way to split a line in the middle of a URL, and the lengths of URLs to external references are beyond our control. - long_
line_ πis_ ok - Returns
true
ifline
is allowed to be longer than the normal limit. - should_
ignore π - Returns
true
ifline
can be ignored. This is the case when it contains an annotation that is explicitly ignored. - skip_
markdown_ πpath