Struct HookConfig 

pub struct HookConfig {
    pub enabled: bool,
    pub parallel: bool,
    pub commands: Vec<CommandEntry>,
}

Fields

enabled: bool

Whether this hook is active. Set to false to temporarily disable.

parallel: bool

Run commands concurrently within each dependency wave.

When true, commands that have no dependency relationship are started at the same time in separate threads. Commands that share a depends link are still serialised — the dependent command waits until all its dependencies finish successfully.

Use this to speed up independent checks (e.g. lint + test) while keeping ordered steps (e.g. build → deploy) sequential.

Example:

hooks:
  pre-push:
    parallel: true
    commands:
      - name: lint
        run: cargo clippy
      - name: test
        run: cargo test   # runs at the same time as lint

commands: Vec<CommandEntry>

Commands to run when this hook fires. Each entry is either an inline command or a $ref to a definition.

Implementations

impl HookConfig

pub fn resolved_commands<'a>( &'a self, definitions: &'a BTreeMap<String, DefinitionEntry>, ) -> Vec<Command>

Resolve all command entries to concrete Commands by expanding $ref entries using the given definitions map. Unknown refs are silently skipped. $include entries are skipped here; use [resolved_commands_with_includes] to resolve them.

pub fn resolved_commands_with_includes( &self, definitions: &BTreeMap<String, DefinitionEntry>, includes: &[IncludeEntry], ) -> Result<Vec<Command>>

Like [resolved_commands] but also resolves $include entries by reading the referenced external files. Returns Err if an include cannot be resolved.

Trait Implementations

impl Clone for HookConfig

fn clone(&self) -> HookConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for HookConfig

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for HookConfig

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl JsonSchema for HookConfig

fn schema_name() -> String

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn is_referenceable() -> bool

Whether JSON Schemas generated for this type should be re-used where possible using the $ref keyword.

impl Serialize for HookConfig

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.