Skip to content
Unverified: This page has not yet been anchored to automated code tests.

vox-code-audit API Reference (generated)

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

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.

DependencyKind
vox-bounded-fsNormal
vox-configNormal
vox-http-clientNormal
vox-jsonschema-utilNormal
vox-llm-egressNormal
vox-orchestrator-typesNormal
vox-rule-packNormal
vox-scaling-policyNormal
vox-secretsNormal
vox-telemetryNormal
ModuleDescription
diagnosticsStable diagnostic ID catalog (vox/<category>/<name> scheme) and explain infrastructure.
ai_analyzeOptional LLM-backed triage: wraps provider-specific clients behind a small AiAnalyzer API.
analysisToken maps, optional syn AST, and other shared analysis for detectors.
detectorsConcrete TOESTUB rules (stubs, empty bodies, secrets, DRY, …) registered by [detectors::all_rules].
run_contextPer-run canary / rollout flags for detectors (set by [engine::ToestubEngine]).
suppressionStructured suppression store (contracts/toestub/suppression.v1.schema.json).
retirement_parityCR-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_parityStdlib-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.
engineRuns configured detectors over a [scanner::Scanner] snapshot and aggregates [rules::Finding]s.
reportRenders findings to the terminal, JSON, or Markdown for CI and local CLI output.
reviewEnd-to-end code review flow: prompts, provider adapters (OpenAI, Ollama, …), SARIF/MD emit.
rulesShared model for a single finding, severity/language enums, and the [rules::DetectionRule] trait.
scannerCollects SourceFile entries from a repo path with language detection from extensions.
task_queueIn-memory bounded work queue used to cap parallel file/review tasks.