rust-llm-tidy-cli

Command-line adapter for the rust-llm-tidy library.

Installation

cargo install rust-llm-tidy-cli

Or build from source:

cargo build --release -p rust-llm-tidy-cli

Usage

rust-llm-tidy is a single command that runs the full pipeline (fix, reorder, vis, lints) by default on every allowed source file:

# Tidy a file in place
rust-llm-tidy src/main.rs

# Report the changes that would be made instead of modifying the file
rust-llm-tidy --dry-run src/main.rs

# Tidy every allowed source file under a directory recursively
rust-llm-tidy src

# No paths given -> process the changed files in the current git diff
rust-llm-tidy

# Run only specific ops (repeatable); overrides the config `include` mode
rust-llm-tidy --include vis src/lib.rs
rust-llm-tidy --include reorder --include vis src

# Skip an op for this run (additive to config `exclude`)
rust-llm-tidy --exclude lints src

# Validate the config without processing files
rust-llm-tidy --validate

# Emit the lint findings as a single JSON array on stdout
rust-llm-tidy --output-mode json src/main.rs

Flags

JSON output

Print every lint finding and change record as one JSON array on stdout instead of the default path:line: sev[CODE]: ... stderr diagnostics.

Change records are emitted for both in-place and --dry-run runs. Prints [] when there are no findings or changes, even when the run exits non-zero:

[
  {
    "path": "src/main.rs",
    "line": 22,
    "severity": "error",
    "code": "DOC001",
    "message": "non-private item is missing a doc comment",
    "item_kind": "fn",
    "item_name": "load",
    "title": "missing documentation"
  }
]

Fields:

• severity - "error", "warning", or "hint" for lint findings, "success" for change records (applied or would-be changes)
• line - 1-based item start line, null when no specific line (link/table fixes)
• item_name - item name, null when unnamed
• title - friendly per-code title for lint findings, null for change records
• path, code, message, item_kind - as in plaintext

In JSON mode the plaintext per-line diagnostics are not printed to stderr. --output-mode json combines freely with --dry-run; the would-be changes are folded into the same document.

See dry-run change reporting for the shared record format.

Hint-severity findings never fail a run and print as their own group in text mode; see hints.

Operations

An optional YAML config file (.rust-llm-tidy.yml) may exclude files from processing, whitelist or blacklist specific rules per path, and run external programs (e.g. rustfmt) on every processed file.

Pass --config <PATH> to use an explicit config or --no-config to disable discovery. See the repository README for the full schema.

Library use

Use rust-llm-tidy as a dependency for source buffers or complete file processing. The CLI owns only arguments, rendering and exit status; all processing lives in the library.

Ordering Rules

The algorithm orders top-level items across phases. Within most phases, an item comes before any item it references; alphabetical order breaks ties. See docs/reorder.md for an annotated 10-phase example.

License

Licensed under Apache 2.0