Module output_envelope 

Typed envelope structs for the JSON output contract. Live here rather than in fallow-types because the body fields reach into fallow-core and into this crate’s own health_types. Typed envelope structs for the JSON output contract.

This module is the schema-side source of truth for fallow’s top-level JSON envelopes.

Structs

AuditOutput

fallow audit --format json envelope.

BoundariesListLogicalGroup

A pre-expansion autoDiscover logical group surfaced for observability (issue #373). Captured during expand_auto_discover so consumers can see the user-authored parent name and grouping intent after expansion would otherwise flatten it out of BoundariesListing::zones.

BoundariesListRule

A boundary import rule, expanded to operate on concrete child zone names after autoDiscover flattening. The user’s pre-expansion rule (keyed on the logical parent name, if any) is preserved on the corresponding BoundariesListLogicalGroup::authored_rule.

BoundariesListZone

A boundary zone after preset and autoDiscover expansion. Each entry classifies files into a single zone via glob patterns.

BoundariesListing

boundaries block carried by ListBoundariesOutput.

CheckGroupedEntry

Single resolver bucket inside CheckGroupedOutput. Carries the group’s identifier, optional section owners, and a per-group flattened AnalysisResults.

CheckGroupedOutput

Envelope emitted by fallow dead-code --group-by ... --format json.

CheckOutput

Envelope emitted by fallow dead-code --format json (plus the check block inside the combined and audit envelopes).

CodeClimateIssue

Single CodeClimate-compatible issue inside CodeClimateOutput.

CodeClimateLines

lines.begin for CodeClimateLocation.

CodeClimateLocation

Location block inside CodeClimateIssue::location.

CodeClimateOutput

Envelope emitted by fallow --format codeclimate and fallow --format gitlab-codequality. GitLab Code Quality consumes the same shape. The wire form is a bare JSON array, not an object.

CombinedMeta

CombinedOutput

Bare fallow --format json envelope.

CoverageAnalyzeOutput

CoverageSetupFileToEdit

CoverageSetupMember

CoverageSetupOutput

fallow coverage setup --json envelope.

CoverageSetupSnippet

DupesOutput

ExplainOutput

Envelope emitted by fallow explain <issue-type> --format json.

GitHubReviewComment

GitHub pull-request review comment.

GitLabReviewComment

GitLab merge-request discussion comment.

GitLabReviewPosition

position block inside GitLabReviewComment. Mirrors the GitLab merge-request discussion-position API.

HealthOutput

Envelope emitted by fallow health --format json (plus the health block inside the combined and audit envelopes).

ListBoundariesOutput

Envelope emitted by fallow list --boundaries --format json. Surfaces the architecture boundary zones, rules, and (issue #373) the user’s pre-expansion autoDiscover logical groups so consumers can render grouping intent that expand_auto_discover would otherwise flatten out of zones[].

ReviewEnvelopeMeta

meta block inside ReviewEnvelopeOutput.

ReviewEnvelopeOutput

Envelope emitted by fallow --format review-github / review-gitlab.

ReviewEnvelopeSummary

Summary block on ReviewEnvelopeOutput.

ReviewReconcileOutput

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.

Enums

AuditCommand

CodeClimateIssueKind

Discriminator value for CodeClimateIssue::kind.

CodeClimateSeverity

CodeClimate severity scale.

CoverageAnalyzeSchemaVersion

CoverageSetupFramework

CoverageSetupPackageManager

CoverageSetupRuntimeTarget

CoverageSetupSchemaVersion

EnvelopeMode

FallowOutput

Typed root of every fallow JSON envelope shape that serializes as a JSON object and participates in the documented FallowOutput contract. The schema derived from this enum drives the document-root oneOf in docs/output-schema.json.

GitHubReviewSide

Singleton side discriminator for GitHubReviewComment::side.

GitLabReviewPositionType

Singleton position-type discriminator for GitLabReviewPosition.

GroupByMode

Resolver mode label for grouped envelopes (dead-code, dupes, health).

ReviewCheckConclusion

meta.check_conclusion for the GitHub review envelope. Maps to the GitHub Checks API conclusion field.

ReviewComment

Per-line review comment. Schema is an anyOf between 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 in crates/cli/src/report/ci/review.rs::render_review_envelope.

ReviewEnvelopeEvent

Singleton GitHub review-event marker.

ReviewEnvelopeSchema

Schema-version discriminator for the review envelope.

ReviewProvider

Review-envelope provider tag.

ReviewReconcileSchema

Schema-version discriminator for the review reconcile envelope.

Constants

MARKER_REGEX_FLAGS_V2

Canonical v2 marker-regex flags.

MARKER_REGEX_V2

Canonical v2 marker-regex literal.

Functions

apply_root_kind

default_marker_regex

Default for ReviewEnvelopeOutput::marker_regex.

default_marker_regex_flags

Default for ReviewEnvelopeOutput::marker_regex_flags.

is_false

Helper for skip_serializing_if = "is_false" on truncated fields above. Serde calls skip_serializing_if with &T, so the reference signature is dictated by the trait and cannot be changed to pass-by-value. Uses #[allow] rather than #[expect] per .claude/rules/code-quality.md: trivially_copy_pass_by_ref is a pedantic lint that fires inconsistently across build configurations (lib vs bin), which would trigger unfulfilled_lint_expectations under #[expect].

remove_root_kind

Remove only the document-root discriminator for the one-cycle compatibility mode. Nested objects may carry their own meaningful kind fields, so this intentionally does not recurse.

serialize_root_output

serialize_root_output_with_mode

set_legacy_envelope