Warnalyzer安装与配置指南

2025-04-19 09:07:07作者：盛欣凯Ernestine

1. 项目基础介绍

Warnalyzer 是一个用于检测多crate Rust项目中未使用代码的工具。Rust编译器（rustc）的 dead_code 功能只能检测单个crate中的未使用代码，无法识别在多crate项目中公开API的使用情况。Warnalyzer弥补了这一不足，提供了针对多crate项目的未使用代码检测功能。

主要编程语言：Rust

2. 项目使用的关键技术和框架

Rust编程语言：项目的主体语言，用于实现代码检测逻辑。
Rust Analyzer：一个用于Rust的代码分析工具，Warnalyzer依赖于它来生成.scip文件，这个文件用于检测未使用的代码。

3. 项目安装和配置

准备工作

在开始安装之前，请确保您的系统中已经安装了以下软件：

Rust编译器：可以通过 rustup 工具安装。
Rust Analyzer：可以通过 rustup component add rust-analyzer 命令安装。
Git：用于克隆Warnalyzer项目。

安装步骤

克隆Warnalyzer项目到本地：

git clone https://github.com/est31/warnalyzer.git

切换到项目目录：
```
cd warnalyzer
```
使用Rust工具 cargo 构建项目：
```
cargo build
```
对于稳定版的Rust，运行以下命令来使用Warnalyzer：
```
warnalyzer <path-to-project-dir>
```
这将在目标目录中生成.scip文件。

如果您想要手动生成.scip文件，可以进入项目目录，然后运行：
```
rust-analyzer scip
```
然后将生成的.scip文件路径作为参数传递给Warnalyzer。
如果您使用的是nightly版的Rust，并希望使用 save-analysis 功能，您需要在项目目录中运行以下命令：
```
RUSTFLAGS="-Z save-analysis" cargo +nightly check
```
这将在 target/debug/deps/save-analysis 目录下生成相应的.json文件。
从Warnalyzer仓库中运行以下命令来分析生成的.json文件：
```
cargo run <path-to-json>
```
这将列出所有被认为是未使用的项。