adrs 0.11.0

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

//! Renumber command for repairing duplicate or misassigned ADR numbers.

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

/// Renumber an ADR, rewriting its filename, frontmatter `number` (nextgen
/// mode), H1 heading, and every inbound reference in the rest of the
/// repository.
pub fn renumber(root: &Path, from: u32, to: u32, file: Option<&Path>, dry_run: bool) -> Result<()> {
    let repo =
        Repository::open(root).context("ADR repository not found. Run 'adrs init' first.")?;

    let result = repo
        .renumber(from, to, file, dry_run)
        .with_context(|| format!("Failed to renumber ADR {from} to {to}"))?;

    if result.no_op {
        println!("ADR {from} is already numbered {to}; nothing to do.");
        return Ok(());
    }

    let (verb_done, verb_pending) = if dry_run {
        ("Would rename", "Would update")
    } else {
        ("Renamed", "Updated")
    };

    if let Some((old_path, new_path)) = &result.renamed_file {
        println!(
            "{} {} -> {}",
            verb_done,
            old_path.display(),
            new_path.display()
        );
    }

    if result.frontmatter_updated {
        println!("  {verb_pending} frontmatter `number` to {to}");
    }
    if result.h1_updated {
        println!("  {verb_pending} H1 heading to number {to}");
    }

    if !result.updated_references.is_empty() {
        println!(
            "\n{} {} inbound reference(s):",
            verb_pending,
            result.updated_references.len()
        );
        for path in &result.updated_references {
            println!("  {}", path.display());
        }
    }

    if !result.ambiguous_references.is_empty() {
        println!(
            "\nNote: {} record(s) link to ADR {from} by number. Another record still\nhas that number, so the reference was left as-is rather than repointed:",
            result.ambiguous_references.len()
        );
        for path in &result.ambiguous_references {
            println!("  {}", path.display());
        }
    }

    if !result.prose_warnings.is_empty() {
        println!(
            "\nNote: {} file(s) outside the ADR directory mention the old filename (not rewritten):",
            result.prose_warnings.len()
        );
        for path in &result.prose_warnings {
            println!("  {}", path.display());
        }
    }

    if dry_run {
        println!("\nDry run - no files written");
    }

    Ok(())
}