Skip to main content

Module checks

Module checks 

Source
Expand description

Quality checks system

Trait-based check system for running various quality tools.

Structs§

CargoAuditCheck
CargoCheck
CargoGeigerCheck
CargoTestCheck
CheckPlan
A resolved plan for running a check.
CheckProvenance
Provenance data for a check execution (Artifact Pack v1)
CheckResult
Result of a check execution
ClippyCheck
ESLintCheck
MypyCheck
ProvenanceBuilder
Build provenance from a command execution
PytestCheck
RuffCheck
RustfmtCheck
SemgrepCheck
SkippedCheck
A check that was configured but could not run
StylelintCheck
TypeScriptCheck
VitestCheck

Enums§

CheckEligibility
CheckEvent
Events emitted during check execution
CheckStatus

Constants§

CHECK_TIMEOUT_SECS
Default timeout for checks (5 minutes — large Rust workspaces need this)
TEST_TIMEOUT_SECS
Timeout for test commands (15 minutes - ML projects with model loading need this)

Traits§

Check
Trait for implementing checks

Functions§

find_hard_fail_signatures
Find all matching hard failure signatures in output
get_checks_for_profile
Get checks supported by the detected profile.
has_tool_crash
Detect tool crash indicators in combined output
is_timeout_error
Whether an error is a command timeout produced by [timeout_error].
js_tool_available
Check if a JS tool is available in node_modules
local_js_bin
Resolve a JS tool to a directly-runnable local binary, bypassing npx.
plan_check_run
Plan check execution path: if we are in a remote/PR mode (meaning resolved target commit is different from the checked-out HEAD commit), create an ephemeral worktree snapshot of the target commit and run there. Otherwise, scan the working tree in place.
run_all
Run all applicable checks with caching (parallel execution, streaming output).
run_all_with_events
Run all applicable checks with event callbacks (for TUI mode)
run_command
Helper to run a command with timeout
run_command_with_timeout
Helper to run a command with custom timeout
run_js_command
Helper to run JS tools via pnpm or npx (with tool availability check)
run_js_command_with_timeout
Helper to run JS tools with custom timeout (for tests)
tool_spawn_failure_in_output
True when RAW TOOL OUTPUT shows a launcher could not spawn the requested tool. Matches only markers a tool never emits in its own diagnostics — uv’s “failed to spawn” and a shell “command not found”. A bare “no such file or directory” is deliberately NOT matched here: tools print it in genuine diagnostics, and matching it would turn a real failure into an invisible pass (a tool-output false positive).
tool_unavailable_signature
True when prview’s OWN process-runner error string indicates the tool binary could not be launched (ENOENT on spawn) — e.g. “Failed to run mypy: No such file or directory (os error 2)”. Safe ONLY for prview-generated error strings, where a match reliably means a spawn failure. Do NOT run this against raw tool output: a tool legitimately prints “no such file or directory” in its own diagnostics — use tool_spawn_failure_in_output for that case.

Type Aliases§

CheckEventCallback
Callback type for check events (used by TUI)