Expand description
Reusable output contract types for fallow.
This crate owns stable report DTOs that are not tied to CLI rendering.
Higher-level output assemblers live above this crate in fallow-api or the
CLI, while this crate remains the shared typed boundary those builders and
non-CLI consumers can use. Shared selectors such as OutputFormat stay in
fallow-types; this crate re-exports only the selectors needed to keep
output builders on one contract surface.
Modules§
- envelope
- JSON-output envelope and utility types:
SchemaVersion,ToolVersion,ElapsedMs,AuditIntroduced, plus the sharedMeta,BaselineDeltas,BaselineMatch,RegressionResult,EntryPoints, andCheckSummaryshapes referenced by every per-command envelope. The structs are always compiled (the JSON emission layer constructs them at runtime); theschemars::JsonSchemaderive is gated per-struct on theschemafeature. Typed envelope and utility-shape structs for the JSON output contract. - output
- JSON-output augmentation types:
IssueActionenum + variants. Schema-side counterpart of the augmentations the JSON layer adds to each dead-code finding. The structs are always compiled (typed dead-code wrappers inoutput_dead_codeconsume them at runtime); theschemars::JsonSchemaderive is gated per-struct on theschemafeature. Types that describe fallow’s JSON output contract. - output_
dead_ code - Typed envelope wrappers for the simple 1:1 dead-code findings
(
UnusedFile,PrivateTypeLeak,UnresolvedImport,CircularDependency,BoundaryViolation). Each wrapper flattens the bare finding via#[serde(flatten)]and carries a typedactionsarray populated at construction time, replacing the per-finding post-pass injection that previously graftedactions[]andintroducedonto the schema. Theintroducedfield is set by the audit pass via JSON map insertion and isNonewhen serialized directly from Rust. Theschemars::JsonSchemaderive is gated per-struct on theschemafeature. Typed envelope wrappers for the simple 1:1 dead-code findings whose actions are entirely determined by the wrapper type (no per-instance discriminants beyond what the bare finding already exposes). - output_
health - Per-action types attached to health findings, hotspots, refactoring
targets, and coverage-gap entries. Separated from the generic
IssueActiontree in theoutputmodule so the health-specific variants live in a dedicated module. The structs are always compiled (the JSON emission layer constructs them through typed wrappers such asoutput_health::UntestedFileAction); theschemars::JsonSchemaderive is gated per-struct on theschemafeature. Per-action types attached to each health finding by the JSON output layer.
Structs§
- Accepted
Judgment - One accepted judgment: the real anchored signal passed through with the agent’s framing FENCED as non-deterministic.
- Agent
Judgment - One agent judgment.
- Agent
Schema - The shape the agent must return, embedded in the guide so a thin skill needs no frozen copy. Documents the anchoring + staleness contract in the wire.
- Agent
Walkthrough - The agent’s returned judgment JSON.
- Audit
Next Steps Input - Runtime-independent inputs for audit next steps.
- Audit
Output fallow audit --format jsonenvelope.- Boundaries
List Logical Group - A pre-expansion
autoDiscoverlogical group surfaced for observability. Captured during expansion so consumers can see the user-authored parent name and grouping intent after expansion would otherwise flatten it out ofBoundariesListing::zones. - Boundaries
List Rule - A boundary import rule, expanded to operate on concrete child zone
names after
autoDiscoverflattening. The user’s pre-expansion rule (keyed on the logical parent name, if any) is preserved on the correspondingBoundariesListLogicalGroup::authored_rule. - Boundaries
List Zone - A boundary zone after preset and
autoDiscoverexpansion. Each entry classifies files into a single zone via glob patterns. - Boundaries
Listing boundariesblock carried byListBoundariesOutput.- Change
Anchor - One stable per-hunk CHANGE ANCHOR: a changed region the agent may cite as a
judgment anchor IN ADDITION to a
signal_id. Where asignal_idanchors a graph FINDING (“fallow emitted this exact finding”), a change_anchor anchors only a changed REGION (“fallow confirms this region changed”) , a strictly weaker guarantee, surfaced asanchor_kindon the accepted judgment so a consumer can tell the two apart. Graph/diff-derived; NEVER from prose. - Check
Grouped Entry - Single resolver bucket inside
CheckGroupedOutput. Carries the group’s identifier, optional section owners, and a per-group flattenedAnalysisResults. - Check
Grouped Output - Envelope emitted by
fallow dead-code --group-by ... --format json. - Check
Output - Envelope emitted by
fallow dead-code --format json(plus thecheckblock inside the combined and audit envelopes). - Check
Output Input - Inputs for building the dead-code JSON envelope.
- CiIssue
- Normalized CodeClimate issue used by CI comment renderers.
- Clone
Family Action - Per-action wire shape attached to each
CloneFamilyFinding. Mirrors the action types previously emitted bybuild_clone_family_actions:extract-shared, oneapply-suggestionperRefactoringSuggestionon the family, and a trailingsuppress-line. - Clone
Group Action - Per-action wire shape attached to each
CloneGroupFindingandAttributedCloneGroupFinding. Mirrors the action types previously emitted byinject_dupes_actions::build_clone_group_actionsincrates/cli/src/report/json.rs:extract-sharedplussuppress-line. - Clone
Sibling Evidence - A duplicate-code sibling referenced in target evidence.
- Code
Climate Issue - Single CodeClimate-compatible issue inside
CodeClimateOutput. - Code
Climate Issue Input - Fields needed to build one CodeClimate issue.
- Code
Climate Lines lines.beginforCodeClimateLocation.- Code
Climate Location - Location block inside
CodeClimateIssue::location. - Code
Climate Output - Envelope emitted by
fallow --format codeclimateandfallow --format gitlab-codequality. GitLab Code Quality consumes the same shape. The wire form is a bare JSON array, not an object. - Combined
Meta - Optional
_metablock forCombinedOutput. - Combined
Next Steps Input - Runtime-independent inputs for bare
fallowcombined next steps. - Combined
Output - Bare
fallow --format jsonenvelope. - Complexity
Violation - Inner complexity-violation payload.
- Component
Rollup - Containment
Event - A commit-gate containment event recorded by
fallow impact. - Contributing
Factor - A contributing factor that triggered or strengthened a recommendation.
- Contributor
Entry - Coordination
GapFact - One coordination-gap entry: a changed file exports symbols consumed by a
consumer_filethat is NOT in the diff. Deduped per (changed, consumer) pair (firing-precision rule R2). - Coverage
Analyze Output - Coverage
GapSummary - Aggregate coverage-gap counters for the current analysis scope.
- Coverage
Gaps - Static test coverage gaps derived from the module graph. Shows runtime files and exports with no test dependency path.
- Coverage
Intelligence Action - Machine-actionable next step for a coverage-intelligence finding.
- Coverage
Intelligence Evidence - Compact evidence values that led to a recommendation.
- Coverage
Intelligence Finding - One combined coverage-intelligence finding.
- Coverage
Intelligence Report - Combined coverage, runtime, complexity, and change-scope verdicts.
- Coverage
Intelligence Summary - Aggregate metadata for coverage-intelligence output.
- Coverage
Setup File ToEdit - Coverage
Setup Member - Coverage
Setup Output fallow coverage setup --jsonenvelope.- Coverage
Setup Snippet - Cross
Repo Impact Report - The cross-repo aggregate report,
fallow impact --all --format json. - Cross
Repo Project Entry - One project’s row in the cross-repo roll-up.
- Cross
Repo Totals - Grand totals across every tracked project (including repos whose directory no longer exists on disk: their past wins still count toward lifetime impact).
- CssAnalytics
Report - Structural CSS analytics surfaced by
fallow health --css. - CssAnalytics
Summary - Project-wide CSS analytics aggregates across every analyzed stylesheet
(including stylesheets with no notable rule, which are not listed
individually in
files). - CssBlock
Occurrence - One occurrence of a duplicate declaration block.
- CssCandidate
Action - A read-only verification step attached to a CSS cleanup candidate.
- CssDuplicate
Block - A group of style rules across the project that share an identical declaration block: a copy-paste consolidation candidate (fallow’s duplication signal applied to CSS). Only blocks of 4+ declarations appearing in 2+ rules are reported, so the signal stays a strong copy-paste indicator rather than flagging legitimately-repeated small blocks.
- CssFile
Analytics - Per-stylesheet CSS analytics.
- CssNotation
Consistency - A design-token notation-consistency candidate: the distinct notations used
across the codebase for one value axis (today, length units on
font-size), with a per-notation distinct-value count. Emitted only above a floor, since mixing notations for one axis is a “no single source of truth” smell. Advisory: the action is “standardize on one notation”, not a single search. - CssNotation
Count - One notation bucket and the count of distinct values authored in it.
- CvaDuplicate
Variant Block - A duplicated CVA / shadcn variant class block.
- CvaVariant
Token Drift - A CVA / shadcn variant class value that can reuse an existing styling token.
- Dead
Code Next Steps Input - Runtime-independent inputs for standalone dead-code next steps.
- Decision
- One consequential structural decision, framed as a judgment question for a human with taste, anchored to a fallow-emitted signal.
- Decision
Action - A structured action attached to a surfaced decision (the agent-actionable surface). Mirrors the typed-action shape the rest of fallow emits.
- Decision
Surface - The ranked, capped decision surface plus the set of signal_ids the deterministic layer emitted (the anti-hallucination allowlist).
- Decision
Surface Output - The separable
decision-surfaceenvelope: the single call that puts taste- decisions in front of a human, callable WITHOUT the full pipeline (thedecision_surfaceMCP tool’s output). Carrieskind/schema_versionplus structuredactions[]per decision. - Decision
Surface Schema Version - Independently-versioned wire-version newtype. Serializes as the integer
DECISION_SURFACE_SCHEMA_VERSION. - Decision
With Actions - One decision plus its structured
actions[]. - Diff
Index - Parsed, command-neutral index of files and added lines in a unified diff.
- Diff
Triage - Stage 0 of the brief: triage facts derived purely from the diff size.
- Direct
Caller Evidence - A direct importer referenced in target evidence.
- Direct
Caller Symbol Evidence - Symbol details for a direct importer.
- Direction
Unit - One directed review unit projected from the graph: a file the change touches, the concern to check, the out-of-diff consumers it must account for, and the routed expert. Graph-derived only (routing + impact closure), NEVER from prose.
- Dupes
Next Steps Input - Runtime-independent inputs for standalone duplication next steps.
- Dupes
Output - Envelope emitted by
fallow dupes --format json. - Dupes
Output Input - Inputs for constructing a
DupesOutputwithout exposing envelope assembly details to callers. - Evidence
Function - A function referenced in target evidence.
- Existing
PrComment - Explain
Output - Envelope emitted by
fallow explain <issue-type> --format json. - Feature
Flag Action - Per-finding action emitted for feature flag findings.
- Feature
Flag Dead Code Overlap - Dead-code overlap block attached when a flag guards unused exports.
- Feature
Flag Finding - One feature flag finding in JSON output.
- Feature
Flags Confidence Meta - Feature flag confidence explanations.
- Feature
Flags Kind Meta - Feature flag kind explanations.
- Feature
Flags Meta _meta.feature_flagsdetails emitted with--explain.- Feature
Flags Meta Details - Feature flag explanatory metadata.
- Feature
Flags Output - Envelope emitted by
fallow flags --format json. - Feature
Flags Output Input - Inputs for building
fallow flags --format json. - File
Health Score - Per-file health score combining complexity, coupling, and dead code metrics.
- FixJson
Output - JSON root emitted by
fallow fix --format json. - FixJson
Output Input - Inputs for building
fallow fix --format json. - Focus
Map - The weighted focus map: the ranked
review-hereunits plus the FULLdeprioritizedescape-hatch list, so nothing is hidden. - Focus
Score - The composite attention score, with the deterministic component sub-scores kept on the wire so the runtime layer adds its weight without recomputing the signals.
- Focus
Unit - One review unit on the focus map: its file, composite score, label, human reason, and any confidence flags.
- Framework
Health Detector - Status for one framework-specific health detector.
- Framework
Health Diagnostics - Framework-specific health detector coverage surfaced for agent consumers.
- GitHub
Review Comment - GitHub pull-request review comment.
- GitLab
Review Comment - GitLab merge-request discussion comment.
- GitLab
Review Position positionblock insideGitLabReviewComment. Mirrors the GitLab merge-request discussion-position API.- Graph
Facts - Stage 1 of the brief: graph-derived orientation facts.
- Grouped
Review Issues - Health
Action Context - Construction-time context for
HealthFinding::with_actions. - Health
Action Options - Options controlling how the action builder populates
actions. - Health
Actions Meta - Auditable breadcrumb recording when health-finding
suppress-lineaction hints were omitted from the report. - Health
Configured Thresholds - Threshold values configured by a single override entry.
- Health
Effective Thresholds - Resolved thresholds used to evaluate a health finding.
- Health
Finding - Wire envelope for a single complexity finding.
- Health
Group - A health report scoped to a single group.
- Health
Grouping - Wrapper carrying the resolver mode label alongside the partitioned groups.
- Health
Json Output Input - Inputs for serializing a health report into the root JSON contract.
- Health
Next Steps Input - Runtime-independent inputs for standalone health next steps.
- Health
Output - Envelope emitted by
fallow health --format json(plus thehealthblock inside the combined and audit envelopes). - Health
Output Input - Inputs for constructing a
HealthOutputwithout exposing envelope assembly details to callers. - Health
Report - Result of complexity analysis for reporting.
- Health
Score - Health
Score Penalties - Per-component penalty breakdown for the health score.
- Health
Summary - Summary statistics for the health report.
- Health
Timings - Detailed timing breakdown for the health pipeline.
- Health
Trend - Trend comparison between the current run and a previous snapshot. Shows per-metric deltas with directional indicators.
- Hotspot
Entry - A hotspot: a file that is both complex and frequently changing.
- Hotspot
Finding - Wire envelope for a single hotspot entry.
- Hotspot
Summary - Impact
Closure Facts - Stage 3 of the brief: the impact closure. The transitive affected-but-not-in-diff set plus the coordination gap. The differentiator a diff tool fundamentally cannot do, because it has no graph.
- Impact
Counts - Per-category issue counts captured at a recorded run.
- Impact
Digest Counts - Local impact digest counters used to render the
impact-reportnext step. - Impact
Report - The rendered impact report, derived purely from the store.
- Inspect
Evidence - Inspect
Evidence Section - Inspect
File Identity - Inspect
Output - Envelope emitted by
fallow inspect --format json. - Inspect
Symbol Identity - Issue
Output Contract - Output-facing contract metadata for a serialized dead-code result row.
- Large
Function Entry - A function exceeding the very-high-risk size threshold (>60 LOC).
- List
Boundaries Output - Envelope emitted by
fallow list --boundaries --format json. Surfaces the architecture boundary zones, rules, and the user’s pre-expansionautoDiscoverlogical groups so consumers can render grouping intent that expansion would otherwise flatten out ofzones[]. - List
Entry Point Output - One entry point in
fallow list --entry-points --format json. - List
Output - Plain body emitted by
fallow list --format jsonbefore an optional command-specific root envelope is attached. - List
Plugin Output - One active plugin in
fallow list --plugins --format json. - Near
Duplicate Theme Token - A Tailwind v4
@themetoken that appears to duplicate an existing token by value. Emitted conservatively for comparable token namespaces, with the nearest existing token named so an agent has a concrete reuse target. - Nearest
Styling Token - A styling token candidate that can replace or explain a finding.
- Ownership
Metrics - Partition
Facts - Stage 2 of the brief: the partition + order. The changed files split into coherent BY-MODULE units (the only byte-identical-deterministic clustering definition straight from the graph), plus a dependency-sensible review ORDER over those units (definitions before consumers, mechanical/leaf units last, ties broken by the path sort). Stage 2 sits UNDER the decision surface as a drill-down; it is the backbone the directed-review loop hands the agent.
- PrComment
Envelope - Rendered PR comment body plus posting signals for provider adapters.
- PrComment
Post Plan - PrComment
Post Plan Input - PrComment
Render Input - Inputs for rendering a sticky PR/MR summary comment.
- PrComment
Truncation - PrDecision
Annotation - PrDecision
Details - PrDecision
Gate - PrDecision
Surface - PrDetails
Artifact - PrDetails
Row - PrDetails
Section - PrStatus
Context - PrSummary
Area - PrSummary
Finding - PrSummary
Input - RawStyle
Value - A located raw CSS declaration value on a scale-sensitive styling axis.
- React
Hook Profile - Per-component React hook profile derived from the cached
hook_usesIR at the health layer. Descriptive context that refines the bareComplexityViolation::react_hook_countheadline with a per-kind breakdown and the maximumuseEffectdependency-array arity. - Refactoring
Target - Refactoring
Target Finding - Wire envelope for a single refactoring target.
- Rejected
Judgment - One rejected judgment plus the reason it was rejected.
- Render
FanIn TopComponent - One located high-fan-in React/Preact component for the descriptive
top_render_fan_inblast-radius list onVitalSigns. - Resolution
Event - A resolved or suppressed finding attribution event.
- Review
Brief Output - The full
fallow audit --brief --format jsonenvelope. Carries the informational verdict, the triage and graph-facts orientation stages, plus the reused “subtract” section (the same dead-code / duplication / complexity payloadfallow audit --format jsonemits). - Review
Brief Schema Version - Independently-versioned wire-version newtype for the brief envelope.
Serializes as the integer
REVIEW_BRIEF_SCHEMA_VERSION. - Review
Brief Subtract Sections - CLI-built audit subreports that are embedded in the audit brief envelope.
- Review
Comment Render Input - Review
Deltas - Diff-aware deterministic deltas (6.A), framed new-vs-pre-existing against the audit base snapshot. Each entry is a brief summary/verdict line.
- Review
Direction - The review direction artifact: the order to review in, the coherent units, and per-unit concern lens + out-of-diff + expert. A minimal projection of the EXISTING graph facts (routing units + impact closure); the full weighted-focus engine is a later epic. Graph-derived only (injection-resistant).
- Review
Envelope Meta metablock insideReviewEnvelopeOutput.- Review
Envelope Output - Envelope emitted by
fallow --format review-github/review-gitlab. - Review
Envelope Render Input - Inputs for rendering a GitHub/GitLab review envelope.
- Review
Envelope Render Result - Rendered review envelope plus side-channel signals for CLI telemetry.
- Review
Envelope Summary - Summary block on
ReviewEnvelopeOutput. - Review
Envelope Truncation - Truncation signals produced while rendering a review envelope.
- Review
Gitlab Diff Refs - GitLab diff refs for a review-envelope position.
- Review
Reconcile Output - Envelope emitted by
fallow ci reconcile-review --format json. Used by CI integrations to drive comment carry-over and stale-comment cleanup across PR / MR revisions. - Review
Unit Fact - One review unit: a coherent by-module cluster of the changed set.
- Risk
Profile - Risk profile: percentage of functions in each risk bin.
- Routing
Facts - The full routing section: one unit per changed source file with a routable signal. Files with no ownership signal are omitted (no noise).
- Routing
Unit - One routed unit with its experts and bus-factor flag.
- Runtime
Coverage Action - Suggested follow-up action for a runtime coverage finding.
- Runtime
Coverage Blast Radius Entry - Runtime
Coverage Capture Quality - Quality-of-capture signals emitted by the sidecar so the CLI can explain short-window captures honestly instead of letting users blame the tool.
- Runtime
Coverage Discriminators - Discriminator inputs that PRODUCED a finding’s verdict (fallow-rs/fallow-cloud#321),
emitted alongside the verdict so an agent can reproduce it and see the
minimum-observation confidence cap instead of re-deriving them from scratch.
F4: these make the EXISTING Fallow-owned discriminators legible; they are not
a new or external signal and gate nothing. Pairs with
evidence.static_status(the static half of the discriminator set). - Runtime
Coverage Evidence - Supporting evidence for a finding (mirrors
fallow_cov_protocol::Evidence). - Runtime
Coverage Finding - Runtime
Coverage HotPath - Runtime
Coverage Importance Entry - Runtime
Coverage Message - Runtime
Coverage Provenance - Provenance of a runtime-coverage report (fallow-rs/fallow-cloud#319), mirroring
the cloud runtime-context
provenanceblock so the local-capture and cloud surfaces present one portable shape. F4: provenance is context only; it never gates a verdict or confidence. - Runtime
Coverage Report - Runtime coverage findings merged into the health report or emitted by
fallow coverage analyze. Present in health output when –runtime-coverage is used. Shape mirrors the runtime coverage JSON contract; cloud mode fetches runtime facts explicitly and merges them locally with AST/static analysis. - Runtime
Coverage Summary - Summary block mirroring
fallow_cov_protocol::Summary(0.3 shape). - Sarif
Document Input - Fields needed to build a SARIF document envelope.
- Sarif
Result Input - Fields needed to build one SARIF result object.
- Sarif
Rule Input - Fields needed to build one SARIF rule object.
- Scoped
Unused Classes - A Vue SFC’s
<style scoped>classes that appear nowhere else in the component (cleanup candidates). - Security
Blind Spot File - One file inside a blind-spot group.
- Security
Blind Spot Group - One actionable blind-spot group.
- Security
Blind Spots Output - The
fallow security blind-spots --format jsonenvelope. - Security
Blind Spots Summary - Aggregate counts for blind-spot output.
- Security
Gate - The
gateblock onSecurityOutput, present only when--gate <mode>ran. Invariant:verdict == Fail IFF exit code 8 IFF new_count > 0. - Security
Output - The
fallow security --format jsonenvelope.FallowOutputdiscriminates it by thekind: "security"tag; the optionalgateblock is additive and is not part of that discrimination. - Security
Output Config - Allowlisted config context for
fallow security --format json. - Security
Output Rules Config - Security
Reachability Counts - Fixed reachability counters for summary JSON.
- Security
Rule Meta - Output-facing metadata for one security rule.
- Security
Rule Severity Config - Security
Runtime State Counts - Fixed runtime coverage counters for summary JSON.
- Security
Severity Counts - Fixed severity counters for summary JSON.
- Security
Summary - Aggregate counts for
fallow security --summary --format json. - Security
Summary Output - Compact
fallow security --summary --format jsonpayload. Uses the samekind: "security"discriminator as the full payload, but omits candidate arrays and exposes only aggregate counts. - Security
Survivor - One verifier-retained candidate row.
- Security
Survivors Output - The
fallow security survivors --format jsonenvelope. - Security
Survivors Summary - Aggregate counts for survivor rendering.
- Security
Unresolved Callee Diagnostics - Bounded unresolved-callee diagnostics for
fallow security --format json. - Security
Unresolved Callee Reason Count - Count of unresolved callees for one reason.
- Security
Unresolved Callee Sample - One sampled unresolved-callee row.
- Security
Unresolved Callee TopFile - Count of unresolved callees in one file.
- Security
Verifier Verdict - One supported verifier verdict input row.
- Styling
Finding - One advisory STYLING FINDING: the graduation of a descriptive css candidate
into a first-class, severity-aware, suppressible finding surfaced in
fallow audit. The styling domain’s OWN finding type (not borrowed into the dead-codeAnalysisResults, and not glued in the CLI).codeis the kebab IssueKind code (e.g.css-token-drift), so severity / inline suppression / SARIF / MCP all resolve via the sharedissue_metacontract throughIssueKind::parse(code). OneVec<StylingFinding>carries every styling family; thecodediscriminates. - Styling
Health - Project-level styling-health score: a SECOND health axis computed purely from
the structural CSS analytics (
CssAnalyticsReport), orthogonal to the JS/TS code-healthHealthScore. Surfaced only alongside the--cssanalytics, so a plainfallow healthrun is byte-unchanged. The code score and grade stay untouched: styling health is additive, never folded into the code score. - Styling
Health Penalties - Per-category penalty breakdown for the styling-health score. Each field is the
number of points subtracted from a starting 100 for one CSS signal family,
already capped at its category ceiling. A
0.0field means “the signal was evaluated and clean”; the whole struct is only ever built when CSS analytics were produced, so there is no “missing pipeline” ambiguity to model withOptionhere (the parentStylingHealthis itselfOptionon the report). - Tailwind
Arbitrary Value - A distinct Tailwind arbitrary-value utility token used in markup, with its total use count and first location (a design-token-bypass candidate).
- Target
Evidence - Evidence linking a target back to specific analysis data.
- Target
Thresholds - Adaptive thresholds used for refactoring target scoring.
- Threshold
Override Metrics - Current complexity metrics for a matched threshold override entry.
- Threshold
Override State - Report entry describing whether a threshold override is active, stale, or no longer matching any analyzed file or function.
- Token
Consumer Location - Where one Tailwind v4
@themetoken is consumed, and through which surface. One entry in aTokenConsumers::consumerssample. - Token
Consumers - A location-aware reverse index of where one design token is consumed, so an
agent editing the token can see its blast radius before changing or removing
it. Covers TWO token origins. The always-available discriminator is the
tokenSHAPE: a Tailwind token is the---prefixed custom property (--color-brand), a CSS-in-JS token is a dotted access path with no--prefix (vars.color.primary). The per-consumerkindalso discriminates origin, but only whenconsumer_count > 0(aconsumer_count: 0entry has an emptyconsumersarray and thus nokind), so branch on thetokenprefix for the zero-consumer case. The two origins: - Trace
Unused Export Input - Deterministic unused-export trace target selected by the caller.
- Trend
Count - Raw numerator/denominator for a percentage metric.
- Trend
Metric - A single metric’s trend between two snapshots.
- Trend
Point - A reference to a snapshot used in trend comparison.
- Trend
Summary - A computed trend between the two most recent records.
- Truncation
Note - A note for decisions collapsed below the cap.
- TsAlias
Meta - TypeScript backwards-compat alias emitted for a dead-code result row.
- Undefined
Keyframes - An animation reference (
animation/animation-name) to a@keyframesname that is defined in no stylesheet anywhere in the project (the “used-but-undefined” direction). Usually a typo or a removed animation; occasionally a@keyframesdefined in CSS-in-JS the CSS parser never sees. - Unreferenced
CssClass - A global CSS class defined in a plain
.css/.scssrule whose literal name is referenced by no in-project markup (the CSS analogue of an unused export). A heavily-gated candidate, never a gated finding: the class may be applied from an HTML email, server template, CMS, or Markdown the parser never sees. - Unreferenced
Keyframes - A
@keyframesdefined in a stylesheet but referenced by no animation in any stylesheet (cleanup candidate). - Unresolved
Class Reference - A static
class/classNametoken in markup that matches no CSS class defined anywhere in the project but is one edit away from a class that IS defined (a likely typo or stale rename). The CSS analogue of an unresolved import. A candidate, never a gated finding: the token could be defined in CSS-in-JS or an external stylesheet the parser never sees. - Untested
Export - Runtime export that no test-reachable module references.
- Untested
Export Finding - Wire-shape envelope for an
UntestedExportfinding. Same pattern asUntestedFileFinding: flattens the bare finding and carries a typedactionsarray computed at construction time. - Untested
File - Runtime code that no test dependency path reaches.
- Untested
File Finding - Wire-shape envelope for an
UntestedFilefinding. Carries the bareUntestedFileflattened in plus a typedactionsarray. The action vec is computed at construction time using a project-root-relative path so descriptions matchstrip_root_prefix’s post-pass output on the innerpathfield. Schemars derives the merged shape natively; this retires theaugment_finding_definitiongraft forUntestedFile. - Unused
AtRule - An unused CSS at-rule entity (an
@propertyregistration with novar()reference, or an@layerdeclaration never populated), located by its first definition. A cleanup candidate, never a gated finding. - Unused
Font Face - An
@font-facefamily declared in a stylesheet but referenced by nofont-familyanywhere in the project: a dead web-font payload. A cleanup candidate (the family could be applied from inline styles or JavaScript). - Unused
Theme Token - A Tailwind v4
@themedesign token defined in a stylesheet whose generated utility,var()reads, and arbitrary-value references appear nowhere in the project: a dead design token (theunused-exportof the token era). A candidate, never a gated finding: the token could be consumed by a Tailwind plugin, a published design-system surface, or a non-CSS-aware build step the scan cannot see (those cases are gated out before this is emitted). - Vital
Signs - Project-wide vital signs: a fixed set of metrics for trend tracking.
- Vital
Signs Counts - Raw counts backing the vital signs percentages.
- Vital
Signs Snapshot - A point-in-time snapshot of project vital signs, persisted to disk.
- Walkthrough
Accounting - Honest file accounting for the walkthrough header + status, reconciled so the
numbers add up:
staged + cleared + excluded == changed. - Walkthrough
Guide - The
fallow review --walkthrough-guideenvelope: the current digest + schema the agent fetches. The tool owns this; the skill stays thin (it fetches this rather than embedding a frozen copy). Always emitted with exit 0. - Walkthrough
Validation - The
fallow review --walkthrough-filevalidation envelope: the result of post-validating the agent’s judgment against the live graph. Always exit 0. - Weakening
Signal - One weakening signal: a category, the file it was detected in, and a short human-readable evidence string. Reviewer-private; never gates.
- Workspace
Info - One workspace package emitted by
fallow workspaces --format json. - Workspaces
Output fallow workspaces --format jsonenvelope.
Enums§
- Audit
Command - Audit command singleton carried by
AuditOutput. - CiProvider
- Supported CI review providers for generated comments.
- Clone
Family Action Type - Discriminant for
CloneFamilyAction::kind. - Clone
Group Action Type - Discriminant for
CloneGroupAction::kind. Mirrors the action types emitted by the legacybuild_clone_group_actionswalker. - Code
Climate Annotation Field - Optional grouped CodeClimate annotation field.
- Code
Climate Issue Kind - Discriminator value for
CodeClimateIssue::kind. - Code
Climate Severity - CodeClimate severity scale.
- Confidence
- Confidence level for a refactoring recommendation.
- Confidence
Flag - A per-unit confidence flag. The EXACT panel-decided strings: a dynamically- wired or re-export-heavy unit carries one so its static-reachability signal is not trusted as complete (the anti-silent-de-prioritization guard). The flag NEVER lowers the score; it is advisory provenance.
- Consumer
Kind - The surface through which a design token is consumed. The
theme-var/css-var/utility/applykinds are Tailwind v4@themeconsumption; thejs-member/js-callkinds are CSS-in-JS consumption (member access on an imported StyleX/vanilla-extract token binding, or a PandaCSStoken('...')call). The kind is the disjoint origin signal that distinguishes a Tailwind token entry from a CSS-in-JS token entry in the sharedtoken_consumerslist. - Contributor
Identifier Format - Coverage
Analyze Schema Version - Coverage
Intelligence Confidence - Confidence in the joined evidence and resulting recommendation.
- Coverage
Intelligence Match Confidence - Confidence tier for the cross-surface evidence match.
- Coverage
Intelligence Recommendation - Recommended action family for a combined finding.
- Coverage
Intelligence Schema Version - Coverage-intelligence JSON contract version. Scoped to the
coverage_intelligenceblock and independent of the top-level fallow JSONschema_version. - Coverage
Intelligence Signal - Ordered evidence signals behind a coverage-intelligence finding.
- Coverage
Intelligence Verdict - Headline verdict for the combined coverage-intelligence report.
- Coverage
Model - Coverage model used for CRAP score computation.
- Coverage
Setup Framework - Coverage
Setup Package Manager - Coverage
Setup Runtime Target - Coverage
Setup Schema Version - Coverage
Source - Provenance of a CRAP finding’s coverage signal.
- Coverage
Source Consistency - Whether CRAP findings in the report used one coverage-source kind or a mix.
- Coverage
Tier - Coverage tier classification for CRAP findings.
- Cross
Repo Impact Schema Version - Independent wire-version for the cross-repo report, on its own cadence (it
versions separately from the per-project
ImpactReportSchemaVersionand the on-diskSTORE_SCHEMA_VERSION). - CssCandidate
Action Type - Discriminant for
CssCandidateAction::kind. - Decision
Action Type - The discriminated action kinds a decision can carry.
- Decision
Category - The exactly-three shippable decision categories (the SOLID-3). No cut category (abstraction / deletion / convention / irreversibility) is representable: this enum is the structural guarantee that confirmed-noise categories never ship.
- Effort
Estimate - A ranked refactoring recommendation for a file.
- Enabled
Source - Why Impact tracking is (or is not) active for a project.
Project= an explicit per-repoenable;User= the user-global default with no per-repo decision;Default= off (no per-repo decision and no global default). - Exceeded
Threshold - Which complexity threshold was exceeded.
- Fallow
Output - Typed root of every fallow JSON envelope shape that serializes as a JSON
object and participates in the documented
FallowOutputcontract. The schema derived from this enum drives the document-rootoneOfindocs/output-schema.json. - Feature
Flag Action Type - Feature flag action discriminants.
- Feature
Flag Confidence - Feature flag confidence values emitted in JSON.
- Feature
Flag Kind - Feature flag kind values emitted in JSON.
- Finding
Severity - Severity tier indicating how far a function exceeds complexity thresholds.
- Focus
Label - The focus label for a review unit.
Skipis the SAFE explicit-skip label and is runtime-backed ONLY: it is producible solely on the paid runtime path and solely for a unit runtime-proves cold with zero risk signals. Free mode (no runtime evidence) emits onlyReviewHere/NotPrioritized, neverSkip(the build-focus-map labeller cannot reach theSkiparm without runtime input), so the free-tier “rank but never skip” stance holds by construction. - Framework
Health Detector Status - Detector status codes for framework health observability.
- GitHub
Review Side - Singleton side discriminator for
GitHubReviewComment::side. - GitLab
Review Position Type - Singleton position-type discriminator for
GitLabReviewPosition. - Group
ByMode - Resolver mode label for grouped envelopes (dead-code, dupes, health).
- Impact
Report Schema Version - Wire-version discriminator for
ImpactReport. Independent from the globalSchemaVersion(the impact report versions on its own cadence) and from the on-diskSTORE_SCHEMA_VERSION(the persisted store shape versions separately). Serializes as a stringconstso JSON consumers can switch on it, matching the other independently-versioned envelopes (e.g.CoverageAnalyzeSchemaVersion). - Impact
Trend Direction - Direction of a count trend between two recorded runs.
- Inspect
Evidence Scope - Inspect
Identity - Inspect
Section Status - Inspect
Target Descriptor - Output
Format - Output format for fallow results.
- Ownership
State - PrComment
Layout - PrComment
Post Action - PrComment
Post Skip Reason - PrDecision
Annotation Level - PrDecision
Conclusion - PrStatus
Mode - PrSummary
Scope - PrSummary
Status - Recommendation
Category - Category of refactoring recommendation.
- Review
Check Conclusion meta.check_conclusionfor the GitHub review envelope. Maps to the GitHub Checks API conclusion field.- Review
Comment - Per-line review comment. Schema is an
anyOfbetween GitHub and GitLab shapes; at runtime every entry in a single envelope comes from the same provider because the envelope is built from one provider’s branch incrates/cli/src/report/ci/review.rs::render_review_envelope. - Review
Effort - Suggested reviewer effort, a pure function of
RiskClass. - Review
Envelope Event - Singleton GitHub review-event marker.
- Review
Envelope Schema - Schema-version discriminator for the review envelope.
- Review
Provider - Review-envelope provider tag.
- Review
Reconcile Schema - Schema-version discriminator for the review reconcile envelope.
- Risk
Class - Coarse risk classification for a changeset, a pure function of the change size (file count plus, once threaded, net lines).
- Root
Envelope Mode - JSON root envelope discriminator policy.
- Runtime
Coverage Confidence - Confidence level for a runtime coverage finding.
- Runtime
Coverage Data Source - Runtime coverage source used to produce the summary.
- Runtime
Coverage Report Verdict - Top-level verdict for the whole runtime-coverage report. Mirrors
fallow_cov_protocol::ReportVerdict. The verdict is the SINGLE most actionable finding; for the full set of findings seeRuntimeCoverageReport::signals. The verdict promoteshot-path-touchedabovecold-code-detectedin PR-review context (when the CLI was given a change-scope:--diff-fileor--changed-since) because the touched-hot-path is event-tied to the current diff and reviewers need it to be the top-line signal. In standalone analysis (no change scope),cold-code-detectedremains primary. - Runtime
Coverage Risk Band - Blast-radius risk band. The current thresholds are high at >=20 static callers or >=1,000,000 traffic-weighted caller reach; medium at >=5 callers or >=50,000 weighted reach; low otherwise.
- Runtime
Coverage Schema Version - Runtime coverage JSON contract version. This is scoped to the
runtime_coverageblock and is independent of the top-level fallow JSONschema_version. - Runtime
Coverage Signal - Discrete signal captured during runtime-coverage post-processing.
verdictcollapses to one summary value;signalsenumerates ALL findings the report carries so JSON consumers, CI dashboards, and agents can reason about them independently of the headline. Order is stable: severity-descending so the first entry mirrors a sensible non-PR-context verdict. - Runtime
Coverage Verdict - Protocol-level per-function runtime coverage verdict derived from the
decision table in fallow-cov-protocol. The CLI’s
runtime_coverage.findingsarray omitsactiveentries even though the underlying enum still includes it. - Runtime
Coverage Watermark - License or trial watermark applied to runtime coverage output.
- Security
Blind Spots Schema Version - The
fallow security blind-spots --format jsonschema version. - Security
Gate Verdict - Gate verdict on the wire.
failis the CI-state token; human output renders it as “REVIEW REQUIRED” because these stay unverified candidates, never confirmed vulnerabilities. - Security
Schema Version - The
fallow security --format jsonschema version. Independently versioned from the main contract, mirroringImpactReportSchemaVersion. - Security
Survivors Schema Version - The
fallow security survivors --format jsonschema version. - Security
Verifier Verdict Status - Verifier verdict status accepted by
fallow security survivors. - Styling
Agent Disposition - Agent handling hint for a
StylingFinding. - Styling
Finding Confidence - Confidence hint for a
StylingFinding. - Styling
Finding Severity - Effective configured severity for a styling finding.
- Styling
Health Confidence - Trust level for a
StylingHealthgrade. TWO variants (not the three-tierhigh/medium/lowofcrate::Confidence/FeatureFlagConfidence) ON PURPOSE: styling confidence is binary (the grade is either reliable for the analyzed surface or it is not), not three distinct evidence tiers, so a never-emittedMediumwould be dead surface. Serializes lowercase ("high"/"low"), matching the sibling confidence enums’ vocabulary. - Threshold
Override Status - Lifecycle state for a configured threshold override.
- Threshold
Source - Source for a finding’s effective thresholds.
- Trend
Direction - Direction of a metric’s change, semantically (improving/declining/stable).
- Unused
AtRule Kind - Discriminant for
UnusedAtRule::kind. - Weakening
Kind - The category of a single weakening signal.
Constants§
- ACTIONS_
AUTO_ FIXABLE_ FIELD_ DEFINITION _metadescription for the per-actionauto_fixablebool.- ACTIONS_
FIELD_ DEFINITION _metadescription for the per-findingactions[]array shared across JSON output.- ALL_
CATEGORIES - Every shippable decision category.
- CHECK_
DOCS - Docs URL for the dead-code/check command.
- CHECK_
SCHEMA_ VERSION - Current schema version for the dead-code/check JSON envelope.
- COGNITIVE_
EXTRACTION_ THRESHOLD - COVERAGE_
ANALYZE_ DOCS - Docs URL for
fallow coverage analyze --format json --explain. - COVERAGE_
SETUP_ DOCS - Docs URL for the runtime coverage setup command’s agent-readable JSON.
- DECISION_
SURFACE_ SCHEMA_ VERSION - Wire version for the
fallow decision-surface --format jsonenvelope. - DEFAULT_
COGNITIVE_ CRITICAL - DEFAULT_
COGNITIVE_ HIGH - DEFAULT_
CRAP_ CRITICAL - CRAP score threshold for “critical” severity. CC=10 untested gives 110, CC=12 untested gives 156; 100 lands between the two and flags genuinely dangerous combinations of high complexity and low coverage.
- DEFAULT_
CRAP_ HIGH - CRAP score threshold for “high” severity. CC=7 untested -> 56, CC=10 -> 110.
- DEFAULT_
CYCLOMATIC_ CRITICAL - DEFAULT_
CYCLOMATIC_ HIGH - DUPES_
DOCS - Docs URL for the duplication command.
- DUPES_
SUPPRESS_ COMMENT - Inline suppression comment emitted for code duplication findings.
- DUPES_
SUPPRESS_ DESCRIPTION - Shared description for the suppression action emitted on duplication findings.
- GHAS_
SARIF_ FINGERPRINT_ KEY - Conventional SARIF key consumed by GitHub Code Scanning.
- HEALTH_
DOCS - Docs URL for the health command.
- HEALTH_
SCORE_ FORMULA_ VERSION - HOTSPOT_
SCORE_ THRESHOLD - INJECTION_
NOTE - The standing injection-resistance note stamped on every guide.
- MARKER_
PREFIX_ V2 - Marker prefix appended to every v2 review-comment body.
- MARKER_
REGEX_ FLAGS_ V2 - Canonical v2 marker-regex flags.
- MARKER_
REGEX_ V2 - Canonical v2 marker-regex literal.
- MARKER_
SUFFIX_ V2 - Closing of the v2 marker, after the fingerprint string.
- MAX_
ADDED_ LINES - Stop indexing added lines past this count.
- MAX_
COMMENT_ BODY_ BYTES - MAX_
CONTRACT_ MEMBERS - Max contract members named inline in a coordination fact before collapsing the rest into a “+N more” suffix. Keeps the most load-bearing line readable in a terminal without discarding the trailing guidance.
- MAX_
DIFF_ BYTES - Refuse to parse a unified diff larger than this.
- MI_
DENSITY_ MIN_ LINES - Minimum lines of code for full complexity density weight in the MI formula.
- PROJECT_
LEVEL_ RULE_ IDS - Rule ids whose findings describe project-wide config state rather than a change touching a specific source line.
- PR_
DECISION_ SCHEMA - PR_
DETAILS_ SCHEMA - REVIEW_
BRIEF_ SCHEMA_ VERSION - Wire version for the
fallow audit --brief --format jsonenvelope. - RUNTIME_
STALE_ AFTER_ DAYS - Staleness cutoff in days, mirrored from the cloud runtime-context
(
RUNTIME_STALE_AFTER_DAYS) so the local and cloud contracts agree. - SARIF_
FINGERPRINT_ KEY - Fingerprint key used in SARIF partialFingerprints and other CI formats.
- SECURITY_
DOCS - Docs URL for the security command.
- SNAPSHOT_
SCHEMA_ VERSION - Current snapshot schema version. Independent of the report’s SCHEMA_VERSION.
v2: Added
scoreandgradefields. v3: Addedcoverage_modelfield. v4: Added risk profiles (unit_size_profile,unit_interfacing_profile) and coupling concentration (p95_fan_in,coupling_high_pct). v5: Added duplication penalty to health score formula. v6: Addedtotal_locto vital signs (always computed from parsed modules). v7: MI formula dampening for small files (values change for files < 50 lines). v8: Added scale-invariant tail/density metrics for health score calibration. v9: Added render fan-in concentration (p95_render_fan_in,render_fan_in_high_pct,max_render_fan_in), the component-graph analogue of module fan-in / coupling concentration. Additive optional fields (matches the v4 precedent that added coupling concentration). - STYLING_
HEALTH_ FORMULA_ VERSION - Formula version for the styling-health score (the CSS / design-system axis).
Bumped independently of
HEALTH_SCORE_FORMULA_VERSIONwhenever the styling penalty rubric is recalibrated, so consumers can distinguish a score shift caused by a weight change from one caused by an actual codebase change. v2 recalibrateddead_surface(size-stable declaration-share denominator) andtoken_erosion(gently saturating arbitrary-value term) from real-project evidence. v3 re-weighted the duplication family toward value DRIFT: it down-weighted the exact-blockduplicationscale (exact CSS duplication is the least-harmful pattern) and added a hardcoded-value-sprawl drift sub-term totoken_erosion(distinct un-tokenizedbox-shadow/border-radius/line-heightvalues). Seeengine::health::styling_scorefor the full rubric + calibration. - TOKEN_
CONSUMER_ SAMPLE_ CAP - Maximum number of consumer locations sampled into
TokenConsumers::consumers. The full count is preserved inTokenConsumers::consumer_count(aggregate-before-truncate), so capping the sample never distorts the count.
Statics§
- CODECLIMATE_
RESULT_ CODES - Result issue codes emitted by the dead-code CodeClimate formatter.
Functions§
- agent_
schema - The default agent schema descriptor.
- annotate_
codeclimate_ issues - Add a top-level grouped property to each typed CodeClimate issue.
- apply_
config_ fixable_ to_ duplicate_ exports - apply_
root_ kind - Apply a document-root discriminator.
- attach_
telemetry_ meta - Attach telemetry metadata to a JSON root object when a run id is available.
- build_
audit_ next_ steps - Next-steps for
fallow audit. - build_
audit_ next_ steps_ input - Build audit next-step inputs from typed analysis payloads plus the caller-supplied runtime suggestions gate.
- build_
check_ output - Build the typed dead-code JSON envelope from engine results.
- build_
check_ summary - Compute the per-category
CheckSummaryfrom analysis results. - build_
codeclimate_ issue - Build a single CodeClimate issue from a stable contract descriptor.
- build_
combined_ next_ steps - Aggregated next-steps for bare
fallowcombined output. - build_
coverage_ analyze_ output - Build the
fallow coverage analyze --format jsonenvelope. - build_
dead_ code_ next_ steps - Next-steps for standalone
fallow dead-code. - build_
decision_ surface_ output - Project a
DecisionSurfaceinto the separable, action-bearing envelope. - build_
dupes_ next_ steps - Next-steps for standalone
fallow dupes. - build_
dupes_ output - Build a duplication JSON envelope from caller-owned report data.
- build_
feature_ flags_ output - Build the typed feature flags output envelope.
- build_
fix_ json_ output - Build the typed fix JSON root.
- build_
health_ finding_ actions - Compute the typed
actionslist for a complexity finding. - build_
health_ next_ steps - Next-steps for standalone
fallow health. - build_
health_ next_ steps_ input - Build standalone health next-step inputs from a typed health report plus caller-supplied runtime probes.
- build_
health_ output - Build a health JSON envelope from caller-owned report data.
- build_
review_ brief_ json_ output - Build the complete
fallow audit --brief --format jsonvalue. - build_
sarif_ document - Build a SARIF 2.1.0 document envelope.
- build_
sarif_ result - Build a single SARIF result object.
- build_
sarif_ rule - Build a SARIF rule object.
- build_
security_ summary - Build the compact aggregate payload for
fallow security --summary --format json. - cap_
body_ with_ marker - cap_
names - Cap an arbitrary list of names for inline display: first
maxnames, then a “+N more” sentinel. Shared by the out-of-diff consumer fact in both surfaces. - check_
meta - Build the
_metaobject forfallow dead-code --format json --explain. - clean_
decision_ fact - The clean, surface-agnostic fact text for a decision question, for the tour.
- clone_
family_ actions - Build the stable action list for a clone family.
- clone_
group_ actions - Build the stable action list for one clone group.
- codeclimate_
fingerprint_ hash - Compute a deterministic fingerprint hash from key fields.
- codeclimate_
issues_ to_ value - Serialize typed CodeClimate issues to the wire-shape JSON array.
- command_
title - composite_
fingerprint - compute_
finding_ severity - Compute the severity tier for a complexity finding.
- count_
applied_ fixes - Count fix entries whose
appliedflag is true. - count_
reported_ fix_ skips - Count user-facing skipped entries, excluding plan-level skip diagnostics.
- coverage_
analyze_ meta - Build the
_metaobject forfallow coverage analyze --format json --explain. - coverage_
setup_ meta - Build the
_metaobject forfallow coverage setup --json --explain. - dead_
code_ docs_ url - decision_
actions - Attach structured actions to one decision.
- default_
marker_ regex - Default for
ReviewEnvelopeOutput::marker_regex. - default_
marker_ regex_ flags - Default for
ReviewEnvelopeOutput::marker_regex_flags. - dupes_
meta - Build the
_metaobject forfallow dupes --format json --explain. - escape_
md - Escape a string for inclusion in a Markdown table cell.
- feature_
flags_ meta - Metadata emitted when
fallow flags --explain --format jsonis requested. - github_
check_ conclusion - group_
review_ issues_ by_ path_ line - Group consecutive same-(path, line) issues. Input is already sorted by
(path, line, fingerprint)so a single linear pass collects runs. - harmonize_
dead_ code_ health_ suppress_ line_ actions - Merge same-line suppress actions across dead-code and health sections.
- harmonize_
multi_ kind_ suppress_ line_ actions - Merge same-line suppress actions so multi-kind findings share one comment.
- health_
meta - Build the
_metaobject forfallow health --format json --explain. - impact_
digest_ summary - Render the human-readable impact counter summary shared by JSON and human output surfaces.
- is_
false - Helper for
skip_serializing_if = "is_false"ontruncatedfields. - is_
project_ level_ rule - issue_
output_ contract_ by_ code - Output-facing dead-code result contract by issue code.
- issue_
output_ contracts - Output-facing dead-code result contracts in stable registry order.
- issues_
from_ codeclimate - issues_
from_ codeclimate_ issues - letter_
grade - Map a numeric score (0-100) to a letter grade.
- normalize_
sarif_ snippet - Normalize a source snippet before it contributes to stable SARIF identity.
- normalize_
uri - Normalize a path string to a valid URI: forward slashes and percent-encoded brackets.
- parse_
new_ hunk_ start - plan_
pr_ comment_ post - pr_
status_ contexts - pr_
status_ contexts_ with_ mode - relative_
to_ diff_ path - render_
pr_ comment - render_
pr_ summary - render_
review_ comment_ for_ group - Render one comment from a group of issues sharing the same
(path, line). - render_
review_ envelope - Render a provider-specific review envelope from typed CI issues.
- review_
label_ from_ codeclimate - rule_
docs_ url - sarif_
finding_ fingerprint - Stable SARIF fingerprint for a finding with source snippet evidence.
- security_
meta - Build the
_metaobject forfallow security --format json --explain. - serialize_
audit_ json_ output - Serialize a typed
fallow audit --format jsonenvelope with the standard root discriminator policy. - serialize_
check_ grouped_ json_ output - Serialize
fallow dead-code --group-by ... --format json. - serialize_
check_ json_ output - Serialize
fallow dead-code --format json. - serialize_
combined_ json_ output - Serialize a typed bare
fallow --format jsoncombined envelope with the standard root discriminator policy. - serialize_
coverage_ analyze_ json_ output - Serialize the
fallow coverage analyze --format jsonenvelope. - serialize_
coverage_ setup_ json_ output - Serialize the
fallow coverage setup --jsonenvelope. - serialize_
cross_ repo_ impact_ json_ output - Serialize the
fallow impact --all --format jsonenvelope. - serialize_
decision_ surface_ json_ output - Serialize the standalone decision-surface envelope.
- serialize_
dupes_ json_ output - Serialize
fallow dupes --format json. - serialize_
explain_ json_ output - Serialize the
fallow explain --format jsonenvelope. - serialize_
feature_ flags_ json_ output - Serialize
fallow flags --format json. - serialize_
fix_ json_ output - Serialize the typed fix JSON root.
- serialize_
health_ json_ output - Build and serialize a health root JSON envelope.
- serialize_
impact_ json_ output - Serialize the
fallow impact --format jsonenvelope. - serialize_
inspect_ json_ output - Serialize the
fallow inspect --format jsonenvelope. - serialize_
json_ root_ output - Serialize a typed fallow root envelope with the requested discriminator mode.
- serialize_
list_ boundaries_ json_ output - Serialize
fallow list --boundaries --format json. - serialize_
list_ workspaces_ json_ output - Serialize
fallow list --workspaces --format json. - serialize_
named_ json_ output - Serialize an output envelope and apply an explicit root discriminator.
- serialize_
review_ brief_ json_ output - Serialize the
fallow audit --brief --format jsonenvelope. - serialize_
review_ envelope_ json_ output - Serialize the review envelope contract emitted by CI review formats.
- serialize_
review_ reconcile_ json_ output - Serialize the review reconcile contract.
- serialize_
security_ blind_ spots_ json_ output - Serialize the
fallow security blind-spots --format jsonenvelope. - serialize_
security_ json_ output - Serialize the full
fallow security --format jsonenvelope. - serialize_
security_ summary_ json_ output - Serialize the compact
fallow security --summary --format jsonenvelope. - serialize_
security_ survivors_ json_ output - Serialize the
fallow security survivors --format jsonenvelope. - serialize_
trace_ json_ output - Serialize the
fallow trace --format jsonenvelope. - serialize_
walkthrough_ guide_ json_ output - Serialize the review walkthrough guide envelope.
- serialize_
walkthrough_ validation_ json_ output - Serialize the review walkthrough validation envelope.
- strip_
root_ prefix - Recursively strip a project-root prefix from all string values in a JSON tree.
- summarize_
coverage_ source_ consistency - Summarise the coverage-source provenance attached to CRAP findings.
- summary_
fingerprint - summary_
label - suppress_
comment - Build the suppression comment a decision’s
suppressaction pastes in. - trace_
unused_ export_ input - Select the deterministic unused-export target used by read-only trace next-step commands.
- visible_
stage_ units - The visible stage members for a guide: direction units in order, MINUS any file collapsed into Cleared (de-prioritized or viewed). Returned as references into the guide so the caller can render rows without cloning.
Type Aliases§
- Standard
Review Brief Output - The standard audit brief payload shape used by the CLI, schema emitter, API, and agent-facing review surfaces.
- Standard
Walkthrough Guide - The standard walkthrough guide shape emitted by
fallow review.