Warnalyzer 使用与配置指南

1. 项目目录结构及介绍

Warnalyzer 是一个用于检测 Rust 项目中未使用代码的工具。项目目录结构如下：

• .github/
  • 存储与 GitHub Actions 相关的配置文件。
• src/
  • 包含项目的源代码。
• test-projects/
  • 存储用于测试的示例项目。
• .editorconfig
  • 定义代码编辑器的配置。
• .gitignore
  • 指定 Git 忽略的文件和目录。
• Cargo.lock
  • 记录项目依赖的锁定版本。
• Cargo.toml
  • 定义项目的配置和依赖。
• LICENSE
  • 项目的许可协议文件。
• README.md
  • 项目的说明文档。
• run.sh
  • 运行项目的脚本文件。

2. 项目的启动文件介绍

项目的启动主要通过 run.sh 脚本进行。该脚本用于执行 Warnalyzer 工具，其基本命令如下：

./run.sh <path-to-project-dir>

该命令会在指定项目目录中生成所需的 .scip 文件，并将其放置在项目的 target 目录下。此外，也可以手动生成 .scip 文件，例如使用 rust-analyzer scip 命令，并将生成的文件路径传递给 Warnalyzer。

3. 项目的配置文件介绍

项目的配置主要通过 Cargo.toml 文件进行。以下是 Cargo.toml 文件的一些基本配置：

• name: 项目名称。
• version: 项目版本。
• edition: Rust 语言版本。
• dependencies: 项目依赖的其他库。

另外，如果使用 save-analysis 后端，需要在运行命令时添加相应的 RUSTFLAGS：

RUSTFLAGS="-Z save-analysis" cargo +nightly check

此命令会在 target/debug/deps/save-analysis/ 目录下生成分析数据文件。然后可以使用 Warnalyzer 工具读取这些文件，以检测未使用的代码。

请注意，Warnalyzer 目前有一些已知限制和 bug，使用时可能需要注意。