radr-cli 0.1.0

Rust CLI to manage Architecture Decision Records (ADRs)
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
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79

version: '3'

vars:
  RADR_CONFIG: ""

env:
  RADR_CONFIG: "{{ .RADR_CONFIG }}"

tasks:
  default:
    desc: Build the project in debug mode
    cmds:
      - task: build

  build:
    desc: Build (debug)
    cmds:
      - cargo build

  release:
    desc: Build (release)
    cmds:
      - cargo build --release

  fmt:
    desc: Format code with rustfmt
    cmds:
      - cargo fmt --all

  clippy:
    desc: Lint with clippy (deny warnings)
    cmds:
      - cargo clippy --all-targets --all-features -- -D warnings

  test:
    desc: Run unit tests
    cmds:
      - cargo test --all

  run:
    desc: Run the CLI with arbitrary args
    vars:
      ARGS: "--help"
    cmds:
      - cargo run -- {{ .ARGS }}

  # Convenience tasks for common commands
  new:
    desc: "Create a new ADR (vars: TITLE, STATUS)"
    vars:
      TITLE: "Example ADR"
      STATUS: "Accepted"
    cmds:
      - cargo run -- new "{{ .TITLE }}" --status "{{ .STATUS }}"

  supersede:
    desc: "Create an ADR superseding another (vars: ID, TITLE)"
    vars:
      ID: "1"
      TITLE: "Superseding ADR"
    cmds:
      - cargo run -- supersede {{ .ID }} "{{ .TITLE }}"

  list:
    desc: List ADRs and regenerate index
    cmds:
      - cargo run -- list

  index:
    desc: Regenerate index.md
    cmds:
      - cargo run -- index

  clean:
    desc: Clean build artifacts
    cmds:
      - cargo clean