spec-driven-docs 0.7.0

Spec-driven documentation: current specs, immutable decision records, and executable gates kept coherent for people and coding agents.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41

//! `hooks` subcommand: parse-shape.
//!
//! Holds the clap derive struct only. No I/O, no business logic.

/// Render the delivered gate set as the managed pre-commit block.
#[derive(Debug, clap::Args)]
pub struct HooksArgs {
    /// What replaces `{docs_root}` in wiring patterns.
    ///
    /// Omitted, the target's recorded documentation root is used where the
    /// target is an instance, and `_docs` otherwise. A block rendered
    /// against the wrong root would disagree with the one the installer
    /// wrote.
    #[arg(long)]
    pub docs_root: Option<String>,

    /// The command prefix every entry invokes.
    #[arg(long, default_value = "sdd")]
    pub entry: String,

    /// The sequence-item indentation of the consumer's repos entries.
    #[arg(long, default_value = "  ")]
    pub indent: String,

    /// The instance whose declaration the block is rendered from.
    #[arg(long, default_value = ".")]
    pub target: String,

    /// Write the rendered block into the target's `.pre-commit-config.yaml`,
    /// replacing the managed region.
    ///
    /// Run this after editing the declaration. It works at the same version,
    /// which `sdd upgrade` does not.
    #[arg(long, conflicts_with = "check")]
    pub apply: bool,

    /// Exit non-zero when the target's managed region does not match what
    /// the declaration renders.
    #[arg(long)]
    pub check: bool,
}