Struct GateSpec 

pub struct GateSpec {
    pub id: GateId,
    pub name: &'static str,
    pub files: Option<&'static str>,
    pub types: Option<&'static str>,
    pub exclude: Option<&'static str>,
    pub always_run: bool,
    pub cites: &'static [RuleId],
    pub run: GateFn,
}

One registry row: everything the deliveries need to know about a gate.

Fields

id: GateId

The gate’s identity.

name: &'static str

The display name pre-commit shows.

files: Option<&'static str>

The default files: pattern, with {docs_root} left templated.

A row that does not set always_run carries one, under release:a-delivered-gate-reads-what-the-convention-owns: a types: scope alone reaches every matching file in the project, including the ones another tool wrote.

types: Option<&'static str>

The types: scope, when the gate takes one.

exclude: Option<&'static str>

The default exclude: pattern, with {docs_root} left templated.

always_run: bool

Whether the gate runs regardless of which files changed.

cites: &'static [RuleId]

Every rule the gate can cite in a finding.

run: GateFn

The implementation.

Trait Implementations

impl Debug for GateSpec

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

Formats the value using the given formatter.