红笔——超严格的Rust代码审查工具🚀📝

红笔（Red Pen） 是一个用于Rust代码的轻量级静态检查器，它有自己的定制规则集，独立于Clippy，并旨在成为内部rustc API测试平台。这个工具的设计目标是确保代码质量，提供快速的持续集成体验，并为项目开发自定义规则。

项目技术分析🔧🔍

redpen 使用了rustc_driver来实现其功能，这意味着它是直接与rustc的内部组件交互的，但通过自己的API来隔离内部API的变化影响。这使得它能够快速编译，不会因为rustc的频繁更新而导致维护困难。目前，已经实现了两个示例性的检查规则：

1. 负类型检查: 当注解类型使用特定类型时发出警告。
2. 禁止间接调用panic!: 检查函数是否可能间接地引发恐慌。

应用场景💻📚

无论你是个人开发者还是团队成员，redpen 都能帮助你提升代码质量，避免潜在的错误和不良实践。它适用于任何Rust项目，特别是在你需要更严格代码规范，或者想要创建项目特有的检查规则的情况下。将redpen集成到你的CI/CD流程中，可以确保每次提交的代码都经过精心审查。

安装与使用bolt/spanner.png

安装redpen非常简单，可以通过cargo进行：

cargo +nightly-2023-11-01 install redpen-linter

然后，在Cargo.toml文件中添加依赖项以支持注解：

[dependencies]
cargo-redpen-shim = { version = "0.1", package = "redpen" }

如果你希望自定义规则，可以直接克隆redpen仓库并运行cargo install。

特点🌟💡

• 独立规则集: 提供不同默认设置，可与Clippy互补。
• 快速构建: 作为CI的一部分，redpen有较小的编译负担。
• 稳定接口: 通过自身API缓冲rustc内部API变更的影响，减少维护成本。
• **自定义注解: 通过自定义的redpen`宏，轻松添加项目特有的检查规则。

例如，下面这段代码中的disallow和dont_panic注解，会被redpen检查并报告错误或警告。

#[redpen::disallow(T = "Pineapple")]
struct Pizza<T>(T);

// ...更多代码...

在你的项目中尝试使用redpen，你会立即感受到它带来的代码质量提升和问题预防效果。现在就加入这个超严格的教师队伍，让redpen帮你打造无误的Rust代码吧！

了解更多

一起，让我们的代码更加完美！🎨🔧