Struct Declared 

pub struct Declared {
    pub fix: Fix,
    pub files: bool,
    pub docs_skip: bool,
    pub name: String,
    pub stage: Stage,
    pub severity: Severity,
    pub exts: Vec<String>,
    pub names: Vec<String>,
    pub dirs: Vec<String>,
    pub opt_in: Vec<String>,
    pub program: String,
    pub args: Vec<String>,
}

A line that parsed. Every field means something.

program and args rather than one argv: a runnable check must have a command, and splitting the head off makes that structural instead of a split_first guard that can only ever be dead code.

Fields

fix: Fix

Fix::Rewrite when the command column began fix .

files: bool

The command column carried the files marker.

docs_skip: bool

The command column began docs-skip — do not run on a commit whose staged change only edits existing documentation (staged_docs_only).

name: String

stage: Stage

severity: Severity

exts: Vec<String>

Extensions that gate it. Empty means any change — the * scope.

names: Vec<String>

Exact filenames that gate it — the scope column’s bare tokens.

dirs: Vec<String>

Directory triggers, each dir/**/*.ext — see parse_scope.

opt_in: Vec<String>

Files the REPOSITORY must carry for this check to apply at all — the scope column’s + half. Empty means always applicable, which is what every declaration meant before amont add made a line something you could acquire rather than write.

program: String

args: Vec<String>

Implementations

impl Declared

pub fn id(&self) -> String

<trigger>-<name>, the same shape a built-in has.

This is what hook.skip and amont.severity.<key> resolve against, so a declared check answers to its trigger and its short name exactly as a compiled-in one does. Before it had an id, hook.skip pre-commit silenced fifteen built-ins and left every declared check running.

pub fn command(&self) -> String

The command as written, for display.

Trait Implementations

impl Clone for Declared

fn clone(&self) -> Self

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Declared

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Eq for Declared

impl PartialEq for Declared

fn eq(&self, other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for Declared