lint 最早用于 C 语言,是一种用来检查代码的工具,现在的主流编程语言几乎都有 lint 可以使用,尤其是 JavaScript、Python 等直译式编程语言,因为它们的代码不会经过编译,所以特别需要使用 lint 来检查源代码。借由 lint,我们可以写出疑虑较少、性能更好或是更容易阅读的代码。Rust 编程语言虽然是静态类型的编程语言,而且拥有十分严谨的编译器,但官方还是提供了一个 lint 工具──Clippy。
使用 clippy
clippy 的使用方法很简单,建议透过以下指令来运行:
替 cargo clippy 指令加上 --tests 参数,可以让它去检查测试用的 Rust 代码,如果需要的话,也可以加上 --features、--all-features 或 --no-default-features 参数来激活特色。clippy 工具本身的 -W 参数可以用来设置要将哪一个的 lint 分类或是规则改设为「警告」(warn)层级,就会输出不符合该规则的位置,但不影响进程运行结束后回传的 Exit Status;-A 参数可以用来设置要将哪一个的 lint 分类或是规则改设为「允许」(allow)层级,就不会输出不符合该规则的位置;-D 参数可以用来设置要将哪一个的 lint 分类或是规则改设为「拒绝」(deny)层级,就会输出不符合该规则的位置,且影响进程运行结束后回传的 Exit Status。
clippy 的 lint 规则分类有以下几项:
clippy::correctness:错误或是无用的代码,预设为「拒绝」层级。clippy::style:不合乎(官方)习惯的代码,预设为「警告」层级。clippy::complexity:可以被简化的代码,预设为「警告」层级。clippy::perf:可以被加速的代码,预设为「警告」层级。clippy::all:即表示以上四个分类。方便整体控制层级用的,例如-D clippy::all就是-D clippy::correctness -D clippy::style -D clippy::complexity -D clippy::perf。clippy::restriction:代码语法结构与风格的规则,预设为「允许」层级。可能会与以上分类的规则有所冲突。clippy::cargo:Cargo 设置档(即Cargo.toml),预设为「允许」层级。Clippy 可以检查 Cargo 设置档中缺失的设置项目,和相依 crate 的版本问题。clippy::pedantic:其它比较严格的规则,预设为「允许」层级。clippy::nursery:尚未稳定的规则,预设为「允许」层级。
所有的 lint 规则,以及规定原因都可以来这个网页查找。
利用属性来设置 lint 规则
借由 #[allow(...)]、#[warn(...)]、#[deny(...)] 属性,我们可以在 Rust 代码中临时设置 lint 规则。
例如:
fn main(){
let x: u64 = 61864918973511;
println!("{}", x);
}
以上程序的第二行叙述会触犯 clippy::unreadable_literal 规则,如果要针对这个 x 变量避免 Clippy 出现警告,可以对其加上 #[allow(clippy::unreadable_literal)] 属性。如下:
fn main(){
#[allow(clippy::unreadable_literal)]
let x: u64 = 61864918973511;
println!("{}", x);
}
可配置的 lint 规则
有些 lint 规则可以透过 Clippy 的设置档来指定参数。cargo clippy 指令在运行的时候,首先会寻找工作目录中是否有 .clippy.toml 文件,如果有的话就会将其作为 clippy 的设置档,如果没有的话就会再寻找工作目录中是否有 clippy.toml 文件,如果还是没有的话,就会去寻找上层目录是否有 .clippy.toml 和 clippy.toml 文件,依此类推。
可以被配置的 lint 规则如下:
blacklisted-names = ["foo", "bar", "baz", "quux"] # clippy::blacklisted_name
cognitive-complexity-threshold = 25 # clippy::cognitive_complexity
doc-valid-idents = ["KiB", "MiB", "GiB", "TiB", "PiB", "EiB", "DirectX", "ECMAScript", "GPLv2", "GPLv3", "GitHub", "GitLab", "IPv4", "IPv6", "JavaScript", "NaN", "NaNs", "OAuth", "OpenGL", "OpenSSH", "OpenSSL", "OpenStreetMap", "TrueType", "iOS", "macOS", "TeX", "LaTeX", "BibTeX", "BibLaTeX", "MinGW", "CamelCase"] # clippy::doc_markdown
enum-variant-name-threshold = 3 # clippy::enum_variant_names
enum-variant-size-threshold = 200 # clippy::large_enum_variant
single-char-binding-names-threshold = 5 # clippy::many_single_char_names
too-large-for-stack = 200 # clippy::boxed_local
too-many-arguments-threshold = 7 # clippy::too_many_arguments
trivial-copy-size-limit = 1 # clippy::trivially_copy_pass_by_ref
type-complexity-threshold = 250 # clippy::type_complexity
verbose-bit-mask-threshold = 1 # clippy::verbose_bit_mask
# too-many-lines-threshold = 100 # clippy::too_many_lines (pedantic)
