spec-driven-docs 0.8.1

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
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58

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

use camino::Utf8PathBuf;

/// Report or check the tracking registry.
#[derive(Debug, clap::Args)]
pub struct TrackArgs {
    /// The operation to run.
    #[command(subcommand)]
    pub command: TrackCommand,
}

/// The two tracking operations.
#[derive(Debug, clap::Subcommand)]
pub enum TrackCommand {
    /// Report registry freshness offline.
    Status(StatusArgs),
    /// Compare each pinned Git revision to its upstream over the network.
    Check(CheckArgs),
}

/// `sdd track status`: an offline freshness report.
#[derive(Debug, clap::Args)]
pub struct StatusArgs {
    /// The instance to read; absolute, or the working directory.
    #[arg(long, default_value = ".")]
    pub target: Utf8PathBuf,

    /// Judge freshness as of this ISO date rather than today.
    #[arg(long)]
    pub as_of: Option<String>,

    /// Emit one JSON object rather than lines.
    #[arg(long)]
    pub json: bool,
}

/// `sdd track check`: the one network-enabled operation.
#[derive(Debug, clap::Args)]
pub struct CheckArgs {
    /// The instance to read; absolute, or the working directory.
    #[arg(long, default_value = ".")]
    pub target: Utf8PathBuf,

    /// Check only the entry with this id.
    #[arg(long)]
    pub id: Option<String>,

    /// Exit 1 when a completed lookup finds a different revision.
    #[arg(long)]
    pub fail_on_update: bool,

    /// Emit one JSON object rather than lines.
    #[arg(long)]
    pub json: bool,
}