跳到主要内容

Spin Lint

cargo xtask spin-lint 用于守护 workspace 对上游 spin crate 的统一使用约束。当前仓库直接使用 crates.io 的 spin 0.12.2，并关闭默认 feature；允许的 feature 只有 lock_api、once 和 lazylock。需要非睡眠读写锁时统一使用 ax_kspin::SpinRwLock，不能重新引入 spin::RwLock。

spin-lint 检查的是仓库级依赖与同步原语不变量，不是一般代码风格。

检查内容​

lint_workspace 依次执行以下检查，所有 finding 会累积后统一报告：

检查约束
本地 packageworkspace 内不能出现名为 spin 的本地 package，避免重新引入 vendored 副本
根 manifest[workspace.dependencies] 必须精确声明 crates.io spin =0.12.2，关闭默认 feature，并启用 lock_api、once、lazylock；不能设置 path、git、registry 或 package
crates.io patch根 manifest 不能通过 [patch.crates-io] 替换 spin
成员 manifest推荐使用 spin = { workspace = true }；显式依赖也必须固定 =0.12.2、关闭默认 feature，且只能启用白名单 feature
源码用法Rust 源码不能出现 spin::RwLock、spin::rwlock 或 use spin::RwLock
lockfile每个 spin 条目都必须是 crates.io 的 0.12.2，并带 registry source 与 checksum

扫描会跳过 .git、target、tmp 和 .cache。源码扫描还会跳过 docs 以及 spin_lint.rs 自身，避免示例文字和规则字符串触发误报。

合法依赖写法​

根 Cargo.toml：

[workspace.dependencies]
spin = { version = "=0.12.2", default-features = false, features = ["lock_api", "once", "lazylock"] }

成员 crate 优先继承 workspace 配置：

[dependencies]
spin = { workspace = true }

成员 crate 如果必须显式声明，只能使用相同精确版本、关闭默认 feature，并选择白名单 feature 的子集：

[dependencies]
spin = { version = "=0.12.2", default-features = false, features = ["once"] }

以下写法会失败：

# 字符串依赖会启用上游默认 feature。
spin = "0.12"

# workspace 继承项不能覆盖版本或 feature。
spin = { workspace = true, features = ["rwlock"] }

# 不允许改名或覆盖来源。
spin_compat = { package = "spin", version = "=0.12.2" }
spin = { path = "components/spin" }

RwLock 约束​

spin-lint 对 Rust 源码逐行检查以下模式：

const FORBIDDEN_SPIN_RWLOCK_PATTERNS: &[&str] =
    &["spin::RwLock", "spin::rwlock", "use spin::RwLock"];

需要非睡眠读写锁时使用：

use ax_kspin::SpinRwLock;

报告格式​

每条 finding 包含路径、TOML 位置或源码行号、错误说明与修复建议：

<path>: <location>: <message>
  help: <修复建议>

存在任何 finding 时命令会以非零状态退出。

用法​

cargo xtask spin-lint

CI 会运行该命令，防止依赖版本、feature、来源或 spin::RwLock 用法回退。