Struct RefEntry 

pub struct RefEntry {
    pub ref: String,
    pub args: Option<String>,
    pub name: Option<String>,
}

A reference to a named definition in the definitions section.

Supports two optional overrides that are applied at the point of use, without modifying the shared definition:

hooks:
  pre-commit:
    commands:
      - $ref: lint                  # use definition as-is
      - $ref: lint
        args: "--fix"               # appends to the definition's run command
        name: lint-fix              # overrides the display label

Fields

ref: String

Name of the definition to reference.

args: Option<String>

Extra arguments appended to the definition’s run command.

The final command executed is {definition.run} {args}. For example, if the definition runs npm run lint, setting args: "--fix" produces npm run lint --fix.

name: Option<String>

Override the display name shown in hook output for this specific use. When omitted, the definition’s own name is used.

Trait Implementations

impl Clone for RefEntry

fn clone(&self) -> RefEntry

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RefEntry

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for RefEntry

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl JsonSchema for RefEntry

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 RefEntry

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

where __S: Serializer,

Serialize this value into the given Serde serializer.