Rust / 系统课时
组合 cargo fmt 与 clippy 检查
组合 cargo fmt 与 clippy 检查
把格式化与静态检查放进同一条自动流程,可以让本地开发、提交前检查和 CI 使用一致的质量门槛。本篇用一个最小 Rust 项目演示如何串联 cargo fmt 与 cargo clippy,并明确失败时应该阻止后续流程。
学习目标
- 能用
cargo fmt检查并统一代码格式 - 能用
cargo clippy发现常见代码问题并区分警告与失败 - 能在 CI 中按固定顺序组合两类检查
先区分两类检查
cargo fmt 主要负责代码格式一致性,而 cargo clippy 负责基于 Rust 编译器能力提供额外的代码质量检查。两者解决的问题不同,但都适合成为自动化质量门禁。
在 CI 中常见的顺序是先运行格式检查,再运行 Clippy。这样格式问题会尽早暴露,也避免把格式噪声和代码质量问题混在一次失败中。
在项目中运行检查
下面假设项目根目录存在标准的 Cargo.toml 和 src/main.rs。cargo fmt --check 只检查是否需要格式化,不会修改工作区;cargo clippy --all-targets --all-features -- -D warnings 则要求所有目标、所有特性都参与检查,并把警告提升为错误。
cargo fmt --check
cargo clippy --all-targets --all-features -- -D warnings预期结果
Finished successfully without reporting a formatting difference.
Finished successfully without warnings promoted to errors.实际输出会包含当前 Rust 工具链对应的编译与检查信息,文本细节可能不同;这里关注的是两个命令均以成功状态结束。
放进 CI 的最小流程
自动流程的关键不是把命令堆在一起,而是让任一步失败都停止后续检查。以常见 CI Shell 步骤为例,可以直接复用同一组命令。
set -e
# 格式不符合仓库标准时立即失败,避免把格式问题带到后续步骤。
cargo fmt --check
# 覆盖测试目标和启用特性,并把 Clippy 警告当作 CI 错误。
cargo clippy --all-targets --all-features -- -D warnings
echo "quality checks passed"预期结果
quality checks passed若 cargo fmt --check 检测到文件需要重排,或 Clippy 产生了被 -D warnings 提升的诊断,脚本会在对应命令处退出,最后一行不会执行。
本地修复与 CI 检查要分开
开发者本地通常用 cargo fmt 自动修复格式,再重新运行 cargo clippy ...。CI 则更适合使用只检查、不修改工作区的方式,这样流水线验证的是提交本身,而不是 CI 临时改写后的文件。
另一个常见问题是只运行默认目标或默认特性。项目包含额外 binary、example、test target 或 feature 时,这种检查可能漏掉实际会参与构建的代码。是否需要 --all-targets 与 --all-features,应结合项目自身的构建范围决定。
把两条命令固定为仓库级脚本或 CI 步骤后,本地与远程就能围绕同一套规则工作:fmt 管格式,clippy 管静态质量,并且任一门禁失败都会明确阻止流水线继续。