adrs 0.7.6

Command line tool for managing Architecture Decision Records
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
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149

//! Generate documentation commands.

use adrs_core::Repository;
use anyhow::{Context, Result};
use std::fs;
use std::path::{Path, PathBuf};

/// Generate a table of contents.
pub fn generate_toc(
    root: &Path,
    ordered: bool,
    intro: Option<PathBuf>,
    outro: Option<PathBuf>,
    prefix: Option<String>,
) -> Result<()> {
    let repo =
        Repository::open(root).context("ADR repository not found. Run 'adrs init' first.")?;
    let adrs = repo.list()?;

    // Print intro if provided
    if let Some(intro_path) = intro {
        let content = fs::read_to_string(&intro_path)
            .with_context(|| format!("Failed to read intro file: {}", intro_path.display()))?;
        println!("{}", content);
    }

    // Print TOC
    let prefix = prefix.unwrap_or_default();
    for (i, adr) in adrs.iter().enumerate() {
        let bullet = if ordered {
            format!("{}.", i + 1)
        } else {
            "*".to_string()
        };
        println!(
            "{} [{}]({}{})",
            bullet,
            adr.full_title(),
            prefix,
            adr.filename()
        );
    }

    // Print outro if provided
    if let Some(outro_path) = outro {
        let content = fs::read_to_string(&outro_path)
            .with_context(|| format!("Failed to read outro file: {}", outro_path.display()))?;
        println!("{}", content);
    }

    Ok(())
}

/// Generate a Graphviz graph.
pub fn generate_graph(root: &Path, prefix: Option<String>, extension: &str) -> Result<()> {
    let repo =
        Repository::open(root).context("ADR repository not found. Run 'adrs init' first.")?;
    let adrs = repo.list()?;

    let prefix = prefix.unwrap_or_default();

    println!("digraph {{");
    println!("  node [shape=plaintext];");

    // Create nodes
    for adr in &adrs {
        let filename = adr.filename().replace(".md", &format!(".{}", extension));
        println!(
            "  _{} [label=\"{}\"; URL=\"{}{}\"];",
            adr.number,
            adr.full_title(),
            prefix,
            filename
        );
    }

    // Create sequential edges (dotted)
    println!("  edge [style=dotted, weight=10];");
    for window in adrs.windows(2) {
        println!("  _{} -> _{};", window[0].number, window[1].number);
    }

    // Create relationship edges
    println!("  edge [style=solid, weight=1];");
    for adr in &adrs {
        for link in &adr.links {
            println!(
                "  _{} -> _{} [label=\"{}\"];",
                adr.number, link.target, link.kind
            );
        }
    }

    println!("}}");

    Ok(())
}

/// Generate an mdbook.
pub fn generate_book(
    root: &Path,
    output: &Path,
    title: Option<String>,
    description: Option<String>,
) -> Result<()> {
    let repo =
        Repository::open(root).context("ADR repository not found. Run 'adrs init' first.")?;
    let adrs = repo.list()?;

    let title = title.unwrap_or_else(|| "Architecture Decision Records".to_string());
    let description =
        description.unwrap_or_else(|| "Documentation of architectural decisions".to_string());
    let author = whoami::username().unwrap_or_else(|_| "unknown".to_string());

    // Create output directories
    let src_dir = output.join("src");
    fs::create_dir_all(&src_dir)?;

    // Create book.toml
    let book_toml = format!(
        r#"[book]
title = "{}"
description = "{}"
authors = ["{}"]
language = "en"

[build]
build-dir = "book"
"#,
        title, description, author
    );
    fs::write(output.join("book.toml"), book_toml)?;

    // Create SUMMARY.md
    let mut summary = String::from("# Summary\n\n");
    for adr in &adrs {
        summary.push_str(&format!("- [{}]({})\n", adr.full_title(), adr.filename()));

        // Copy ADR file to src
        if let Some(path) = &adr.path {
            let content = fs::read_to_string(path)?;
            fs::write(src_dir.join(adr.filename()), content)?;
        }
    }
    fs::write(src_dir.join("SUMMARY.md"), summary)?;

    println!("{}", output.display());
    Ok(())
}