Struct IncludeRef 

pub struct IncludeRef {
    pub include_ref: String,
    pub run: String,
    pub args: Option<String>,
    pub env: BTreeMap<String, String>,
    pub name: Option<String>,
}

A reference to a value in an included external file, used as a hook command.

The value at run (dot-notation path) is extracted from the file and used as the shell command. Optional args are appended to that command. Optional env sets environment variables for the invocation.

Example:

hooks:
  pre-commit:
    commands:
      - $include: packagejson   # references include with ref: packagejson
        run: scripts.lint       # navigates to scripts → lint in the file
        args: "--fix"           # appended to the resolved command
        env:
          NODE_ENV: production
        name: lint              # optional display name (defaults to last segment of run)

Fields

include_ref: String

Name of the include to reference (must match an IncludeEntry with this ref).

run: String

Dot-notation path to the value in the file (e.g. scripts.lint).

args: Option<String>

Extra arguments appended to the resolved command string.

env: BTreeMap<String, String>

Environment variables set for this command invocation.

name: Option<String>

Optional display name. Defaults to the last segment of run.

Trait Implementations

impl Clone for IncludeRef

fn clone(&self) -> IncludeRef

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for IncludeRef

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for IncludeRef

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl JsonSchema for IncludeRef

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 IncludeRef

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

where __S: Serializer,

Serialize this value into the given Serde serializer.