1 个不稳定版本

0.1.0 2023年1月12日

#705Cargo 插件

MIT/Apache

7KB
104

cargo-nag: 编写自定义 Rust 代码检查工具的实验性工具包

如何编写代码检查?

使用 nag-toolkit 库,调用 declare_lints!() 宏并导出结果的 ::register() 函数:请参阅 example-nag-linter/src/lints.rs 作为示例。

您可以为您的库的用户提供包含代码检查的 crate,或者直接在您的代码检查同一个 crate 中编写它们。

nightly-rustc 文档,特别是关于 LateLintPass 的部分,在编写代码检查时非常有用。

如何编写代码检查器?

使用 nag-driver 库,调用 nag_driver::run()nag_driver::Driver::with_callback(),然后调用 .run():请参阅 example-nag-linter/src/main.rs 作为示例。

如何使用代码检查器?

安装 cargo-nag 二进制文件。设置 CARGO_NAG_LINTER_DIR 环境变量为您代码检查源代码的绝对路径,然后运行 cargo nag。它将为您编译并运行代码检查器。

依赖项

~0.7–1.6MB
~35K SLoC