1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
/// Output renderer selection for `ripr` reports.
///
/// Most automation should prefer [`OutputFormat::Json`] for stable
/// machine-readable data. Badge and repo-inventory formats exist for specific
/// downstream integrations and may require additional artifacts.
#[derive(Clone, Copy, Debug, PartialEq, Eq)]
pub enum OutputFormat {
/// Human-readable plain text report.
Human,
/// Versioned JSON report for automation.
Json,
/// GitHub annotation output suitable for CI logs.
Github,
/// SARIF 2.1.0 report for diff-scoped static exposure Findings.
Sarif,
/// Native `ripr` badge JSON (snake_case wire shape with full counts,
/// reason counts, and policy). Consumed by tools and CI artifacts.
BadgeJson,
/// Shields-compatible projection for the `ripr` badge: exactly four
/// top-level fields (`schemaVersion`, `label`, `message`, `color`).
BadgeShields,
/// Native `ripr+` badge JSON. Sums unsuppressed exposure gaps and
/// unsuppressed actionable test-efficiency findings, excluding
/// declared intent. Requires `target/ripr/reports/test-efficiency.json`
/// produced by `cargo xtask test-efficiency-report`.
BadgePlusJson,
/// Shields-compatible projection for the `ripr+` badge.
BadgePlusShields,
/// Repo-scoped native `ripr` badge JSON. Renders seam-native repo
/// counts rather than diff-scoped `Finding` counts. Carries
/// `scope: "repo"` and `basis: "seam_native"` so README/store
/// endpoints can distinguish public repo signal from PR/diff artifacts.
RepoBadgeJson,
/// Repo-scoped Shields projection for the `ripr` badge. Same four
/// fields as the diff-scoped Shields shape; native-only fields like
/// `scope` and `basis` do not leak into Shields.
RepoBadgeShields,
/// Repo-scoped native `ripr+` badge JSON. Same disk requirement as
/// `BadgePlusJson` (the test-efficiency report) - `cargo xtask
/// test-efficiency-report` already scans the full test suite, so
/// the report is already repo-scoped.
RepoBadgePlusJson,
/// Repo-scoped Shields projection for the `ripr+` badge.
RepoBadgePlusShields,
/// Repo seam inventory rendered as JSON. Walks production Rust
/// files and emits `RepoSeam` records per RIPR-SPEC-0005. Schema
/// version is documented in `docs/OUTPUT_SCHEMA.md` under
/// `repo-seams.json`. Independent of the diff-scoped `Findings`
/// pipeline.
RepoSeamsJson,
/// Repo seam inventory rendered as Markdown for human review.
RepoSeamsMd,
/// Classified seam inventory rendered as a repo exposure JSON
/// report. Adds per-seam grip class and per-class metrics on top
/// of the seam inventory. Schema in `docs/OUTPUT_SCHEMA.md` under
/// `repo-exposure.json`.
RepoExposureJson,
/// Repo exposure report rendered as Markdown for human review.
RepoExposureMd,
/// SARIF 2.1.0 report for repo-scoped classified seam evidence.
RepoSarif,
/// Agent-ready seam packets per RIPR-SPEC-0005 - one
/// `write_targeted_test` packet per headline-eligible classified
/// seam, plus conservative `inspect_static_limitation` packets for
/// opaque seams. Schema 0.3 in `docs/OUTPUT_SCHEMA.md` section "Agent
/// Seam Packets". Strongly-gripped, intentional, and suppressed
/// seams emit no packet.
AgentSeamPacketsJson,
}
#[derive(Clone, Copy, Debug, PartialEq, Eq)]
struct OutputFormatSpec {
format: OutputFormat,
cli_names: &'static [&'static str],
is_repo_seam_inventory: bool,
}
const FORMAT_SPECS: &[OutputFormatSpec] = &[
OutputFormatSpec {
format: OutputFormat::Human,
cli_names: &["human", "text"],
is_repo_seam_inventory: false,
},
OutputFormatSpec {
format: OutputFormat::Json,
cli_names: &["json"],
is_repo_seam_inventory: false,
},
OutputFormatSpec {
format: OutputFormat::Github,
cli_names: &["github"],
is_repo_seam_inventory: false,
},
OutputFormatSpec {
format: OutputFormat::Sarif,
cli_names: &["sarif"],
is_repo_seam_inventory: false,
},
OutputFormatSpec {
format: OutputFormat::BadgeJson,
cli_names: &["badge-json"],
is_repo_seam_inventory: false,
},
OutputFormatSpec {
format: OutputFormat::BadgeShields,
cli_names: &["badge-shields"],
is_repo_seam_inventory: false,
},
OutputFormatSpec {
format: OutputFormat::BadgePlusJson,
cli_names: &["badge-plus-json"],
is_repo_seam_inventory: false,
},
OutputFormatSpec {
format: OutputFormat::BadgePlusShields,
cli_names: &["badge-plus-shields"],
is_repo_seam_inventory: false,
},
OutputFormatSpec {
format: OutputFormat::RepoBadgeJson,
cli_names: &["repo-badge-json"],
is_repo_seam_inventory: true,
},
OutputFormatSpec {
format: OutputFormat::RepoBadgeShields,
cli_names: &["repo-badge-shields"],
is_repo_seam_inventory: true,
},
OutputFormatSpec {
format: OutputFormat::RepoBadgePlusJson,
cli_names: &["repo-badge-plus-json"],
is_repo_seam_inventory: true,
},
OutputFormatSpec {
format: OutputFormat::RepoBadgePlusShields,
cli_names: &["repo-badge-plus-shields"],
is_repo_seam_inventory: true,
},
OutputFormatSpec {
format: OutputFormat::RepoSeamsJson,
cli_names: &["repo-seams-json"],
is_repo_seam_inventory: true,
},
OutputFormatSpec {
format: OutputFormat::RepoSeamsMd,
cli_names: &["repo-seams-md"],
is_repo_seam_inventory: true,
},
OutputFormatSpec {
format: OutputFormat::RepoExposureJson,
cli_names: &["repo-exposure-json"],
is_repo_seam_inventory: true,
},
OutputFormatSpec {
format: OutputFormat::RepoExposureMd,
cli_names: &["repo-exposure-md"],
is_repo_seam_inventory: true,
},
OutputFormatSpec {
format: OutputFormat::RepoSarif,
cli_names: &["repo-sarif"],
is_repo_seam_inventory: true,
},
OutputFormatSpec {
format: OutputFormat::AgentSeamPacketsJson,
cli_names: &["agent-seam-packets-json"],
is_repo_seam_inventory: true,
},
];
impl OutputFormat {
/// Parses a CLI output format name or alias.
pub(crate) fn parse_cli_name(value: &str) -> Option<Self> {
FORMAT_SPECS
.iter()
.find_map(|spec| spec.cli_names.contains(&value).then_some(spec.format))
}
/// Returns `true` when the format targets full-repo scope rather than
/// diff scope.
///
/// Repo-scope formats use full-repo inputs. Native repo badge JSON carries
/// `scope: "repo"` and seam-native badge formats carry
/// `basis: "seam_native"`. The Shields projection stays four-field for
/// both scopes.
pub fn is_repo_scope(&self) -> bool {
self.is_repo_seam_inventory()
}
/// Returns `true` when the format renders repo seam-driven artifacts
/// that do not consume legacy repo `Finding` output.
///
/// These formats short-circuit legacy repo Finding analysis because they
/// either walk/classify repo seams directly or render badge summaries from
/// classified seams. Running legacy repo Finding analysis first would add
/// cost and then be discarded.
pub fn is_repo_seam_inventory(&self) -> bool {
FORMAT_SPECS
.iter()
.find(|spec| spec.format == *self)
.is_some_and(|spec| spec.is_repo_seam_inventory)
}
}
#[cfg(test)]
mod tests {
use super::{FORMAT_SPECS, OutputFormat};
#[test]
fn output_format_is_repo_scope_only_for_repo_variants() {
for spec in FORMAT_SPECS {
assert_eq!(
spec.format.is_repo_scope(),
spec.is_repo_seam_inventory,
"repo scope should match metadata for {:?}",
spec.format
);
}
}
#[test]
fn repo_artifact_formats_use_repo_seam_short_circuit() {
for spec in FORMAT_SPECS {
assert_eq!(
spec.format.is_repo_seam_inventory(),
spec.is_repo_seam_inventory,
"repo seam short-circuit should match metadata for {:?}",
spec.format
);
}
}
#[test]
fn output_format_parse_cli_name_uses_declared_names() {
for spec in FORMAT_SPECS {
for cli_name in spec.cli_names {
assert_eq!(
OutputFormat::parse_cli_name(cli_name),
Some(spec.format),
"CLI name {:?} should parse to {:?}",
cli_name,
spec.format
);
}
}
assert_eq!(OutputFormat::parse_cli_name("xml"), None);
}
}