pub struct CheckOutput {Show 13 fields
pub schema_version: SchemaVersion,
pub version: ToolVersion,
pub elapsed_ms: ElapsedMs,
pub total_issues: usize,
pub entry_points: Option<EntryPoints>,
pub summary: CheckSummary,
pub results: AnalysisResults,
pub baseline_deltas: Option<BaselineDeltas>,
pub baseline: Option<BaselineMatch>,
pub regression: Option<RegressionResult>,
pub meta: Option<Meta>,
pub workspace_diagnostics: Vec<WorkspaceDiagnostic>,
pub next_steps: Vec<NextStep>,
}Expand description
Envelope emitted by fallow dead-code --format json (plus the check
block inside the combined and audit envelopes).
The body is the full AnalysisResults flattened into the envelope so
every issue array (unused_files, unused_exports, …) lives at the
top level, matching the existing wire shape. entry_points lifts the
otherwise #[serde(skip)]’d AnalysisResults::entry_point_summary back
into the JSON output. summary carries the per-category counts the
JSON layer always emits.
Fields§
§schema_version: SchemaVersionDead-code output schema version; currently CHECK_SCHEMA_VERSION.
version: ToolVersionFallow CLI version that produced this output.
elapsed_ms: ElapsedMsWall-clock analysis duration in milliseconds.
total_issues: usizeTotal findings across all issue arrays; excludes next_steps.
entry_points: Option<EntryPoints>Entry-point totals per source, when the analysis recorded them.
summary: CheckSummaryPer-category finding counts.
results: AnalysisResultsFull analysis results, flattened so each issue array sits at the envelope root.
baseline_deltas: Option<BaselineDeltas>Count deltas against the matched baseline, in baseline runs.
baseline: Option<BaselineMatch>Which baseline snapshot was matched, in baseline runs.
regression: Option<RegressionResult>Regression verdict against the baseline, in --fail-on-regression runs.
meta: Option<Meta>_meta block with docs and rule definitions, when --explain was
passed.
workspace_diagnostics: Vec<WorkspaceDiagnostic>Non-fatal diagnostics about the project itself, from all three stages that record them (issue #473):
- workspace discovery, at config load:
undeclared-workspace,malformed-package-json,glob-matched-no-package-json,malformed-tsconfig,tsconfig-reference-dir-missing; - source discovery, during the file walk:
skipped-large-file,skipped-minified-file,skipped-source-dotdir,excluded-by-default-ignore,source-read-failure,source-parse-degraded; - dead-code analysis, from the dependency-catalog and override
detectors:
malformed-pnpm-workspace-yaml,bun-lockb-override-resolution-skipped.
Analysis-stage kinds therefore reach only the envelopes whose run
includes a dead-code analyze pass, never a standalone
fallow dupes --format json. path is project-root-relative with
forward slashes; the array is omitted when empty. The same list is
repeated on each top-level command’s envelope so single-command
consumers see it without having to look at a separate top-level field.
A diagnostic here is advisory and never withholds a finding. Where an
entry reports a source file this run never fully analyzed
(source-parse-degraded, source-read-failure, skipped-large-file,
skipped-minified-file, skipped-source-dotdir) it can distort a
verdict, so the affected unused_files[], unused_exports[], and
dependency entries additionally carry the caveat themselves in their own
optional reachability_caveats[] array, and a reader who never scrolls
back up to this list still sees it. fallow fix reads the same array
and withholds the removal while a caveat stands.
excluded-by-default-ignore is the one source-discovery kind that
reports unseen files WITHOUT raising a caveat. It names a built-in
ignore pattern (**/dist/**, **/build/**, **/coverage/**, or one
of the four minified-bundle globs) that removed candidate source files
from the walk, which is designed behavior on generated output rather
than a degraded run, so it is advisory only and no finding inherits it.
One entry per pattern, never per file, so the array stays bounded on a
project of any size. Gitignored trees are pruned before the walk sees
them and count zero, and **/node_modules/** is never reported:
installed dependencies are not the first-party source the kind is
about.
next_steps: Vec<NextStep>Read-only follow-up commands computed from this run’s findings, emitted
at the JSON root so an agent acting on the output is pointed at fallow’s
adjacent verification capabilities (trace, complexity breakdown, audit,
workspace scoping). Each command is runnable as-is and never mutating;
see NextStep for both contracts. Omitted when empty or when
FALLOW_SUGGESTIONS=off; does NOT contribute to total_issues.
Trait Implementations§
Source§impl Clone for CheckOutput
impl Clone for CheckOutput
Source§fn clone(&self) -> CheckOutput
fn clone(&self) -> CheckOutput
1.0.0 (const: unstable) · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source. Read moreSource§impl Debug for CheckOutput
impl Debug for CheckOutput
Auto Trait Implementations§
impl Freeze for CheckOutput
impl RefUnwindSafe for CheckOutput
impl Send for CheckOutput
impl Sync for CheckOutput
impl Unpin for CheckOutput
impl UnsafeUnpin for CheckOutput
impl UnwindSafe for CheckOutput
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self> ⓘ
fn instrument(self, span: Span) -> Instrumented<Self> ⓘ
Source§fn in_current_span(self) -> Instrumented<Self> ⓘ
fn in_current_span(self) -> Instrumented<Self> ⓘ
Source§impl<D> OwoColorize for D
impl<D> OwoColorize for D
Source§fn fg<C>(&self) -> FgColorDisplay<'_, C, Self>where
C: Color,
fn fg<C>(&self) -> FgColorDisplay<'_, C, Self>where
C: Color,
Source§fn bg<C>(&self) -> BgColorDisplay<'_, C, Self>where
C: Color,
fn bg<C>(&self) -> BgColorDisplay<'_, C, Self>where
C: Color,
Source§fn black(&self) -> FgColorDisplay<'_, Black, Self>
fn black(&self) -> FgColorDisplay<'_, Black, Self>
Source§fn on_black(&self) -> BgColorDisplay<'_, Black, Self>
fn on_black(&self) -> BgColorDisplay<'_, Black, Self>
Source§fn red(&self) -> FgColorDisplay<'_, Red, Self>
fn red(&self) -> FgColorDisplay<'_, Red, Self>
Source§fn on_red(&self) -> BgColorDisplay<'_, Red, Self>
fn on_red(&self) -> BgColorDisplay<'_, Red, Self>
Source§fn green(&self) -> FgColorDisplay<'_, Green, Self>
fn green(&self) -> FgColorDisplay<'_, Green, Self>
Source§fn on_green(&self) -> BgColorDisplay<'_, Green, Self>
fn on_green(&self) -> BgColorDisplay<'_, Green, Self>
Source§fn yellow(&self) -> FgColorDisplay<'_, Yellow, Self>
fn yellow(&self) -> FgColorDisplay<'_, Yellow, Self>
Source§fn on_yellow(&self) -> BgColorDisplay<'_, Yellow, Self>
fn on_yellow(&self) -> BgColorDisplay<'_, Yellow, Self>
Source§fn blue(&self) -> FgColorDisplay<'_, Blue, Self>
fn blue(&self) -> FgColorDisplay<'_, Blue, Self>
Source§fn on_blue(&self) -> BgColorDisplay<'_, Blue, Self>
fn on_blue(&self) -> BgColorDisplay<'_, Blue, Self>
Source§fn magenta(&self) -> FgColorDisplay<'_, Magenta, Self>
fn magenta(&self) -> FgColorDisplay<'_, Magenta, Self>
Source§fn on_magenta(&self) -> BgColorDisplay<'_, Magenta, Self>
fn on_magenta(&self) -> BgColorDisplay<'_, Magenta, Self>
Source§fn purple(&self) -> FgColorDisplay<'_, Magenta, Self>
fn purple(&self) -> FgColorDisplay<'_, Magenta, Self>
Source§fn on_purple(&self) -> BgColorDisplay<'_, Magenta, Self>
fn on_purple(&self) -> BgColorDisplay<'_, Magenta, Self>
Source§fn cyan(&self) -> FgColorDisplay<'_, Cyan, Self>
fn cyan(&self) -> FgColorDisplay<'_, Cyan, Self>
Source§fn on_cyan(&self) -> BgColorDisplay<'_, Cyan, Self>
fn on_cyan(&self) -> BgColorDisplay<'_, Cyan, Self>
Source§fn white(&self) -> FgColorDisplay<'_, White, Self>
fn white(&self) -> FgColorDisplay<'_, White, Self>
Source§fn on_white(&self) -> BgColorDisplay<'_, White, Self>
fn on_white(&self) -> BgColorDisplay<'_, White, Self>
Source§fn default_color(&self) -> FgColorDisplay<'_, Default, Self>
fn default_color(&self) -> FgColorDisplay<'_, Default, Self>
Source§fn on_default_color(&self) -> BgColorDisplay<'_, Default, Self>
fn on_default_color(&self) -> BgColorDisplay<'_, Default, Self>
Source§fn bright_black(&self) -> FgColorDisplay<'_, BrightBlack, Self>
fn bright_black(&self) -> FgColorDisplay<'_, BrightBlack, Self>
Source§fn on_bright_black(&self) -> BgColorDisplay<'_, BrightBlack, Self>
fn on_bright_black(&self) -> BgColorDisplay<'_, BrightBlack, Self>
Source§fn bright_red(&self) -> FgColorDisplay<'_, BrightRed, Self>
fn bright_red(&self) -> FgColorDisplay<'_, BrightRed, Self>
Source§fn on_bright_red(&self) -> BgColorDisplay<'_, BrightRed, Self>
fn on_bright_red(&self) -> BgColorDisplay<'_, BrightRed, Self>
Source§fn bright_green(&self) -> FgColorDisplay<'_, BrightGreen, Self>
fn bright_green(&self) -> FgColorDisplay<'_, BrightGreen, Self>
Source§fn on_bright_green(&self) -> BgColorDisplay<'_, BrightGreen, Self>
fn on_bright_green(&self) -> BgColorDisplay<'_, BrightGreen, Self>
Source§fn bright_yellow(&self) -> FgColorDisplay<'_, BrightYellow, Self>
fn bright_yellow(&self) -> FgColorDisplay<'_, BrightYellow, Self>
Source§fn on_bright_yellow(&self) -> BgColorDisplay<'_, BrightYellow, Self>
fn on_bright_yellow(&self) -> BgColorDisplay<'_, BrightYellow, Self>
Source§fn bright_blue(&self) -> FgColorDisplay<'_, BrightBlue, Self>
fn bright_blue(&self) -> FgColorDisplay<'_, BrightBlue, Self>
Source§fn on_bright_blue(&self) -> BgColorDisplay<'_, BrightBlue, Self>
fn on_bright_blue(&self) -> BgColorDisplay<'_, BrightBlue, Self>
Source§fn bright_magenta(&self) -> FgColorDisplay<'_, BrightMagenta, Self>
fn bright_magenta(&self) -> FgColorDisplay<'_, BrightMagenta, Self>
Source§fn on_bright_magenta(&self) -> BgColorDisplay<'_, BrightMagenta, Self>
fn on_bright_magenta(&self) -> BgColorDisplay<'_, BrightMagenta, Self>
Source§fn bright_purple(&self) -> FgColorDisplay<'_, BrightMagenta, Self>
fn bright_purple(&self) -> FgColorDisplay<'_, BrightMagenta, Self>
Source§fn on_bright_purple(&self) -> BgColorDisplay<'_, BrightMagenta, Self>
fn on_bright_purple(&self) -> BgColorDisplay<'_, BrightMagenta, Self>
Source§fn bright_cyan(&self) -> FgColorDisplay<'_, BrightCyan, Self>
fn bright_cyan(&self) -> FgColorDisplay<'_, BrightCyan, Self>
Source§fn on_bright_cyan(&self) -> BgColorDisplay<'_, BrightCyan, Self>
fn on_bright_cyan(&self) -> BgColorDisplay<'_, BrightCyan, Self>
Source§fn bright_white(&self) -> FgColorDisplay<'_, BrightWhite, Self>
fn bright_white(&self) -> FgColorDisplay<'_, BrightWhite, Self>
Source§fn on_bright_white(&self) -> BgColorDisplay<'_, BrightWhite, Self>
fn on_bright_white(&self) -> BgColorDisplay<'_, BrightWhite, Self>
Source§fn bold(&self) -> BoldDisplay<'_, Self>
fn bold(&self) -> BoldDisplay<'_, Self>
Source§fn dimmed(&self) -> DimDisplay<'_, Self>
fn dimmed(&self) -> DimDisplay<'_, Self>
Source§fn italic(&self) -> ItalicDisplay<'_, Self>
fn italic(&self) -> ItalicDisplay<'_, Self>
Source§fn underline(&self) -> UnderlineDisplay<'_, Self>
fn underline(&self) -> UnderlineDisplay<'_, Self>
Source§fn blink(&self) -> BlinkDisplay<'_, Self>
fn blink(&self) -> BlinkDisplay<'_, Self>
Source§fn blink_fast(&self) -> BlinkFastDisplay<'_, Self>
fn blink_fast(&self) -> BlinkFastDisplay<'_, Self>
Source§fn reversed(&self) -> ReversedDisplay<'_, Self>
fn reversed(&self) -> ReversedDisplay<'_, Self>
Source§fn strikethrough(&self) -> StrikeThroughDisplay<'_, Self>
fn strikethrough(&self) -> StrikeThroughDisplay<'_, Self>
Source§fn color<Color>(&self, color: Color) -> FgDynColorDisplay<'_, Color, Self>where
Color: DynColor,
fn color<Color>(&self, color: Color) -> FgDynColorDisplay<'_, Color, Self>where
Color: DynColor,
OwoColorize::fg or
a color-specific method, such as OwoColorize::green, Read moreSource§fn on_color<Color>(&self, color: Color) -> BgDynColorDisplay<'_, Color, Self>where
Color: DynColor,
fn on_color<Color>(&self, color: Color) -> BgDynColorDisplay<'_, Color, Self>where
Color: DynColor,
OwoColorize::bg or
a color-specific method, such as OwoColorize::on_yellow, Read more