refquiem 0.3.3

A cargo requiem for the refs your Rust code left behind
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42

# cargo-refquiem

[![CI](https://github.com/LucaCappelletti94/cargo-refquiem/actions/workflows/ci.yml/badge.svg)](https://github.com/LucaCappelletti94/cargo-refquiem/actions/workflows/ci.yml)
[![codecov](https://codecov.io/github/LucaCappelletti94/cargo-refquiem/graph/badge.svg)](https://codecov.io/github/LucaCappelletti94/cargo-refquiem)
[![crates.io](https://img.shields.io/crates/v/refquiem.svg)](https://crates.io/crates/refquiem)
[![docs.rs](https://docs.rs/refquiem/badge.svg)](https://docs.rs/refquiem)
[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://github.com/LucaCappelletti94/cargo-refquiem/blob/main/LICENSE)

A cargo requiem for the refs your Rust code left behind.

`cargo refquiem` finds the Rust items, dependencies, features, binaries and examples your git history removed, and reports the comments, doc comments, string literals and Markdown that still name them, with what each most likely became. The [wiki](https://github.com/LucaCappelletti94/cargo-refquiem/wiki) explains matching, configuration, reports and the Action in depth.

<picture>
  <source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/LucaCappelletti94/cargo-refquiem/main/docs/review-dark.svg">
  <img alt="A refquiem pull request review flags a stale Rust function name and suggests its replacement" src="https://raw.githubusercontent.com/LucaCappelletti94/cargo-refquiem/main/docs/review-light.svg">
</picture>

## Usage

```sh
cargo install refquiem --locked
cargo refquiem                                 # every commit, against the working tree
cargo refquiem --base origin/main --head HEAD  # what a branch removed
cargo refquiem --json                          # the report as JSON
cargo refquiem --markdown > report.md         # findings with suggested actions, linked when the repository is on GitHub
cargo refquiem vocabularies                    # bundled vocabularies and their sources
cargo refquiem vocabularies --effective        # resolved workspace vocabulary selection
```

The exit status is `0` when nothing is stale, `1` with findings and `2` on errors. A `.refquiem.toml` at the workspace root selects optional vocabularies through `builtins`, such as `english`, `sql@2023`, `android@36` or `posix@2017`, which `cargo refquiem vocabularies` lists, and project-owned `files`, and configures excludes and allowed names. A `refquiem: allow(Name)` comment silences one mention, and `cargo refquiem --help` lists every option.

## GitHub Action

The [action guide](https://github.com/LucaCappelletti94/cargo-refquiem/wiki/GitHub-Action) reviews each pull request with a suggested fix for every stale mention, pull requests from forks included.

## Library

Depend on `refquiem` with `default-features = false` to drop the CLI, then call `refquiem::run` as the [Library page](https://github.com/LucaCappelletti94/cargo-refquiem/wiki/Library) shows. `refquiem::vocabulary` exposes the catalog and effective selection. Coding agents get the same guidance from the [`refquiem` skill](https://github.com/LucaCappelletti94/cargo-refquiem/blob/main/skills/refquiem/SKILL.md).

```sh
npx skills add LucaCappelletti94/cargo-refquiem
```