Clippy

一个用于捕捉常见错误并改进你的 Rust 代码的代码检查集合。

此 crate 包含超过 700 个代码检查！

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

更多功能即将推出，如果您有想法，请 提交一个 issue！

应明确不整体启用 restriction 类别。包含的代码检查可能针对完全合理的代码进行检查，可能没有替代建议，并且可能与其他代码检查（包括其他类别）冲突。在启用之前应逐个考虑代码检查。

【限制】以下是一些使用 restriction 检查的用例：- 严格的编码风格（例如 clippy::else_if_without_else）。- CI 的附加限制（例如 clippy::todo）。- 防止某些函数中发生恐慌（例如 clippy::unwrap_used）。- 仅在代码子集上运行检查（例如，在模块上运行 #[forbid(clippy::float_arithmetic)]）。

目录

• 使用说明
• 配置
• 贡献
• 许可协议

使用方法

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

作为 cargo 子命令（cargo clippy）

使用 Clippy 的方法之一是通过 rustup 安装 Clippy 作为 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 可以像编译器一样自动应用一些检查建议。请注意，--fix 意味着 --all-targets，因此它可以修复尽可能多的代码。

cargo clippy --fix

工作区

所有常规工作区选项都应与 Clippy 一起使用。例如，以下命令将在 example crate 上运行 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.

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

配置

允许/拒绝 lint

您可以通过向您的代码中添加选项来允许/警告/拒绝 Clippy 的 lint

• 使用 clippy lint 组（#![deny(clippy::all)]）允许整个 Warn lint 组。请注意，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 限制在单个函数或模块中。

cargo clippy -- -A clippy::lint_name

cargo clippy -- -W clippy::lint_name

cargo clippy -- -W clippy::pedantic

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

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

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

msrv = "1.30.0"

# Cargo.toml
rust-version = "1.30"

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

fn main() {
  ...
}