Clippy

一组用于捕获常见错误并改进您的 Rust 代码的代码检查。

此crate中包含700多个代码检查！

代码检查分为类别，每个类别都有一个默认的 代码检查级别。您可以通过更改类别中的代码检查级别来选择Clippy应该有多大的帮助。

敬请期待，如果您有任何想法，请提交一个issue！

restriction类别应该绝对不应该整体启用。其中包含的lint可能会对完全合理的代码进行检查，可能没有替代建议，并且可能与任何其他lint（包括其他类别）相矛盾。启用之前，应逐个案例考虑。

[^restrict]：restrictionlint的一些用例包括：- 严格的编码风格（例如clippy::else_if_without_else）。- CI上的附加限制（例如clippy::todo）。- 防止某些函数中的panic（例如clippy::unwrap_used）。- 仅在代码子集上运行lint（例如在模块上使用#[forbid(clippy::float_arithmetic)]）。

目录

• 使用说明
• 配置
• 贡献
• 许可证

使用方法

以下是作为cargo子命令使用Clippy、在未使用cargo的项目中或Travis CI中的说明。

作为cargo子命令（cargo clippy）

使用Clippy的一种方法是通过rustup将其作为cargo子命令安装。

步骤1：安装Rustup

您可以在支持的平台上安装Rustup。这将帮助我们安装Clippy及其依赖项。

如果您已经安装了Rustup，请更新以确保您有最新的Rustup和编译器

rustup update

步骤2：安装Clippy

一旦您安装了rustup和最新的稳定版本（至少Rust 1.29），请运行以下命令

rustup component add clippy

如果它说找不到clippy组件，请运行rustup self update。

步骤3：运行Clippy

现在您可以通过以下命令调用Clippy

cargo clippy

自动应用Clippy建议

Clippy可以像编译器一样自动应用一些lint建议。请注意，--fix意味着--all-targets，因此它可以修复尽可能多的代码。

cargo clippy --fix

工作区

所有常规工作区选项都应与Clippy一起使用。例如，以下命令将在examplecrate上运行Clippy

cargo clippy -p example

与cargo check一样，这包括工作区成员的依赖项，如路径依赖项。如果您只想在指定的crate上运行Clippy，请使用--no-deps选项，如下所示

cargo clippy -p example -- --no-deps

使用clippy-driver

Clippy也可以在不使用cargo的项目中使用。要这样做，请使用与rustc相同的参数运行clippy-driver。例如

clippy-driver --edition 2018 -Cpanic=abort foo.rs

请注意，clippy-driver是为仅运行Clippy而设计的，不应用作rustc的一般替代品。clippy-driver可能产生的工件可能无法按预期优化，例如。

Travis CI

您可以通过与本地使用相同的方式将Clippy添加到Travis CI中

language: rust
rust:
  - stable
  - beta
before_script:
  - rustup component add clippy
script:
  - cargo clippy
  # if you want the build job to fail when encountering warnings, use
  - cargo clippy -- -D warnings
  # in order to also check tests and non-default crate features, use
  - cargo clippy --all-targets --all-features -- -D warnings
  - cargo test
  # etc.

请注意，添加 -D 警告 将会导致您的构建失败，如果您的代码中存在任何警告。这包括 rustc 发现的警告（例如，dead_code 等）。如果您想避免这种情况，并且只想对 Clippy 警告引发错误，请在您的代码中使用 #![deny(clippy::all)]，或在命令行上使用 -D clippy::all。（您可以将 clippy::all 与您要针对的具体 lint 类别进行交换。）

配置

允许/拒绝 lint

您可以在代码中添加选项来 allow / warn / deny Clippy lints

• 使用 clippy lint 组（#![deny(clippy::all)]）来允许整个 Warn lints 集合。请注意，rustc 有额外的 lint 组。

• 使用 clippy 和 clippy::pedantic lint 组（#![deny(clippy::all)]，#![deny(clippy::pedantic)]）允许所有 lint。注意，clippy::pedantic 包含一些非常激进的 lint，容易出现误报。

• 只允许某些 lint（例如，#![deny(clippy::single_match, clippy::box_vec)] 等）

• 使用 #[allow(...)] 等限制 allow / warn / deny 到单个函数或模块。

注意：allow 表示抑制您的代码中的 lint。使用 warn 时，lint 将仅发出警告，而使用 deny 时，lint 将在触发您的代码时发出错误。错误会导致 Clippy 以错误代码退出，因此在 CI/CD 等脚本中非常有用。

如果您不想在代码中包含您的 lint 级别，您可以在运行 Clippy 时通过传递额外的标志来全局启用/禁用 lints

要允许 lint_name，运行

cargo clippy -- -A clippy::lint_name

要警告 lint_name，运行

cargo clippy -- -W clippy::lint_name

这也可以与lint组一起工作。例如，你可以运行Clippy，对所有lint启用警告

cargo clippy -- -W clippy::pedantic

如果你只关心一个lint，你可以允许所有其他lint，然后明确警告你感兴趣的lint(s)

cargo clippy -- -A clippy::all -W clippy::useless_format -W clippy::...

配置一些lint的行为

一些lint可以在名为clippy.toml或.clippy.toml的TOML文件中进行配置。它包含基本的变量 = 值映射，例如。

avoid-breaking-exported-api = false
disallowed-names = ["toto", "tata", "titi"]

配置表包含所有配置值、它们的默认值以及它们影响的lint列表。每个可配置的lint，还包含有关这些值的信息。

对于具有默认值的列表类型配置，如disallowed-names，你可以使用唯一的值".."来扩展默认值，而不是替换它们。

# default of disallowed-names is ["foo", "baz", "quux"]
disallowed-names = ["bar", ".."] # -> ["bar", "foo", "baz", "quux"]

注意

clippy.toml或.clippy.toml不能用于允许/拒绝lint。

要禁用“进一步信息请访问 lint-link”消息，你可以定义CLIPPY_DISABLE_DOCS_LINKS环境变量。

指定最小支持的Rust版本

打算支持旧版Rust的项目可以通过在Clippy配置文件中指定最小支持的Rust版本（MSRV）来禁用与新特性相关的lint。

msrv = "1.30.0"

或者，可以使用Cargo.toml中的rust-version字段。

# Cargo.toml
rust-version = "1.30"

MSRV也可以像下面这样作为属性指定。

#![feature(custom_inner_attributes)]
#![clippy::msrv = "1.30.0"]

fn main() {
  ...
}

在指定MSRV时，你也可以省略补丁版本，所以msrv = 1.30等同于msrv = 1.30.0。

注意：custom_inner_attributes是一个不稳定的功能，因此必须明确启用。

可以在此处找到识别此配置选项的lint：here

贡献

如果你想为Clippy做出贡献，你可以在CONTRIBUTING.md中找到更多信息。

许可证

版权所有 2014-2024 Rust项目开发者

根据Apache许可证第2版(<LICENSE-APACHE或https://www.apache.org/licenses/LICENSE-2.0>)或MIT许可证(<LICENSE-MIT或https://opensource.org/licenses/MIT>)进行许可，由你选择。项目中的文件不得根据这些条款以外的条款进行复制、修改或分发。