amont_runtime/manifest.rs
1//! `amont.conf` — checks a repository declares for itself.
2//!
3//! A third party cannot add a Rust module without rebuilding this binary, so
4//! extension means declared commands.
5//!
6//! The manifest is **committed at the repository root**, and that is the point.
7//! `.git/hooks` is not committed, so under the old filename-prefix mechanism a
8//! team could never actually share a custom hook — every member had to install
9//! it by hand, and nothing told them when it changed. That flaw mattered more
10//! than the lexicographic ordering usually cited against prefixes.
11//!
12//! ```text
13//! # stage name scope severity command
14//! pre-commit lint-shell *.sh block scripts/lint-shell.sh
15//! pre-push smoke * warn make smoke
16//! ```
17//!
18//! Whitespace-delimited, in file order. TOML would be nicer to write and costs a
19//! dependency tree that would then run on every commit in ninety-six
20//! repositories; for four fields and a command, the twenty lines of parsing win.
21//! See `scripts/check-no-deps.sh` for why that trade is the default here.
22//!
23//! ## No shell
24//!
25//! The command is split on whitespace and executed directly. There is no shell,
26//! so no pipes, no redirection, no globbing and no quoting. Two reasons, and the
27//! second is the one that decided it: Windows has no `sh`, and every emulation
28//! of one this project has tried has been a source of bugs; and a manifest line
29//! that silently gained shell semantics would be a much larger thing to have
30//! introduced than it looks. A pipeline belongs in a script the line invokes.
31//!
32//! ## A line that cannot be understood is not skipped
33//!
34//! A malformed line means a check the repository asked for is not running, which
35//! is precisely the "looks verified, enforced nothing" failure `Outcome` exists
36//! to name. So a broken line still produces a check — one that runs to
37//! `Unavailable` and says why. It appears in the dispatcher's "could not run"
38//! roll-up like any other gap, rather than needing a mechanism of its own.
39
40use std::path::Path;
41use std::process::{Command, Stdio};
42
43use crate::check::{Check, Fix, Outcome, Scope, Severity, Stage};
44use crate::hooks::common::Restaged;
45use crate::registry::{Ctx, CHECKS, ENTRYPOINTS};
46
47pub const MANIFEST: &str = "amont.conf";
48
49/// Why a line could not be used.
50///
51/// A type rather than a `String`: the prose belongs in `Display`, and a caller
52/// that wants to ask "was this a duplicate?" should not have to grep for the
53/// word. The tests used to assert on substrings, which coupled them to wording
54/// and would have kept passing if the wording stayed while the meaning changed.
55#[derive(Debug, Clone, PartialEq, Eq)]
56pub enum ParseError {
57 MissingFields,
58 MissingName,
59 /// Names a check compiled into the binary.
60 NameTaken(String),
61 /// The name is a trigger, or carries one as a prefix.
62 ///
63 /// `pre-commit pre-commit-clippy …` would declare a check whose SHORT
64 /// name is another check's full id, so `hook.skip pre-commit-clippy` would
65 /// mean two things at once. The stage column supplies the trigger; writing
66 /// it again in the name is the one way to make an id ambiguous.
67 TriggerInName(String),
68 /// A second USABLE line claiming a name already claimed ON THE SAME
69 /// TRIGGER. The same name on both triggers is two checks, not a clash.
70 Duplicate(String),
71 BadStage(String),
72 BadScope(String),
73 BadSeverity(String),
74 /// A `tool` line with the wrong shape.
75 BadTool,
76 /// A `severity`/`skip`/`set` line with the wrong shape; carries the usage.
77 BadPolicyLine(&'static str),
78 /// A `set` line naming a key policy may not reach.
79 UnsettableKey(String),
80 /// A `pre-push` line asked to rewrite files.
81 ///
82 /// Refused HERE, beside `NameTaken` and `Duplicate`, rather than as a
83 /// runtime "contract violation" at push time: same fact, discovered
84 /// earlier, by more people, at the moment it is cheapest to fix. A pre-push
85 /// hook must not modify the worktree or index — the pushed commit would
86 /// then differ from the tree the developer is looking at.
87 FixOnPrePush,
88}
89
90impl std::fmt::Display for ParseError {
91 fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
92 match self {
93 ParseError::MissingFields => {
94 write!(f, "expected 5 fields: stage name scope severity command")
95 }
96 ParseError::MissingName => write!(f, "missing name"),
97 ParseError::NameTaken(n) => write!(f, "{n:?} already names a check"),
98 ParseError::TriggerInName(n) => write!(
99 f,
100 "{n:?} must not be a trigger or start with one — the stage column says which"
101 ),
102 ParseError::Duplicate(n) => write!(f, "{n:?} is declared twice on one trigger"),
103 ParseError::BadStage(t) => {
104 write!(f, "stage {t:?} must be `pre-commit` or `pre-push`")
105 }
106 ParseError::BadScope(t) => write!(
107 f,
108 "scope {t:?} must be `*`, `*.<ext>`, or a bare filename (no `/`), \
109 optionally followed by `+<file>` the repository must carry"
110 ),
111 ParseError::BadTool => write!(
112 f,
113 "a tool pin is exactly `tool <program> <version-substring>`"
114 ),
115 ParseError::BadPolicyLine(usage) => write!(f, "a policy line is `{usage}`"),
116 ParseError::UnsettableKey(k) => write!(
117 f,
118 "set {k:?} is not a policy-settable key — see docs/custom-checks.md"
119 ),
120 ParseError::FixOnPrePush => write!(
121 f,
122 "`fix` is only for pre-commit — a pre-push hook must not rewrite files"
123 ),
124 ParseError::BadSeverity(t) => {
125 write!(f, "severity {t:?} must be `block` or `warn`")
126 }
127 }
128 }
129}
130
131/// A line that parsed. Every field means something.
132///
133/// `program` and `args` rather than one `argv`: a runnable check must have a
134/// command, and splitting the head off makes that structural instead of a
135/// `split_first` guard that can only ever be dead code.
136#[derive(Debug, Clone, PartialEq, Eq)]
137pub struct Declared {
138 /// `Fix::Rewrite` when the command column began `fix `.
139 pub fix: Fix,
140 /// The command column carried the `files` marker.
141 pub files: bool,
142 pub name: String,
143 pub stage: Stage,
144 pub severity: Severity,
145 /// Extensions that gate it. Empty means any change — the `*` scope.
146 pub exts: Vec<String>,
147 /// Exact filenames that gate it — the scope column's bare tokens.
148 pub names: Vec<String>,
149 /// Files the REPOSITORY must carry for this check to apply at all — the
150 /// scope column's `+` half. Empty means always applicable, which is what
151 /// every declaration meant before `amont add` made a line something you
152 /// could acquire rather than write.
153 pub opt_in: Vec<String>,
154 pub program: String,
155 pub args: Vec<String>,
156}
157
158impl Declared {
159 /// `<trigger>-<name>`, the same shape a built-in has.
160 ///
161 /// This is what `hook.skip` and `amont.severity.<key>` resolve against,
162 /// so a declared check answers to its trigger and its short name exactly as
163 /// a compiled-in one does. Before it had an id, `hook.skip pre-commit`
164 /// silenced fifteen built-ins and left every declared check running.
165 pub fn id(&self) -> String {
166 format!("{}-{}", self.stage.as_str(), self.name)
167 }
168
169 /// The command as written, for display.
170 pub fn command(&self) -> String {
171 std::iter::once(self.program.as_str())
172 .chain(self.args.iter().map(String::as_str))
173 .collect::<Vec<_>>()
174 .join(" ")
175 }
176}
177
178/// One manifest line: usable, or not.
179///
180/// A SUM, not a struct with an `Option<why>` beside the fields. The struct
181/// form let a broken line carry a severity, a scope and an argv that meant
182/// nothing — and it produced a wrong diagnosis: because broken and usable
183/// entries shared one list, a valid line was rejected as "declared twice" for
184/// colliding with a line that could not run. Dedup now sees only `Usable`.
185///
186/// Separate from `External` because the fleet reads ninety-six manifests and may
187/// re-read them on every refresh, while `External` holds a `Scope` whose
188/// `&'static` slices are LEAKED.
189/// `tool <program> <version-substring>` — a version this repository expects
190/// of a tool its checks drive, so cross-machine skew is a printed fact
191/// instead of "the hook is flaky here". Verified once per hook run, warn-only.
192#[derive(Debug, Clone, PartialEq, Eq)]
193pub struct ToolPin {
194 pub program: String,
195 /// A substring `<program> --version`'s first line must contain — `0.6.`
196 /// pins a minor, `0.6.3` pins a patch. Substring, not semver: the point
197 /// is agreement between machines, not range arithmetic.
198 pub want: String,
199}
200
201/// A committed policy statement about a BUILT-IN (or declared) check — the
202/// team's decision, shipped with the repository, trust-gated like everything
203/// else the manifest says. See `policy`.
204#[derive(Debug, Clone, PartialEq, Eq)]
205pub enum PolicyLine {
206 /// `severity <check|short-name|trigger> warn|block`
207 Severity { target: String, severity: Severity },
208 /// `skip <check|short-name|trigger>`
209 Skip { target: String },
210 /// `set <key> <value>` — a committed default for an allowlisted
211 /// `amont.*` config key. `key` is the FULL git key (`amont.timeout`),
212 /// canonicalised from whatever case the file used, because git keys are
213 /// case-insensitive and a policy file stricter than git is a trap.
214 Set { key: String, value: String },
215}
216
217/// The keys `set` may reach, in canonical spelling. Deliberately absent:
218/// `fix` (a committed file must not change what already-trusted commands may
219/// DO to your working tree — a different consent than "I read these
220/// commands"), `trusted`, `conventions`, `recordBypasses`, `progress`,
221/// `knownIdentity`, and the `severity.*` family (its own line kind).
222pub const SETTABLE: &[&str] = &[
223 "largeFileWarn",
224 "largeFileBlock",
225 "commit.gitmoji",
226 "commit.subjectMax",
227 "commit.descriptionMax",
228 "commit.bodyWrap",
229 "autoRebase",
230 "timeout",
231 "testPushedTree",
232 "minVersion",
233 // A snapshot is not a workspace. `testPushedTree` is settable here, so a
234 // repository can say "run the gate on a checkout of the commit" — and
235 // before this it could not say how to make that checkout runnable, which
236 // for a pnpm or npm workspace means an install. The repository is what
237 // knows; requiring every clone to discover `git config
238 // amont.snapshotPrepare` by hand made the declarable half useless.
239 //
240 // Safe on the same terms as a declared check: policy is populated ONLY
241 // when the manifest is trusted, `PolicyLine::describe` puts the command
242 // in front of the person consenting, and any edit revokes that consent.
243 // A local `git config` still outranks it (see `policy`'s ladder), so a
244 // developer can override without touching the file.
245 "snapshotPrepare",
246];
247
248impl PolicyLine {
249 /// The one-line rendering the trust prompt shows — consent must see the
250 /// policy it is granting.
251 pub fn describe(&self) -> String {
252 match self {
253 PolicyLine::Severity { target, severity } => {
254 format!("severity {target} {}", severity.as_str())
255 }
256 PolicyLine::Skip { target } => format!("skip {target}"),
257 PolicyLine::Set { key, value } => format!("set {key} {value}"),
258 }
259 }
260}
261
262#[derive(Debug, Clone, PartialEq, Eq)]
263pub enum Line {
264 Usable(Declared),
265 /// A tool version pin — carries no check.
266 Tool(ToolPin),
267 /// A policy statement — carries no check either. The line number rides
268 /// along because a "names no check here" note must point somewhere.
269 Policy {
270 what: PolicyLine,
271 lineno: usize,
272 },
273 Broken {
274 /// The declared name, or `<file>:<lineno>` when the line has none — a
275 /// gap has to be nameable to be reportable.
276 name: String,
277 /// Broken lines land on pre-commit unless the stage token parsed: seen
278 /// on every commit beats seen on every push.
279 stage: Stage,
280 lineno: usize,
281 why: ParseError,
282 },
283}
284
285impl Line {
286 pub fn name(&self) -> &str {
287 match self {
288 Line::Usable(d) => &d.name,
289 Line::Tool(pin) => &pin.program,
290 Line::Policy {
291 what: PolicyLine::Severity { target, .. } | PolicyLine::Skip { target },
292 ..
293 } => target,
294 Line::Policy {
295 what: PolicyLine::Set { key, .. },
296 ..
297 } => key,
298 Line::Broken { name, .. } => name,
299 }
300 }
301
302 /// Does this line declare a CHECK? `Tool` and `Policy` lines do not, and
303 /// every consumer that projects lines into checks — `parse`, the trust
304 /// prompt, the fleet's declared column — must filter on this rather than
305 /// pattern-match variants it will forget to extend. A `Broken` line IS a
306 /// check (one that runs to Unavailable and says why).
307 pub fn is_check(&self) -> bool {
308 matches!(self, Line::Usable(_) | Line::Broken { .. })
309 }
310 pub fn stage(&self) -> Stage {
311 match self {
312 Line::Usable(d) => d.stage,
313 // A pin has no stage; it is verified at both. The value only
314 // feeds displays that will not ask a pin for one. Policy lines
315 // likewise — `is_check()` keeps both out of anything that would.
316 Line::Tool(_) | Line::Policy { .. } => Stage::PreCommit,
317 Line::Broken { stage, .. } => *stage,
318 }
319 }
320 /// `Some(reason)` when this line declares a check that cannot run.
321 pub fn broken(&self) -> Option<String> {
322 match self {
323 Line::Usable(_) | Line::Tool(_) | Line::Policy { .. } => None,
324 Line::Broken { lineno, why, .. } => Some(format!("line {lineno}: {why}")),
325 }
326 }
327
328 /// `<trigger>-<name>`, matching `Declared::id` and `External::id`. A broken
329 /// line has one too: `hook.skip pre-commit` should silence its nag exactly
330 /// as it silences the checks that do run.
331 pub fn id(&self) -> String {
332 format!("{}-{}", self.stage().as_str(), self.name())
333 }
334
335 /// Consume into the identity every line has, and either the declaration or
336 /// the reason there is none.
337 ///
338 /// Both consumers — `External::from` and the fleet's projection — used to
339 /// destructure this by hand, and both carried an arm for a combination the
340 /// type forbids, because they computed the reason BEFORE matching. Written
341 /// once, that arm has nowhere to appear.
342 pub fn into_parts(self) -> (String, Stage, Result<Declared, String>) {
343 let name = self.name().to_string();
344 let stage = self.stage();
345 let parsed = match self {
346 Line::Usable(d) => Ok(d),
347 // Reachable only through a consumer that skipped `is_check()` —
348 // kept total so the type stays honest, worded so a leak is
349 // recognisable in whatever display it lands in.
350 Line::Tool(pin) => Err(format!("tool pin: {} {}", pin.program, pin.want)),
351 Line::Policy { what, .. } => Err(format!("policy: {}", what.describe())),
352 Line::Broken { lineno, why, .. } => Err(format!("line {lineno}: {why}")),
353 };
354 (name, stage, parsed)
355 }
356}
357
358/// A check a repository declares, rather than one compiled in.
359pub struct External {
360 /// `<trigger>-<name>` — what `hook.skip` and `amont.severity.<key>`
361 /// resolve against, and what `Check::name` returns. Built-ins have had this
362 /// shape all along; declared checks answering to a bare name were invisible
363 /// to `hook.skip pre-commit`.
364 pub id: String,
365 /// The name as written in the manifest — the "short name" of the vocabulary
366 /// — used for messages. A line too malformed to name itself falls back to
367 /// its position, and reading `pre-commit-amont.conf:3` back to somebody
368 /// helps nobody.
369 pub short_name: String,
370 pub stage: Stage,
371 pub kind: Kind,
372}
373
374/// The two things an external can be. `Scope` and `Severity` live only on the
375/// runnable side, so a broken external cannot carry a severity nobody applies.
376pub enum Kind {
377 Runnable {
378 scope: Scope,
379 severity: Severity,
380 program: String,
381 args: Vec<String>,
382 fix: Fix,
383 /// The command column began `files ` — append the matched paths to
384 /// the argv, the way a builtin hands its tool the staged list.
385 files: bool,
386 },
387 Unusable {
388 why: String,
389 },
390}
391
392/// The scripts already vouched for against the staged tree, read once per
393/// hook process — a stage's externals run concurrently, and each asking git
394/// itself would be two spawns per check for one answer.
395fn vouched_for_staged_tree() -> &'static std::collections::HashSet<String> {
396 static VOUCHED: std::sync::OnceLock<std::collections::HashSet<String>> =
397 std::sync::OnceLock::new();
398 VOUCHED.get_or_init(crate::gate_stamp::vouched_for_staged_tree)
399}
400
401impl Check for External {
402 fn name(&self) -> &str {
403 &self.id
404 }
405 fn stage(&self) -> Stage {
406 self.stage
407 }
408 /// Derived for an unusable check rather than stored: it never runs, so its
409 /// scope is a question with no answer, and computing one here keeps the
410 /// DATA from carrying a value that means nothing.
411 fn scope(&self) -> Scope {
412 match &self.kind {
413 Kind::Runnable { scope, .. } => *scope,
414 Kind::Unusable { .. } => Scope::ALWAYS,
415 }
416 }
417 fn severity(&self) -> Severity {
418 match &self.kind {
419 Kind::Runnable { severity, .. } => *severity,
420 // Never consulted: an unusable check reports `Unavailable`, which
421 // no severity can turn into a block.
422 Kind::Unusable { .. } => Severity::Warn,
423 }
424 }
425
426 fn run(&self, ctx: &Ctx) -> Outcome {
427 let settings = ctx.settings;
428 let (scope, program, args, fix, files) = match &self.kind {
429 Kind::Runnable {
430 scope,
431 program,
432 args,
433 fix,
434 files,
435 ..
436 } => (scope, program, args, *fix, *files),
437 Kind::Unusable { why } => {
438 crate::hooks::common::warn(&format!(
439 "{MANIFEST}: {} — {}",
440 crate::ui::highlight(&self.short_name),
441 // Carries repo tokens: `BadStage("…")` quotes the manifest.
442 crate::ui::sanitize(why)
443 ));
444 return Outcome::Unavailable;
445 }
446 };
447
448 // The scope gate lives HERE, unlike a built-in's, which enforces its own
449 // in its first three lines. A declared command has no way to know what
450 // was staged, so if this did not gate it, `*.sh` would run on every
451 // commit and the column would be decoration.
452 //
453 // Which files to test against depends on the stage: what is staged for
454 // a commit, what is being pushed for a push. `*` short-circuits before
455 // either is computed, which is the common case.
456 // A check whose whole job is to rewrite has nothing to say when nobody
457 // asked for rewriting — so it does not RUN, rather than running and
458 // having its result discarded. Gating only the re-staging let the
459 // command edit files with `amont.fix` off, which is precisely the
460 // surprise the gate exists to prevent.
461 //
462 // `Unavailable`, not `Passed`. `check.rs` defines `Unavailable` as
463 // "COULD NOT RUN — a tool is missing, or the opt-in config is absent",
464 // which is exactly this; `Passed` is the one verdict it must not
465 // report, because the dispatcher's roll-up and the fleet dashboard
466 // then show a check that never executed as clean. With a message,
467 // because every other `Unavailable` in this codebase says what was
468 // missing and an unexplained count on every commit is worse than none.
469 if fix == Fix::Rewrite && !crate::hooks::common::fixing_enabled(settings) {
470 crate::hooks::common::warn(&format!(
471 "{}: declares fix, and {} is off — not run",
472 crate::ui::highlight(&self.short_name),
473 crate::ui::highlight("amont.fix")
474 ));
475 return Outcome::Unavailable;
476 }
477
478 // Two questions, two path lists. `touches` asks what the CHANGE
479 // contains; `opted_in` asks what the REPOSITORY carries, and answering
480 // the second from the change set made a `+marker` row fire only when
481 // the marker itself was staged — so a pack that followed our own
482 // advice to gate every row was a pack that never ran. `tracked_files`
483 // returning `None` means git would not say, and an unverified answer
484 // must not silently switch a check off: run it, and let the command
485 // judge.
486 let opted_in =
487 crate::hooks::common::tracked_files().map_or(true, |tracked| scope.opted_in(&tracked));
488 if !opted_in {
489 return Outcome::Passed;
490 }
491 let root = crate::hooks::common::repo_root();
492 match self.stage {
493 Stage::PreCommit => {
494 let staged = crate::hooks::common::staged_files(&[]);
495 let Some(matched) = files_to_judge(scope, files, &staged) else {
496 return Outcome::Passed;
497 };
498 // A blocking gate that already ran clean against exactly this
499 // staged tree is not run again: the attempt that ran it never
500 // reached post-commit (commit-msg refused the subject, the
501 // editor was closed on the message) or the same tree is
502 // being re-committed. Said out loud, in the push gate's
503 // words, and answered as `Passed` so pre-commit records the
504 // marker again and post-commit binds it as usual. What can
505 // and cannot be vouched for: `gate_stamp::vouched_for_staged_tree`.
506 if self.severity() == Severity::Block
507 && crate::gate_stamp::commit_stamps_enabled(settings)
508 && vouched_for_staged_tree().contains(&self.short_name)
509 {
510 crate::say!(
511 "{} {} passed on this exact tree earlier — not repeating it here",
512 crate::ui::valid_sign(),
513 crate::ui::highlight(&self.short_name),
514 );
515 return Outcome::Passed;
516 }
517 self.execute(
518 settings,
519 program,
520 args,
521 fix,
522 files,
523 &matched,
524 Path::new(&root),
525 )
526 }
527 // PER REF, and — when `amont.testPushedTree` asks for it — in a
528 // checkout of that ref's tip, exactly as the built-in suites do
529 // and for the same reason: a declared `test *.rs block cargo
530 // test` line used to run once, in the working tree, whatever the
531 // flag said. It passed on an uncommitted fix, and `stamp_tips`
532 // then read the flag and stamped it onto the tip as though it had
533 // run there, so the next push of that tip skipped it. The flag is
534 // a promise about what a push gate tests; a declared gate is a
535 // push gate.
536 Stage::PrePush => {
537 let zero = crate::git::stdout(&["hash-object", "--stdin"])
538 .map(|h| "0".repeat(h.len()))
539 .unwrap_or_else(|| "0".repeat(40));
540 for r in ctx.push.get() {
541 if r.local_oid == zero {
542 continue; // deleting a ref pushes no code
543 }
544 let changed = crate::pushrefs::changed_files_for(r, &zero);
545 let Some(matched) = files_to_judge(scope, files, &changed) else {
546 continue;
547 };
548 // `_guard` owns the checkout for the length of this ref's
549 // run; dropping it removes the worktree before the next
550 // ref's begins. `self.id`, because that is what a stamp
551 // names and what `stamp_tips` asks `ran_on_tip` about.
552 let (run_in, _guard) =
553 crate::pushed_tree::where_to_run(settings, &r.local_oid, &root, &self.id);
554 match self.execute(settings, program, args, fix, files, &matched, &run_in) {
555 Outcome::Passed => {}
556 other => return other,
557 }
558 }
559 Outcome::Passed
560 }
561 }
562 }
563}
564
565/// The paths a declared check is handed for `in_scope`, or `None` when it
566/// has nothing to judge and must not run.
567///
568/// No `is_unscoped()` guard: `touches` already answers true for an unscoped
569/// trigger, so the gate reduces to the opt-in the caller has already
570/// settled — which is what a row with nothing on the left (`+Gemfile`: "any
571/// change, in a repository that carries a Gemfile") means. Guarding on it
572/// here skipped the opt-in for exactly those rows.
573///
574/// The paths are what the declaration's scope actually matched — what a
575/// builtin would be handed. A files-taking command with no files has
576/// nothing to judge — running it bare would make most linters error on an
577/// empty argv, blocking a commit over nothing. The builtin convention,
578/// applied here.
579fn files_to_judge(scope: &Scope, files: bool, in_scope: &[String]) -> Option<Vec<String>> {
580 if !scope.touches(in_scope) {
581 return None;
582 }
583 let matched = scoped(scope, in_scope);
584 if files && matched.is_empty() {
585 return None;
586 }
587 Some(matched)
588}
589
590impl External {
591 /// Spawn the declared command over `matched`, in `run_in`, and judge it.
592 ///
593 /// `matched` reaches the command two ways: `$AMONT_FILES` always
594 /// (newline-separated, so a wrapper script never re-derives `git diff
595 /// --cached` and diverges from the set this gate judged — `amont run
596 /// --all-files` overrides the set in-process, invisibly to any child that
597 /// asks git itself), and appended to the argv when the declaration
598 /// carries the `files` marker.
599 #[allow(clippy::too_many_arguments)]
600 fn execute(
601 &self,
602 settings: &crate::config::Settings,
603 program: &str,
604 args: &[String],
605 fix: Fix,
606 files: bool,
607 matched: &[String],
608 run_in: &Path,
609 ) -> Outcome {
610 // Through `program()`, exactly like every builtin: on Windows,
611 // `Command::new("npx")` cannot start `npx.cmd`, and an external that
612 // fails to SPAWN reports Unavailable — warn, never block — so the
613 // check would silently never run. The guard test that enforces this
614 // for builtins scans only `src/hooks/`; this call is the manifest's
615 // half of the same rule.
616 let mut cmd = Command::new(crate::hooks::common::program(program));
617 cmd.args(args).current_dir(run_in).stdin(Stdio::null());
618 // Env, not only argv: newline-separated so ordinary shell loops can
619 // read it. A path with a newline in its name would split wrong — the
620 // list is repo-controlled and such a path is already hostile input —
621 // and a change set too large for an environment variable (rare, but
622 // E2BIG kills the spawn outright) travels as an empty variable
623 // instead, which a wrapper treats exactly like "derive it yourself".
624 let joined = matched.join("\n");
625 cmd.env(
626 "AMONT_FILES",
627 if joined.len() <= 100_000 {
628 joined.as_str()
629 } else {
630 ""
631 },
632 );
633 if files {
634 cmd.args(matched);
635 }
636 crate::hooks::common::strip_git_env(&mut cmd);
637 // Under the deadline: repo-authored code that outlives the budget is
638 // killed and FAILS — "hung" must not read as "passed", and pre-push
639 // runs these serially where one hang stalls the entire push.
640 let status = match crate::hooks::common::status_streamed(settings, &mut cmd) {
641 Ok(crate::hooks::common::Ran::Status(s)) => Ok(s),
642 Ok(crate::hooks::common::Ran::TimedOut(budget)) => {
643 crate::hooks::common::say_timed_out(&self.short_name, budget);
644 return Outcome::Failed;
645 }
646 Err(e) => Err(e),
647 };
648 match status {
649 // A command that could not be STARTED has not judged anything. This
650 // is the distinction `Outcome` was added for: reporting a missing
651 // `shellcheck` as a lint failure sends someone hunting for a lint
652 // error that does not exist.
653 Err(e) => {
654 crate::hooks::common::warn(&format!(
655 "{MANIFEST}: {} could not run {} — {}",
656 crate::ui::highlight(&self.short_name),
657 crate::ui::highlight(program),
658 // The io error's text embeds the program name it tried.
659 crate::ui::sanitize(&e.to_string())
660 ));
661 Outcome::Unavailable
662 }
663 Ok(s) if s.success() => {
664 // A declared fixer that ran clean may still have rewritten
665 // something; re-stage exactly what moved. Only its own scope,
666 // so it cannot stage a file it never looked at.
667 if fix == Fix::Rewrite && crate::hooks::common::fixing_enabled(settings) {
668 match crate::hooks::common::restage(matched) {
669 Restaged::Staged => {
670 crate::hooks::common::ok(
671 settings,
672 &format!(
673 "{} fixed and re-staged",
674 crate::ui::highlight(&self.short_name)
675 ),
676 );
677 return Outcome::Fixed;
678 }
679 // `git add` failed, so the index still holds whatever
680 // the command has already replaced on disk. This used
681 // to be indistinguishable from "nothing moved" and was
682 // reported as a pass.
683 Restaged::Failed(stuck) => {
684 crate::hooks::common::fail(&format!(
685 "{} rewrote files but {} failed — the index still holds the \
686 OLD content: {}",
687 crate::ui::highlight(&self.short_name),
688 crate::ui::highlight("git add"),
689 crate::ui::sanitize(&stuck.join(", "))
690 ));
691 return Outcome::Failed;
692 }
693 Restaged::Nothing => {}
694 }
695 }
696 Outcome::Passed
697 }
698 Ok(_) => {
699 crate::hooks::common::fail(&format!(
700 "{} failed (output above)",
701 crate::ui::highlight(&self.short_name)
702 ));
703 Outcome::Failed
704 }
705 }
706 }
707}
708
709/// The paths this check's scope actually covers.
710fn scoped(scope: &Scope, paths: &[String]) -> Vec<String> {
711 if scope.is_unscoped() {
712 return paths.to_vec();
713 }
714 paths.iter().filter(|p| scope.covers(p)).cloned().collect()
715}
716
717/// `Scope` holds `&'static` slices so a built-in can be a `const`. A parsed
718/// manifest has neither, so its extension list is leaked.
719///
720/// This is bounded and deliberate: the manifest is read at most once per
721/// process, holds a handful of short strings, and the process is a git hook that
722/// exits in milliseconds. The alternative — a lifetime on `Scope` — would
723/// propagate through the trait, both dispatchers and the fleet crate to buy back
724/// a few hundred bytes that the kernel reclaims moments later.
725fn leak(exts: Vec<String>) -> &'static [&'static str] {
726 let refs: Vec<&'static str> = exts
727 .into_iter()
728 .map(|s| &*Box::leak(s.into_boxed_str()))
729 .collect();
730 Box::leak(refs.into_boxed_slice())
731}
732
733/// `*` means any change; `*.sh` or `*.sh,*.bash` gate on extensions; and
734/// `<triggers>+<opt-ins>` adds the repository condition a builtin has.
735///
736/// # `+`, and why there is now an opt-in at all
737///
738/// This used to read: *"No `opt_in` counterpart, because the manifest IS the
739/// opt-in: a repository that does not want the check deletes the line."* That
740/// was true while every line was one somebody typed. `amont add` ended it — a
741/// vendored line is in your manifest because you took a whole PACK, not
742/// because you chose that tool, so a packaged `rubocop` fired on every `.rb`
743/// in a repository with no rubocop config and simply errored. That is the
744/// "ninety-five nags" `hooks::yamllint` documents avoiding, which is a
745/// courtesy every builtin has had and no declaration could express.
746///
747/// The separator is `+` because that is what `amont list` already PRINTS
748/// between the two halves — `inert here — needs .rs + Cargo.toml`. What you
749/// read in the listing is what you write in the file. No spaces: the column
750/// grammar splits on whitespace.
751///
752/// Both sides are comma-separated, and each side is an OR — any trigger, and
753/// any one opt-in. Between the sides it is an AND, matching `Scope`'s own
754/// semantics.
755///
756/// Splitting on the FIRST `+` means a filename containing one is not
757/// expressible. That is the same class of limit as directories being
758/// inexpressible, and it is stated in `docs/custom-checks.md` rather than
759/// worked around with quoting this grammar deliberately does not have.
760///
761/// Returns owned strings rather than a `Scope`, so validating a manifest
762/// costs nothing permanent. Only `External::from` turns these into the
763/// `&'static` form `Scope` requires.
764type ParsedScope = (Vec<String>, Vec<String>, Vec<String>);
765
766fn parse_scope(token: &str) -> Result<ParsedScope, ParseError> {
767 let (triggers, opt_in) = match token.split_once('+') {
768 None => (token, Vec::new()),
769 Some((left, right)) => {
770 // `*.rb+` promises a condition and states none. Refused rather
771 // than read as "no condition", which is the opposite of what the
772 // author was reaching for.
773 let opts: Vec<String> = right
774 .split(',')
775 .filter(|p| !p.is_empty())
776 .map(str::to_string)
777 .collect();
778 if opts.is_empty() || right.contains('+') {
779 return Err(ParseError::BadScope(token.to_string()));
780 }
781 for o in &opts {
782 if o.contains(['*', '?', '[', '/']) {
783 return Err(ParseError::BadScope(o.clone()));
784 }
785 }
786 // `+cfg` with nothing on the left is "any change, if this repo has
787 // cfg" — a real shape, and `*` is how the trigger half spells
788 // "anything".
789 (if left.is_empty() { "*" } else { left }, opts)
790 }
791 };
792 if triggers == "*" {
793 return Ok((Vec::new(), Vec::new(), opt_in));
794 }
795 let mut exts = Vec::new();
796 let mut names = Vec::new();
797 for part in triggers.split(',') {
798 if let Some(ext) = part.strip_prefix('*').filter(|ext| ext.starts_with('.')) {
799 exts.push(ext.to_string());
800 continue;
801 }
802 // A bare token is an exact FILENAME — `package.json`, `Dockerfile`,
803 // `.prettierrc` — matched against the basename. Directories are not
804 // expressible (a `/` is refused), and anything that LOOKS like a glob
805 // (`*`, `?`, `[`) is refused as the typo it almost certainly is —
806 // this grammar deliberately has no globs to mis-guess.
807 if !part.is_empty() && !part.contains(['*', '?', '[', '/']) {
808 names.push(part.to_string());
809 continue;
810 }
811 return Err(ParseError::BadScope(part.to_string()));
812 }
813 Ok((exts, names, opt_in))
814}
815
816fn parse_stage(token: &str) -> Option<Stage> {
817 match token {
818 "pre-commit" => Some(Stage::PreCommit),
819 "pre-push" => Some(Stage::PrePush),
820 _ => None,
821 }
822}
823
824/// An identity already spoken for. An external must not be able to shadow
825/// `pre-push-branch-protect` — nor silently lose to it, which is what a
826/// first-match lookup would do without this.
827///
828/// Judged on the ID, which is why `clippy` on `pre-push` is now legal: it is
829/// `pre-push-clippy`, a different check from `pre-commit-clippy`. Judged on the
830/// bare name, as it was, the two collided and the second was refused.
831///
832fn name_is_taken(id: &str) -> bool {
833 CHECKS.iter().any(|c| c.name == id) || ENTRYPOINTS.iter().any(|(n, _)| *n == id)
834}
835
836/// A short name that says its own trigger — either by being one, or by starting
837/// with one.
838///
839/// Both make an id ambiguous rather than merely ugly. `pre-commit` as a name
840/// gives `hook.skip pre-commit` two readings; `pre-commit-clippy` as a name
841/// gives a check whose SHORT name is the built-in's FULL id, so one skip
842/// silences both. The stage column already says which trigger this is.
843fn name_says_its_trigger(name: &str) -> bool {
844 crate::TRIGGERS
845 .iter()
846 .any(|t| name == *t || name.starts_with(&format!("{t}-")))
847}
848
849/// The four leading tokens and the untouched remainder, or `None` when the line
850/// does not have them.
851///
852/// The arity is in the TYPE. Returning a `Vec` made "four or it is malformed"
853/// a rule every caller had to remember and none could be checked against.
854///
855/// NOT `splitn(5, char::is_whitespace)`: that splits at the FIRST whitespace
856/// character every time, so a file aligned into columns — which is how the
857/// format invites you to write it — yields empty fields for every run of
858/// spaces after the first.
859fn tokenise(line: &str) -> Option<([&str; 4], &str)> {
860 let mut fields: [&str; 4] = [""; 4];
861 let mut rest = line;
862 for slot in fields.iter_mut() {
863 rest = rest.trim_start();
864 let i = rest.find(char::is_whitespace)?;
865 *slot = &rest[..i];
866 rest = &rest[i..];
867 }
868 let command = rest.trim();
869 (!command.is_empty()).then_some((fields, command))
870}
871
872pub fn parse_lines(text: &str) -> Vec<Line> {
873 let mut out: Vec<Line> = Vec::new();
874 for (i, raw) in text.lines().enumerate() {
875 let line = raw.trim();
876 if line.is_empty() || line.starts_with('#') {
877 continue;
878 }
879 let lineno = i + 1;
880 out.push(parse_line(lineno, line, &out));
881 }
882 out
883}
884
885/// One line, given the lines already accepted.
886///
887/// `earlier` is read ONLY for the duplicate check, and only its `Usable`
888/// entries — a line that cannot run does not reserve its name. Before this, a
889/// valid declaration was rejected as "declared twice" for colliding with a
890/// broken one, which pointed the reader at the wrong line entirely.
891fn parse_line(lineno: usize, line: &str, earlier: &[Line]) -> Line {
892 // `tool` was never a valid stage, so claiming it as a keyword breaks no
893 // manifest that ever parsed. Handled before `tokenise`, whose five-column
894 // shape a three-token pin does not have.
895 if line == "tool" || line.starts_with("tool ") || line.starts_with("tool\t") {
896 let mut it = line.split_whitespace().skip(1);
897 return match (it.next(), it.next(), it.next()) {
898 (Some(program), Some(want), None) => Line::Tool(ToolPin {
899 program: program.to_string(),
900 want: want.to_string(),
901 }),
902 _ => broken_at(
903 lineno,
904 format!("{MANIFEST}:{lineno}"),
905 None,
906 ParseError::BadTool,
907 ),
908 };
909 }
910 // `severity` and `skip` were never valid stages either — the same
911 // keyword claim `tool` made. Fixed arity; anything else is a positional
912 // gap, never a phantom check named after its target (a broken
913 // `severity clippy loud` must not mint `pre-commit-clippy`).
914 if line == "severity" || line.starts_with("severity ") || line.starts_with("severity\t") {
915 let mut it = line.split_whitespace().skip(1);
916 return match (it.next(), it.next(), it.next()) {
917 (Some(target), Some(word), None) => match Severity::parse(word) {
918 Some(severity) => Line::Policy {
919 what: PolicyLine::Severity {
920 target: target.to_string(),
921 severity,
922 },
923 lineno,
924 },
925 None => broken_at(
926 lineno,
927 format!("{MANIFEST}:{lineno}"),
928 None,
929 ParseError::BadSeverity(word.to_string()),
930 ),
931 },
932 _ => broken_at(
933 lineno,
934 format!("{MANIFEST}:{lineno}"),
935 None,
936 ParseError::BadPolicyLine("severity <check> warn|block"),
937 ),
938 };
939 }
940 if line == "skip" || line.starts_with("skip ") || line.starts_with("skip\t") {
941 let mut it = line.split_whitespace().skip(1);
942 return match (it.next(), it.next()) {
943 (Some(target), None) => Line::Policy {
944 what: PolicyLine::Skip {
945 target: target.to_string(),
946 },
947 lineno,
948 },
949 _ => broken_at(
950 lineno,
951 format!("{MANIFEST}:{lineno}"),
952 None,
953 ParseError::BadPolicyLine("skip <check>"),
954 ),
955 };
956 }
957 if line == "set" || line.starts_with("set ") || line.starts_with("set\t") {
958 // The value is the REST of the line, not a third token. Every key
959 // settable before this took a single word — `true`, `72`, a version —
960 // so splitting on whitespace was indistinguishable from splitting
961 // once. `snapshotPrepare` is a shell command, and a rule that only
962 // ever admits one-word values cannot express it.
963 //
964 // A trailing `#` stays part of the value, exactly as it does in a
965 // check's command: comments here are whole-line only (see the caller).
966 let rest = line[3..].trim();
967 let split = rest
968 .split_once(char::is_whitespace)
969 .map(|(k, v)| (k, v.trim()))
970 .filter(|(_, v)| !v.is_empty());
971 return match split {
972 Some((key, value)) => {
973 // Case-insensitive against the allowlist, canonical spelling
974 // stored — `set commit.subjectmax 72` must work, because git
975 // would have accepted the key in any case.
976 match SETTABLE.iter().find(|k| k.eq_ignore_ascii_case(key)) {
977 Some(canonical) => Line::Policy {
978 what: PolicyLine::Set {
979 key: format!("amont.{canonical}"),
980 value: value.to_string(),
981 },
982 lineno,
983 },
984 None => broken_at(
985 lineno,
986 format!("{MANIFEST}:{lineno}"),
987 None,
988 ParseError::UnsettableKey(key.to_string()),
989 ),
990 }
991 }
992 None => broken_at(
993 lineno,
994 format!("{MANIFEST}:{lineno}"),
995 None,
996 ParseError::BadPolicyLine("set <key> <value>"),
997 ),
998 };
999 }
1000 let (fields, command) = match tokenise(line) {
1001 Some(t) => t,
1002 // No name to report: fall back to the position, which is the only
1003 // handle a reader has on a line this malformed.
1004 None => {
1005 return broken_at(
1006 lineno,
1007 name_or_position(tokenise(line).map(|(f, _)| f[1]).unwrap_or(""), lineno),
1008 None,
1009 ParseError::MissingFields,
1010 )
1011 }
1012 };
1013 let [stage_tok, declared, scope_tok, severity_tok] = fields;
1014 let stage = parse_stage(stage_tok);
1015 let name = name_or_position(declared, lineno);
1016 let fail = |why| broken_at(lineno, name.clone(), stage, why);
1017
1018 if declared.is_empty() {
1019 return fail(ParseError::MissingName);
1020 }
1021 // The stage is settled BEFORE the name is judged, because the identity
1022 // being judged is `<trigger>-<name>` and there is no such thing without a
1023 // trigger. Ordered the other way, a line with an unusable stage was refused
1024 // for a name clash that could not be assessed yet.
1025 let Some(stage) = stage else {
1026 return fail(ParseError::BadStage(stage_tok.to_string()));
1027 };
1028 if name_says_its_trigger(declared) {
1029 return fail(ParseError::TriggerInName(declared.to_string()));
1030 }
1031 let id = format!("{}-{}", stage.as_str(), declared);
1032 if name_is_taken(&id) {
1033 return fail(ParseError::NameTaken(declared.to_string()));
1034 }
1035 if earlier
1036 .iter()
1037 .any(|l| matches!(l, Line::Usable(d) if d.id() == id))
1038 {
1039 return fail(ParseError::Duplicate(declared.to_string()));
1040 }
1041 let (exts, names, opt_in) = match parse_scope(scope_tok) {
1042 Ok(e) => e,
1043 Err(why) => return fail(why),
1044 };
1045 let Some(severity) = Severity::parse(severity_tok) else {
1046 return fail(ParseError::BadSeverity(severity_tok.to_string()));
1047 };
1048 // `fix` and `files` are leading markers on the command column rather
1049 // than extra fields, so every manifest written before them still parses.
1050 // A loop, so `fix files cmd` and `files fix cmd` both work — two markers
1051 // whose order carries no meaning must not be order-sensitive.
1052 let mut command = command;
1053 let mut wants_fix = false;
1054 let mut wants_files = false;
1055 loop {
1056 if let Some(rest) = command.strip_prefix("fix ") {
1057 command = rest.trim_start();
1058 wants_fix = true;
1059 continue;
1060 }
1061 if let Some(rest) = command.strip_prefix("files ") {
1062 command = rest.trim_start();
1063 wants_files = true;
1064 continue;
1065 }
1066 break;
1067 }
1068 if wants_fix && stage == Stage::PrePush {
1069 return fail(ParseError::FixOnPrePush);
1070 }
1071 // `tokenise` guarantees a non-empty command, so the split cannot fail.
1072 let mut argv = command.split_whitespace().map(str::to_owned);
1073 let Some(program) = argv.next() else {
1074 return fail(ParseError::MissingFields);
1075 };
1076 Line::Usable(Declared {
1077 fix: if wants_fix { Fix::Rewrite } else { Fix::None },
1078 files: wants_files,
1079 name: declared.to_string(),
1080 stage,
1081 severity,
1082 exts,
1083 names,
1084 opt_in,
1085 program,
1086 args: argv.collect(),
1087 })
1088}
1089
1090fn name_or_position(declared: &str, lineno: usize) -> String {
1091 if declared.is_empty() {
1092 format!("{MANIFEST}:{lineno}")
1093 } else {
1094 declared.to_string()
1095 }
1096}
1097
1098fn broken_at(lineno: usize, name: String, stage: Option<Stage>, why: ParseError) -> Line {
1099 Line::Broken {
1100 name,
1101 stage: stage.unwrap_or(Stage::PreCommit),
1102 lineno,
1103 why,
1104 }
1105}
1106
1107impl From<Line> for External {
1108 fn from(l: Line) -> External {
1109 let (name, stage, parsed) = l.into_parts();
1110 let kind = match parsed {
1111 Ok(d) => Kind::Runnable {
1112 // `ALWAYS` only when NOTHING narrows it. An opt-in alone is a
1113 // narrowing — `+Gemfile` means "any change, in a Ruby
1114 // repository" — and collapsing that to `ALWAYS` would run the
1115 // check everywhere, which is the exact bug this field exists
1116 // to prevent.
1117 scope: if d.exts.is_empty() && d.names.is_empty() && d.opt_in.is_empty() {
1118 Scope::ALWAYS
1119 } else {
1120 Scope {
1121 files: leak(d.exts),
1122 names: leak(d.names),
1123 opt_in: leak(d.opt_in),
1124 not_during: &[],
1125 }
1126 },
1127 severity: d.severity,
1128 program: d.program,
1129 args: d.args,
1130 fix: d.fix,
1131 files: d.files,
1132 },
1133 Err(why) => Kind::Unusable { why },
1134 };
1135 let id = format!("{}-{}", stage.as_str(), name);
1136 External {
1137 id,
1138 short_name: name,
1139 stage,
1140 kind,
1141 }
1142 }
1143}
1144
1145pub fn parse(text: &str) -> Vec<External> {
1146 parse_lines(text)
1147 .into_iter()
1148 .filter(Line::is_check)
1149 .map(External::from)
1150 .collect()
1151}
1152
1153/// The manifest for `root`, or an empty list. Read once per process.
1154pub fn read(root: &Path) -> Vec<External> {
1155 std::fs::read_to_string(root.join(MANIFEST))
1156 .map(|t| parse(&t))
1157 .unwrap_or_default()
1158}
1159
1160/// The same file, without building the `Scope`s — for a reader that inspects
1161/// many repositories and must not leak once per manifest per refresh.
1162pub fn read_lines(root: &Path) -> Vec<Line> {
1163 std::fs::read_to_string(root.join(MANIFEST))
1164 .map(|t| parse_lines(&t))
1165 .unwrap_or_default()
1166}
1167
1168/// Everything one repository's manifest declares, parsed and trust-gated
1169/// ONCE, owned by the entrypoint that loaded it and lent down through `Ctx`.
1170///
1171/// This replaced two process-global `OnceLock`s keyed on the working
1172/// directory at first call — safe in a hook, which handles one repository
1173/// and exits, and a trap for anything that walks many. Owned data has no
1174/// first-call: the caller says which repository it means, every time.
1175#[derive(Default)]
1176pub struct Manifest {
1177 /// Declared checks — untrusted ones present but `Unusable`, so the
1178 /// decision waiting on the reader stays visible. See [`gate`].
1179 pub externals: Vec<External>,
1180 /// Tool version pins — DROPPED entirely when untrusted, because verifying
1181 /// one executes `<program> --version` for a name the repository chose,
1182 /// which is exactly the consent the trust model exists to collect.
1183 pub pins: Vec<ToolPin>,
1184 /// Whether an `amont.conf` EXISTS in this repository — the committed
1185 /// declaration that this project subscribes to amont's conventions.
1186 /// Presence, not content: an empty file declares, and declaring executes
1187 /// nothing, so this is safe to read before any trust decision. What the
1188 /// file SAYS stays trust-gated above.
1189 pub declared: bool,
1190 /// Committed `severity`/`skip` policy — POPULATED ONLY WHEN TRUSTED,
1191 /// like the pins: applying a repository's opinion about your safety net
1192 /// is exactly the consent the trust model collects. See `policy`.
1193 pub policy: crate::policy::Policy,
1194 /// `trust::why(state)` when policy lines exist but the manifest is not
1195 /// trusted — the dispatchers say it once per stage, because policy that
1196 /// silently does not apply is a silent behaviour change.
1197 pub policy_withheld: Option<&'static str>,
1198 /// `severity`/`skip` targets that name no check here, with positions —
1199 /// a typo in committed policy must be loud, not a phantom check.
1200 pub policy_notes: Vec<String>,
1201}
1202
1203/// Read and trust-gate `root`'s manifest.
1204///
1205/// ONE read. The bytes that get PARSED and the bytes that get HASHED are the
1206/// same bytes: an earlier shape `read(root)`-ed and then let `trust::state`
1207/// open the file a second time, so anything that changed it in between — a
1208/// `git checkout`, a watcher, a `make` target already running — produced a
1209/// trust decision about content that is not the content about to be
1210/// executed.
1211///
1212/// Each call leaks the `Scope` slices it builds (see [`leak`]) — pennies for
1213/// the hook path, which loads once per process, and the reason the fleet
1214/// keeps reading [`read_lines`] instead: a scanner must not leak once per
1215/// repository per refresh.
1216pub fn load(root: &Path) -> Manifest {
1217 // Non-UTF-8 yields nothing, as it always has: `parse` takes a `&str`,
1218 // and a manifest we cannot read as text is one we cannot act on. Not
1219 // lossy — that would invent a manifest nobody wrote.
1220 let declared = root.join(MANIFEST).exists();
1221 let Ok(bytes) = std::fs::read(root.join(MANIFEST)) else {
1222 return Manifest {
1223 declared,
1224 ..Manifest::default()
1225 };
1226 };
1227 let Ok(text) = String::from_utf8(bytes.clone()) else {
1228 return Manifest {
1229 declared,
1230 ..Manifest::default()
1231 };
1232 };
1233 let state = crate::trust::state_of(root, &bytes);
1234 let lines = parse_lines(&text);
1235 let externals = gate(
1236 lines
1237 .iter()
1238 .filter(|l| l.is_check())
1239 .cloned()
1240 .map(External::from)
1241 .collect(),
1242 state,
1243 );
1244 let trusted = state == crate::trust::State::Trusted;
1245 let pins = if trusted {
1246 lines
1247 .iter()
1248 .filter_map(|l| match l {
1249 Line::Tool(pin) => Some(pin.clone()),
1250 _ => None,
1251 })
1252 .collect()
1253 } else {
1254 Vec::new()
1255 };
1256 let has_policy = lines.iter().any(|l| matches!(l, Line::Policy { .. }));
1257 let (policy, policy_notes) = if trusted {
1258 crate::policy::Policy::from_lines(&lines)
1259 } else {
1260 (crate::policy::Policy::default(), Vec::new())
1261 };
1262 // NOTE: load() computes but never INSTALLS the policy — the entrypoints
1263 // do, immediately after this returns and before any config read. A
1264 // multi-repo walker (the fleet) reads `read_lines` and must never seed
1265 // the process-global store.
1266 let policy_withheld = if has_policy && !trusted {
1267 crate::trust::why(state)
1268 } else {
1269 None
1270 };
1271 Manifest {
1272 externals,
1273 pins,
1274 declared,
1275 policy,
1276 policy_withheld,
1277 policy_notes,
1278 }
1279}
1280
1281/// Check every trusted pin against the tool actually on this machine, and say
1282/// what disagrees. Warn-only, once per hook run, at BOTH stages: skew never
1283/// blocks a commit — its cost is a check disagreeing with CI, and the fix is
1284/// a human decision — but it stops being invisible, which is the whole point.
1285pub fn verify_tool_pins(pins: &[ToolPin]) {
1286 for pin in pins {
1287 match version_of(&pin.program) {
1288 None => crate::hooks::common::warn(&format!(
1289 "{} is pinned to {} in {MANIFEST}, but `{} --version` would not run",
1290 crate::ui::highlight(&pin.program),
1291 crate::ui::sanitize(&pin.want),
1292 crate::ui::sanitize(&pin.program),
1293 )),
1294 Some(v) if !v.contains(&pin.want) => crate::hooks::common::warn(&format!(
1295 "{} reports {} — {MANIFEST} pins {}; this machine may disagree with CI",
1296 crate::ui::highlight(&pin.program),
1297 crate::ui::sanitize(&v),
1298 crate::ui::sanitize(&pin.want),
1299 )),
1300 _ => {}
1301 }
1302 }
1303}
1304
1305/// First line of `<program> --version`, resolved the way every check resolves
1306/// a tool. A version probe answers in milliseconds or not at all, so it is
1307/// deliberately not under the check deadline.
1308fn version_of(program: &str) -> Option<String> {
1309 let out = Command::new(crate::hooks::common::program(program))
1310 .arg("--version")
1311 .stdin(Stdio::null())
1312 .output()
1313 .ok()?;
1314 if !out.status.success() {
1315 return None;
1316 }
1317 let text = String::from_utf8_lossy(&out.stdout);
1318 let line = text.lines().next().unwrap_or("").trim();
1319 if line.is_empty() {
1320 return None;
1321 }
1322 Some(line.to_string())
1323}
1324
1325/// Apply a trust verdict to what the manifest declared.
1326///
1327/// Untrusted declarations are kept and DISABLED, not dropped. The names stay
1328/// visible in `amont list`, in the dashboard and in the "could not run"
1329/// roll-up, because a repository quietly declaring checks that never run is the
1330/// failure this project is arranged against — and the reader needs to know
1331/// there is a decision waiting for them.
1332///
1333/// Split out of [`load`] so the rule can be asserted without a repository on
1334/// disk — and kept split even now that `load` takes an explicit root, because
1335/// a trust verdict is one input among several there and this is the part with
1336/// the rule in it.
1337pub(crate) fn gate(declared: Vec<External>, state: crate::trust::State) -> Vec<External> {
1338 match crate::trust::why(state) {
1339 None => declared,
1340 Some(reason) => declared
1341 .into_iter()
1342 .map(|external| External {
1343 kind: Kind::Unusable {
1344 why: reason.to_string(),
1345 },
1346 ..external
1347 })
1348 .collect(),
1349 }
1350}
1351
1352#[cfg(test)]
1353mod tests {
1354 use super::*;
1355
1356 fn one(text: &str) -> Line {
1357 let mut v = parse_lines(text);
1358 assert_eq!(v.len(), 1, "expected one entry from {text:?}");
1359 v.pop().expect("one")
1360 }
1361
1362 /// The error a line produced, as a VALUE. Tests used to match on the prose,
1363 /// which coupled them to wording and would have kept passing if the wording
1364 /// stayed while the meaning changed.
1365 fn why(l: &Line) -> ParseError {
1366 match l {
1367 Line::Broken { why, .. } => why.clone(),
1368 Line::Usable(d) => panic!("{} parsed when it should not have", d.name),
1369 Line::Tool(pin) => panic!("{} parsed as a pin, not a broken line", pin.program),
1370 Line::Policy { what, .. } => {
1371 panic!("{} parsed as policy, not a broken line", what.describe())
1372 }
1373 }
1374 }
1375
1376 fn usable(l: &Line) -> &Declared {
1377 match l {
1378 Line::Usable(d) => d,
1379 Line::Broken { name, why, .. } => panic!("{name} failed to parse: {why}"),
1380 Line::Tool(pin) => panic!("{} is a tool pin, not a declaration", pin.program),
1381 Line::Policy { what, .. } => {
1382 panic!("{} is policy, not a declaration", what.describe())
1383 }
1384 }
1385 }
1386
1387 /// The scope column's bare tokens are exact filenames — basename-matched,
1388 /// so `package.json` cannot be counterfeited by `not-package.json` — and
1389 /// they mix freely with extensions. Directories and free `*` stay refused.
1390 #[test]
1391 fn a_bare_scope_token_is_an_exact_filename() {
1392 let line = one("pre-commit lockcheck package.json block ./check.sh\n");
1393 let d = usable(&line);
1394 assert!(d.exts.is_empty());
1395 assert_eq!(d.names, ["package.json"]);
1396
1397 let line = one("pre-commit x *.ts,package.json,.prettierrc block ./x\n");
1398 let d = usable(&line);
1399 assert_eq!(d.exts, [".ts"]);
1400 assert_eq!(d.names, ["package.json", ".prettierrc"]);
1401
1402 assert_eq!(
1403 why(&one("pre-commit x src/package.json block ./x\n")),
1404 ParseError::BadScope("src/package.json".into())
1405 );
1406 assert_eq!(
1407 why(&one("pre-commit x pkg* block ./x\n")),
1408 ParseError::BadScope("pkg*".into())
1409 );
1410 }
1411
1412 /// `+` adds the repository condition a builtin has always had.
1413 ///
1414 /// The separator is the one `amont list` already prints between the two
1415 /// halves (`needs .rs + Cargo.toml`), so what a reader sees in the listing
1416 /// is what they write in the file.
1417 #[test]
1418 fn a_scope_can_name_what_the_repository_must_carry() {
1419 let line = one("pre-commit rubocop *.rb+.rubocop.yml block rubocop\n");
1420 let d = usable(&line);
1421 assert_eq!(d.exts, [".rb"]);
1422 assert!(d.names.is_empty());
1423 assert_eq!(d.opt_in, [".rubocop.yml"]);
1424
1425 // Both sides comma-separated: any trigger, and any ONE opt-in.
1426 let line = one("pre-commit x *.rb,Rakefile+.rubocop.yml,.rubocop_todo.yml block ./x\n");
1427 let d = usable(&line);
1428 assert_eq!(d.exts, [".rb"]);
1429 assert_eq!(d.names, ["Rakefile"]);
1430 assert_eq!(d.opt_in, [".rubocop.yml", ".rubocop_todo.yml"]);
1431
1432 // No trigger half: "any change, in a repository that carries this".
1433 let line = one("pre-commit x +Gemfile block ./x\n");
1434 let d = usable(&line);
1435 assert!(d.exts.is_empty() && d.names.is_empty());
1436 assert_eq!(d.opt_in, ["Gemfile"]);
1437 }
1438
1439 /// Every declaration written before `+` existed keeps its meaning: no
1440 /// opt-in is the old behaviour, which is "applies wherever it triggers".
1441 #[test]
1442 fn a_scope_without_a_plus_is_unchanged() {
1443 let line = one("pre-commit x *.ts,package.json block ./x\n");
1444 let d = usable(&line);
1445 assert!(d.opt_in.is_empty());
1446 let line = one("pre-commit x * block ./x\n");
1447 let d = usable(&line);
1448 assert!(d.opt_in.is_empty() && d.exts.is_empty() && d.names.is_empty());
1449 }
1450
1451 /// A `+` that promises a condition and names none is refused, rather than
1452 /// read as "no condition" — which is the opposite of what was reached for.
1453 #[test]
1454 fn a_malformed_opt_in_half_is_refused() {
1455 for bad in [
1456 "*.rb+", // promised, not given
1457 "*.rb+,", // still nothing
1458 "*.rb+a+b", // a second separator is not a filename
1459 "*.rb+sub/dir.yml", // directories are inexpressible, as on the left
1460 "*.rb+*.yml", // this grammar has no globs to mis-guess
1461 ] {
1462 let line = one(&format!("pre-commit x {bad} block ./x\n"));
1463 assert!(
1464 matches!(line, Line::Broken { .. }),
1465 "{bad} should be refused, got {line:?}"
1466 );
1467 }
1468 }
1469
1470 /// The pin grammar: exactly three tokens, claimed from a first token that
1471 /// was never a valid stage — no manifest that ever parsed changes meaning.
1472 #[test]
1473 fn a_tool_pin_parses_and_a_malformed_one_is_broken() {
1474 let line = one("tool ruff 0.6.\n");
1475 assert_eq!(
1476 line,
1477 Line::Tool(ToolPin {
1478 program: "ruff".into(),
1479 want: "0.6.".into()
1480 })
1481 );
1482 assert_eq!(why(&one("tool ruff\n")), ParseError::BadTool);
1483 assert_eq!(why(&one("tool ruff 0.6. extra\n")), ParseError::BadTool);
1484 // `tool` is only a keyword in column one — a check NAMED tool still
1485 // parses as the check it always was.
1486 let line = one("pre-commit tool * block make tool\n");
1487 assert_eq!(usable(&line).name, "tool");
1488 }
1489
1490 #[test]
1491 fn parses_the_documented_example() {
1492 let v = parse_lines(
1493 "# stage name scope severity command\n\
1494 pre-commit lint-shell *.sh block scripts/lint-shell.sh\n\
1495 pre-push smoke * warn make smoke\n",
1496 );
1497 assert_eq!(v.len(), 2);
1498
1499 let a = usable(&v[0]);
1500 assert_eq!(a.name, "lint-shell");
1501 assert_eq!(a.stage, Stage::PreCommit);
1502 assert_eq!(a.severity, Severity::Block);
1503 assert_eq!(a.program, "scripts/lint-shell.sh");
1504 assert!(a.args.is_empty());
1505 assert_eq!(a.exts, [".sh"]);
1506
1507 let b = usable(&v[1]);
1508 assert_eq!(b.stage, Stage::PrePush);
1509 assert_eq!(b.severity, Severity::Warn);
1510 // A command with arguments is split, not handed to a shell.
1511 assert_eq!(b.program, "make");
1512 assert_eq!(b.args, ["smoke"]);
1513 assert!(b.exts.is_empty(), "`*` gates on nothing");
1514 }
1515
1516 /// Blank lines and comments are not entries, and must not become broken
1517 /// ones — a file that is mostly documentation would otherwise report a
1518 /// dozen gaps.
1519 #[test]
1520 fn comments_and_blank_lines_produce_nothing() {
1521 assert!(parse_lines("\n \n# just a comment\n\t# indented\n").is_empty());
1522 }
1523
1524 /// The rule the module commits to: a line that cannot be understood still
1525 /// yields a check, so its absence is visible. Matched by VARIANT.
1526 #[test]
1527 fn a_malformed_line_becomes_a_visible_gap() {
1528 let cases: [(&str, ParseError); 4] = [
1529 (
1530 "pre-commit lint-shell *.sh block\n",
1531 ParseError::MissingFields,
1532 ),
1533 (
1534 "nonsense lint-shell *.sh block x\n",
1535 ParseError::BadStage("nonsense".into()),
1536 ),
1537 (
1538 "pre-commit lint-shell ?.sh block x\n",
1539 ParseError::BadScope("?.sh".into()),
1540 ),
1541 (
1542 "pre-commit lint-shell *.sh loud x\n",
1543 ParseError::BadSeverity("loud".into()),
1544 ),
1545 ];
1546 for (text, expected) in cases {
1547 assert_eq!(why(&one(text)), expected, "for {text:?}");
1548 }
1549 }
1550
1551 /// The prose still has to locate the line, even though the tests no longer
1552 /// depend on its wording.
1553 #[test]
1554 fn a_gap_reports_where_it_is() {
1555 let l = one("pre-commit lint-shell *.sh loud x\n");
1556 let said = l.broken().expect("broken");
1557 assert!(said.contains("line 1"), "{said}");
1558 assert!(said.contains("severity"), "{said}");
1559 }
1560
1561 /// `fix` on a pre-push line is refused where every other bad declaration is
1562 /// refused — on every commit, named and located — rather than as a runtime
1563 /// "contract violation" discovered later at push time by fewer people.
1564 #[test]
1565 fn fix_is_refused_on_a_pre_push_line() {
1566 assert_eq!(
1567 why(&one("pre-push smoke * block fix make smoke\n")),
1568 ParseError::FixOnPrePush
1569 );
1570 // …and accepted on pre-commit.
1571 let line = one("pre-commit fmt * block fix make format\n");
1572 let declared = usable(&line);
1573 assert_eq!(declared.fix, Fix::Rewrite);
1574 assert_eq!(declared.program, "make");
1575 assert_eq!(declared.args, ["format"]);
1576 }
1577
1578 /// Every manifest written before `fix` existed must still parse the same.
1579 #[test]
1580 fn a_command_that_merely_starts_with_fix_is_not_a_marker() {
1581 let line = one("pre-commit x * block fixup-tool --check\n");
1582 let declared = usable(&line);
1583 assert_eq!(declared.fix, Fix::None);
1584 assert_eq!(declared.program, "fixup-tool");
1585 }
1586
1587 /// The `files` marker, alone and stacked with `fix` in either order —
1588 /// two markers whose order carries no meaning must not be
1589 /// order-sensitive.
1590 #[test]
1591 fn the_files_marker_parses_alone_and_in_either_order_with_fix() {
1592 let line = one("pre-commit sc *.sh block files shellcheck\n");
1593 let declared = usable(&line);
1594 assert!(declared.files);
1595 assert_eq!(declared.fix, Fix::None);
1596 assert_eq!(declared.program, "shellcheck");
1597
1598 for text in [
1599 "pre-commit fmt * block fix files prettier --write\n",
1600 "pre-commit fmt * block files fix prettier --write\n",
1601 ] {
1602 let line = one(text);
1603 let declared = usable(&line);
1604 assert!(declared.files, "for {text:?}");
1605 assert_eq!(declared.fix, Fix::Rewrite, "for {text:?}");
1606 assert_eq!(declared.program, "prettier", "for {text:?}");
1607 assert_eq!(declared.args, ["--write"], "for {text:?}");
1608 }
1609 }
1610
1611 /// A command that merely starts with `files` keeps its name, exactly as
1612 /// `fixup-tool` keeps its own.
1613 #[test]
1614 fn a_command_that_merely_starts_with_files_is_not_a_marker() {
1615 let line = one("pre-commit x * block files-checker --strict\n");
1616 let declared = usable(&line);
1617 assert!(!declared.files);
1618 assert_eq!(declared.program, "files-checker");
1619 }
1620
1621 /// A gap with no name cannot be reported, and a line this broken has none.
1622 #[test]
1623 fn a_nameless_line_is_named_after_its_position() {
1624 let l = one("pre-commit\n");
1625 assert_eq!(l.name(), "amont.conf:1");
1626 assert_eq!(why(&l), ParseError::MissingFields);
1627 }
1628
1629 /// An external must not be able to take a built-in's id — it would either
1630 /// shadow `pre-push-branch-protect` or silently lose to it, and neither is
1631 /// something a repository should be able to do by editing a text file.
1632 ///
1633 /// Judged on the id, so the same declaration is refused on one trigger and
1634 /// accepted on the other. That is not a loophole: `pre-push-clippy` is a
1635 /// different check from `pre-commit-clippy`, and nothing is shadowed.
1636 #[test]
1637 fn a_built_in_id_is_refused() {
1638 assert_eq!(
1639 why(&one("pre-commit clippy *.rs block x\n")),
1640 ParseError::NameTaken("clippy".into())
1641 );
1642 assert!(matches!(
1643 one("pre-push clippy *.rs block x\n"),
1644 Line::Usable(_)
1645 ));
1646 // And a pre-push built-in is protected on pre-push, not on pre-commit,
1647 // for the same reason.
1648 assert_eq!(
1649 why(&one("pre-push pull-rebase * block x\n")),
1650 ParseError::NameTaken("pull-rebase".into())
1651 );
1652 assert!(matches!(
1653 one("pre-commit pull-rebase * block x\n"),
1654 Line::Usable(_)
1655 ));
1656 }
1657
1658 /// The stage column says which trigger a line is for. Saying it again in
1659 /// the name is the one way to make an id ambiguous: `pre-commit-clippy` as
1660 /// a NAME is a check whose short name is the built-in's full id, so one
1661 /// `hook.skip` would silence both.
1662 #[test]
1663 fn a_name_that_says_its_own_trigger_is_refused() {
1664 for name in ["pre-commit", "pre-push", "pre-commit-clippy", "pre-push-x"] {
1665 assert_eq!(
1666 why(&one(&format!("pre-commit {name} * block x\n"))),
1667 ParseError::TriggerInName(name.into()),
1668 "{name}"
1669 );
1670 }
1671 // A name that merely begins with the same letters is fine — the trigger
1672 // has to be followed by the separator to count.
1673 assert!(matches!(
1674 one("pre-commit pre-commitish * block x\n"),
1675 Line::Usable(_)
1676 ));
1677 }
1678
1679 /// Two USABLE lines with one ID: the second cannot be addressed by
1680 /// `hook.skip` or by a severity override, so it is refused.
1681 #[test]
1682 fn a_duplicate_id_is_refused() {
1683 let v = parse_lines(
1684 "pre-commit smoke * block a\n\
1685 pre-commit smoke * block b\n",
1686 );
1687 assert_eq!(v.len(), 2);
1688 assert_eq!(usable(&v[0]).id(), "pre-commit-smoke");
1689 assert_eq!(why(&v[1]), ParseError::Duplicate("smoke".into()));
1690 }
1691
1692 /// The same name on both triggers is TWO checks, and this used to refuse
1693 /// the second. Somebody wanting a `show-unicorn` on commit and on push had
1694 /// no way to write it, and no way to skip or downgrade one without the
1695 /// other — the bare name could not tell them apart.
1696 #[test]
1697 fn the_same_name_on_two_triggers_is_allowed() {
1698 let v = parse_lines(
1699 "pre-commit show-unicorn * block a\n\
1700 pre-push show-unicorn * block b\n",
1701 );
1702 assert_eq!(v.len(), 2);
1703 assert_eq!(usable(&v[0]).id(), "pre-commit-show-unicorn");
1704 assert_eq!(usable(&v[1]).id(), "pre-push-show-unicorn");
1705
1706 // And each is separately addressable, while the short name takes both —
1707 // which is the whole vocabulary, applied to declared checks.
1708 for (id, only) in [
1709 ("pre-commit-show-unicorn", "pre-push-show-unicorn"),
1710 ("pre-push-show-unicorn", "pre-commit-show-unicorn"),
1711 ] {
1712 assert!(crate::skip_suppresses(id, id));
1713 assert!(!crate::skip_suppresses(only, id));
1714 }
1715 assert!(crate::skip_suppresses(
1716 "pre-commit-show-unicorn",
1717 "show-unicorn"
1718 ));
1719 assert!(crate::skip_suppresses(
1720 "pre-push-show-unicorn",
1721 "show-unicorn"
1722 ));
1723 assert!(crate::skip_suppresses(
1724 "pre-commit-show-unicorn",
1725 "pre-commit"
1726 ));
1727 assert!(!crate::skip_suppresses(
1728 "pre-push-show-unicorn",
1729 "pre-commit"
1730 ));
1731 }
1732
1733 /// A line that cannot run does not RESERVE its name.
1734 ///
1735 /// It used to: broken and usable entries shared one list, so a valid
1736 /// declaration was rejected as "declared twice" for colliding with a line
1737 /// that could never execute — pointing the reader at the wrong line, and
1738 /// forcing them to fix the first before the second would work at all.
1739 #[test]
1740 fn a_broken_line_does_not_reserve_its_name() {
1741 let v = parse_lines(
1742 "pre-commit smoke * LOUD make a\n\
1743 pre-commit smoke * block make b\n",
1744 );
1745 assert_eq!(v.len(), 2);
1746 assert_eq!(why(&v[0]), ParseError::BadSeverity("LOUD".into()));
1747 let good = usable(&v[1]);
1748 assert_eq!(good.name, "smoke");
1749 assert_eq!(good.program, "make");
1750 }
1751
1752 /// Alignment is cosmetic. A file someone has lined up with tabs, or not
1753 /// lined up at all, must parse identically.
1754 #[test]
1755 fn field_alignment_does_not_matter() {
1756 let spaced = one("pre-commit lint-shell *.sh block make lint\n");
1757 let tabbed = one("pre-commit\tlint-shell\t*.sh\tblock\tmake lint\n");
1758 assert_eq!(usable(&spaced), usable(&tabbed));
1759 assert_eq!(usable(&spaced).args, ["lint"]);
1760 }
1761
1762 #[test]
1763 fn several_extensions_can_gate_one_check() {
1764 let e = External::from(one("pre-commit shell *.sh,*.bash block make lint\n"));
1765 assert!(e.scope().matches(&["a.bash".into()]));
1766 assert!(e.scope().matches(&["a.sh".into()]));
1767 assert!(!e.scope().matches(&["a.zsh".into()]));
1768 }
1769
1770 /// `tokenise` states its arity in the type, so "four tokens then a command"
1771 /// is checked rather than remembered.
1772 #[test]
1773 fn tokenise_wants_four_fields_and_a_command() {
1774 assert!(tokenise("a b c").is_none(), "too few fields");
1775 assert!(tokenise("a b c d").is_none(), "four fields, no command");
1776 // Trailing whitespace reaches the four fields but still leaves nothing
1777 // to run — the case the `?` on the last field cannot catch.
1778 assert!(
1779 tokenise("a b c d ").is_none(),
1780 "command is all whitespace"
1781 );
1782 assert!(tokenise("a b c d\t").is_none(), "command is a tab");
1783 let (fields, cmd) = tokenise("a b\tc d run it").expect("four and a command");
1784 assert_eq!(fields, ["a", "b", "c", "d"]);
1785 assert_eq!(cmd, "run it");
1786 }
1787
1788 /// An unusable line carries no command at all — the type has nowhere to put
1789 /// one, which is the point of the split.
1790 #[test]
1791 fn an_unusable_external_holds_no_command() {
1792 let e = External::from(one("pre-commit lint-shell *.sh loud echo hi\n"));
1793 assert!(matches!(e.kind, Kind::Unusable { .. }));
1794 // And it can never block, whatever severity anyone configures.
1795 assert_eq!(e.severity(), Severity::Warn);
1796 }
1797
1798 /// A missing manifest is the normal case and must not be an error.
1799 #[test]
1800 fn a_repository_with_no_manifest_declares_nothing() {
1801 assert!(read(Path::new("/nonexistent-c8f2")).is_empty());
1802 assert!(read_lines(Path::new("/nonexistent-c8f2")).is_empty());
1803 }
1804
1805 /// `Line` exists to spare the dashboard a leak, not to become a second
1806 /// opinion about what a manifest says.
1807 #[test]
1808 fn the_leaking_and_non_leaking_parsers_agree() {
1809 let text = "pre-commit lint-shell *.sh,*.bash block make lint\n\
1810 pre-push smoke * warn make smoke\n\
1811 pre-commit broken ? block x\n";
1812 let lines = parse_lines(text);
1813 let externals = parse(text);
1814 assert_eq!(lines.len(), externals.len());
1815 for (l, e) in lines.iter().zip(&externals) {
1816 assert_eq!(l.id(), e.name(), "the id is what a check answers to");
1817 assert_eq!(
1818 l.name(),
1819 e.short_name,
1820 "and the short name is what it is called"
1821 );
1822 assert_eq!(l.stage(), e.stage());
1823 assert_eq!(
1824 l.broken().is_some(),
1825 matches!(e.kind, Kind::Unusable { .. })
1826 );
1827 if let Line::Usable(d) = l {
1828 assert_eq!(d.severity, e.severity());
1829 // The scope the dashboard would DESCRIBE is the scope the
1830 // dispatcher would ENFORCE.
1831 assert_eq!(d.exts, e.scope().files);
1832 }
1833 }
1834 }
1835}