Expand description
Versioned JSON output (FR-007).
Schema mirrors specs/062-cli-check-mode/plan.md §4 exactly. schema_version lets
downstream tooling detect a future breaking change to this shape (constitution
principle 8) — bump it, and document the bump in CHANGELOG.md as Breaking, whenever
a field is renamed, removed, or its wire type/nullability changes (e.g. a sentinel value
like "" becoming null); adding a new optional field is not itself a bump.
Structs§
- Ecosystem
Token - Wire-token wrapper for
EcosystemIdin JSON DTOs. - Finding
Document - One finding’s JSON shape.
- Position
Document - LSP
Position’s JSON shape ({"line": ..., "character": ...}), both zero-based. - Range
Document - LSP
Range’s JSON shape ({"start": {...}, "end": {...}}). - Report
Document - Top-level JSON document shape.
- Update
Item Document - One
updateplan item’s JSON shape. - Update
Report Document - Top-level JSON document shape for an
updaterun (FR-021).
Enums§
- Cooldown
Fallback Document crate::update::CooldownFallbackNote’s JSON shape (spec 075 FR-013).- Outcome
Token - Wire token for
crate::update::Outcomein JSON DTOs. - Severity
Token - Wire token for
deps_core::diagnostic::Severityin JSON DTOs.
Constants§
- SCHEMA_
VERSION - The current
schema_versionthis module emits andReportDocumentcan deserialize. - UPDATE_
SCHEMA_ VERSION - The current
schema_versionupdate_to_documentemits.
Functions§
- render
- Renders
reportas a pretty-printed JSON string. - render_
update - Renders
planas a pretty-printed JSON string. - to_
document - Builds the versioned
ReportDocumentforreport. - update_
to_ document - Builds the versioned
UpdateReportDocumentforplan.