vox-code-audit API Reference (generated)
vox-code-audit
Section titled “vox-code-audit”Crate: vox-code-audit · Version: 0.6.0 · Target: Library (lib.rs)
AI code quality stub detector — finds stubs, magic values, empty bodies, missing references, and DRY violations
Crate Overview
Section titled “Crate Overview”vox-code-audit
Section titled “vox-code-audit”Todo, Omitted wiring, Empty bodies, Stub functions, Too-early victory, Unresolved references, Broken DRY — detector.
TOESTUB mechanically detects AI coding anti-patterns that are banned by AGENTS.md but otherwise only caught during manual review.
Public modules and re-exports are intentionally thin; each detector/rule is documented in its own file where non-obvious heuristics exist.
Workspace Dependencies
Section titled “Workspace Dependencies”| Dependency | Kind |
|---|---|
vox-bounded-fs | Normal |
vox-config | Normal |
vox-http-client | Normal |
vox-jsonschema-util | Normal |
vox-llm-egress | Normal |
vox-orchestrator-types | Normal |
vox-rule-pack | Normal |
vox-scaling-policy | Normal |
vox-secrets | Normal |
vox-telemetry | Normal |
Public API Surface
Section titled “Public API Surface”Modules
Section titled “Modules”| Module | Description |
|---|---|
diagnostics | Stable diagnostic ID catalog (vox/<category>/<name> scheme) and explain infrastructure. |
ai_analyze | Optional LLM-backed triage: wraps provider-specific clients behind a small AiAnalyzer API. |
analysis | Token maps, optional syn AST, and other shared analysis for detectors. |
detectors | Concrete TOESTUB rules (stubs, empty bodies, secrets, DRY, …) registered by [detectors::all_rules]. |
run_context | Per-run canary / rollout flags for detectors (set by [engine::ToestubEngine]). |
suppression | Structured suppression store (contracts/toestub/suppression.v1.schema.json). |
retirement_parity | CR-L6 retirement-guard parity check — cross-references contracts/retirement/retired-surfaces.v1.yaml against the registered detectors and diagnostic IDs. Library home of the planned vox ci retirement-audit CLI command. |
stdlib_parity | Stdlib-coverage parity check (non-CR-L tooling gate). Three-way diff between binary registrations in crates/vox-compiler/src/eval/builtins.rs, doc claims in docs/src/reference/ref-builtins-stdlib.md, and corpus call sites under scripts/. Library home of the vox audit stdlib-coverage subcommand. See docs/src/architecture/vox-stdlib-gap-audit-2026-05-23.md §10 / §12.D. |
engine | Runs configured detectors over a [scanner::Scanner] snapshot and aggregates [rules::Finding]s. |
report | Renders findings to the terminal, JSON, or Markdown for CI and local CLI output. |
review | End-to-end code review flow: prompts, provider adapters (OpenAI, Ollama, …), SARIF/MD emit. |
rules | Shared model for a single finding, severity/language enums, and the [rules::DetectionRule] trait. |
scanner | Collects SourceFile entries from a repo path with language detection from extensions. |
task_queue | In-memory bounded work queue used to cap parallel file/review tasks. |