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

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

2024-05-30 08:31:12作者:卓艾滢Kingsley

红笔(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`宏,轻松添加项目特有的检查规则。

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

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

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

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

了解更多

一起,让我们的代码更加完美!🎨🔧

登录后查看全文
热门项目推荐

热门内容推荐

最新内容推荐

项目优选

收起
docsdocs
OpenHarmony documentation | OpenHarmony开发者文档
Dockerfile
149
1.95 K
kernelkernel
deepin linux kernel
C
22
6
openHiTLSopenHiTLS
旨在打造算法先进、性能卓越、高效敏捷、安全可靠的密码套件,通过轻量级、可剪裁的软件技术架构满足各行业不同场景的多样化要求,让密码技术应用更简单,同时探索后量子等先进算法创新实践,构建密码前沿技术底座!
C
980
395
ohos_react_nativeohos_react_native
React Native鸿蒙化仓库
C++
192
274
RuoYi-Vue3RuoYi-Vue3
🎉 (RuoYi)官方仓库 基于SpringBoot,Spring Security,JWT,Vue3 & Vite、Element Plus 的前后端分离权限管理系统
Vue
931
555
openGauss-serveropenGauss-server
openGauss kernel ~ openGauss is an open source relational database management system
C++
145
190
nop-entropynop-entropy
Nop Platform 2.0是基于可逆计算理论实现的采用面向语言编程范式的新一代低代码开发平台,包含基于全新原理从零开始研发的GraphQL引擎、ORM引擎、工作流引擎、报表引擎、规则引擎、批处理引引擎等完整设计。nop-entropy是它的后端部分,采用java语言实现,可选择集成Spring框架或者Quarkus框架。中小企业可以免费商用
Java
8
0
金融AI编程实战金融AI编程实战
为非计算机科班出身 (例如财经类高校金融学院) 同学量身定制,新手友好,让学生以亲身实践开源开发的方式,学会使用计算机自动化自己的科研/创新工作。案例以量化投资为主线,涉及 Bash、Python、SQL、BI、AI 等全技术栈,培养面向未来的数智化人才 (如数据工程师、数据分析师、数据科学家、数据决策者、量化投资人)。
Jupyter Notebook
75
66
openHiTLS-examplesopenHiTLS-examples
本仓将为广大高校开发者提供开源实践和创新开发平台,收集和展示openHiTLS示例代码及创新应用,欢迎大家投稿,让全世界看到您的精巧密码实现设计,也让更多人通过您的优秀成果,理解、喜爱上密码技术。
C
65
518
CangjieCommunityCangjieCommunity
为仓颉编程语言开发者打造活跃、开放、高质量的社区环境
Markdown
1.11 K
0