防锈质量门

安全 社区

技能解读

当前原文的自动摘译,尚未人工审校。

功能和 target-cfg — 检测一次,随处使用

Rust 比 JS 更简单(一个工具链,一个包管理器),但 Cargo 功能是等效的陷阱。具有默认功能的cargo build编译的子集与--all-features不同,并且某些功能组合根本不能一起编译。在没有 --all-features 的情况下运行 cargo clippy(或者在没有 --each-feature 的情况下进行组合覆盖)会为功能门控代码产生静默无操作。检查:

核心(每个 Rust 项目)

这些使用工具链版本。如果rust-toolchain.toml固定特定版本(例如stable-1.85),clippy和rustfmt匹配 - 开发人员之间没有版本漂移。大多数生产存储库都会固定特定的稳定版本(而不是浮动的stable通道);它消除了“在我的机器上触发但不在 CI 中触发的 lint”调试。

流狐档案 运行与权限由流狐静态检查推断,不代表作者声明或实际测试结果。
领域
安全
作者声明的智能体
未找到明确声明;不据此推断已兼容或已测试
静态检查
88 / 100 · 启发式扫描,不代表运行安全
运行环境证据
未执行;当前没有隔离运行测试证据
作者 / 版本 / 许可证
@tomevault-io · 未声明许可证
上下文用量评级
中等消耗
接入复杂程度
需简单配置
是否需要外部接口密钥
不需要
兼容的系统
Linux
运行环境要求
未检出明确要求
检测到的文件与系统行为
  • 只读
  • 允许写入 / 修改
  • 命令执行
  • 读取环境变量
网络行为
仅限本地
安装命令数
无(仅作为资料)

需要注意: 未声明工具权限范围;实际权限由运行环境决定。

01
第 1 步:在接触任何内容之前评估存储库

在编写或安装任何内容之前,请先了解存储库。可能有两种结果:成熟的系统已经存在(停止并推迟 - 步骤 2),或者不存在(从步骤 3 继续)。并行收集:`Cargo.toml`(根和每个板条箱)/`Cargo.lock` — 版本、MSRV (`rust-version`)、工作区成员、功能标志、现有 `[lints]` 表。 `rust-toolchain.toml` / `rust-toolchain` — 固定编译器版本、组件(`clippy`、`rustfmt`、`llvm-tools-preview`)、目标。

02
第 2 步:清点现有登机口并实施增量

大多数存储库已经有一些门(CI 中的 `cargo fmt --check`、运行 Clippy 的 Makefile 目标、半完成的 `[workspace.lints]` 表),但不是此技能安装的全套。默认行为是填补缺失的门,而不是停止。仅当下面清单的每一行都已经是 ✅ 或现有编排器确实与添加门不兼容时才推迟整个工作(罕见 - 请参阅步骤结束)。

03
第三步:安装开发工具

Rust 开发工具有两个来源:rustup 组件(随工具链一起提供)和用于第三方工具的`cargo install`。更喜欢通过 CI 安装步骤中的 `rust-toolchain.toml` 组件、`tools/Cargo.toml` 工作区或 `cargo install --locked` 固定第三方工具版本。

04
第四步:检查+构建作为基线

`cargo check --workspace --all-targets`和`cargo build --workspace --all-targets`是地板。它们不需要配置,捕获真实类型错误,并且`check`比`build`运行得快得多,因为它跳过了代码生成。如果在干净的检查中失败,请在添加更多门之前停止并修复 - 在无法编译的存储库之上分层 linter 是没有意义的。 `--all-targets` 至关重要:没有它,`cargo check` 就无法编译 `tests/`、`examples/` 或 `benches/`,而且它们会默默地腐烂。

05
第5步:Clippy配置

Clippy 之于 Rust 就像 golangci-lint 之于 Go — 一种元 linter,它包装了数十个命名的 lint,否则您需要单独连接。从 Cargo 1.74 开始,lint 可以通过 `Cargo.toml` 中的 `[lints]` 表进行配置——这是 `lib.rs` 中板条箱级 `#![warn(...)]` 属性的替代方案,也是工作区的首选形式,因为 `[workspace.lints]` 会传播到每个成员。板条箱级别的属性仍然有效并且仍然很常见;选择一种形式并坚持下去。

06
第 6 步:格式化(rustfmt)

Rust 具有明确的规范格式。没有 bikeshedding 配置(与 Prettier 不同)。 `rustfmt` 是工具链的一部分 — 除了`rustup component add rustfmt` 之外没有安装步骤。如果存储库需要一些自定义(唯一值得在大多数项目上设置的自定义项),请将它们放在存储库根目录的`rustfmt.toml`中:如果存储库的`rust-toolchain.toml`每晚固定,则`unstable_features`块是公平的游戏;否则请留下评论。要避免的陷阱:在稳定的工具链上启用不稳定的 rustfmt 选项意味着`cargo fmt --check` 会在不应用它们的情况下返回成功,并且开发人员设置会悄无声息地发生变化。

07
第 7 步:未使用的依赖项、死代码、重复、复杂性

这些运行起来很便宜,并且可以捕捉到单独错过的东西。

08
第8步:创建check.sh

一个按顺序调用每个门的精简 bash 入口点。适合小型/中型回购;请参阅步骤 12 了解并行协调器升级。替换步骤 1 中的 `<CARGO_FEATURES>` 和任何工具链环境。不要在生成的文件中保留占位符文字。故意不在这个默认模板中(以避免双重门控或脆弱行为): `cargo audit` / `cargo deny` - 网络相关(获取 RUSTSEC 咨询数据库)并且可能在气隙 CI 中分层。有价值但属于预定的 CI 运行;请参阅步骤 12。

讨论

基于 GitHub Discussions。登录 GitHub 即可参与讨论、点赞、订阅更新。