lazyspec 0.8.0

A little TUI & CLI for project documentation.
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
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
150
151
152
153
154
155
156
157

mod common;

use common::TestFixture;
use lazyspec::cli::fix::renumber::cascade_references;
use lazyspec::engine::document::DocMeta;
use lazyspec::engine::fs::RealFileSystem;
use std::fs;

fn fixture_with_related() -> TestFixture {
    let fixture = TestFixture::new();

    fixture.write_rfc("RFC-020-foo.md", "Foo", "accepted");

    fixture.write_story(
        "STORY-042-bar.md",
        "Bar",
        "draft",
        Some("docs/rfcs/RFC-020-foo.md"),
    );

    fixture
}

#[test]
fn cascade_updates_related_frontmatter() {
    let fixture = fixture_with_related();
    let store = fixture.store();

    let updates = cascade_references(
        fixture.root(),
        &store,
        "docs/rfcs/RFC-020-foo.md",
        "docs/rfcs/RFC-021-foo.md",
        false,
        &RealFileSystem,
    );

    assert!(!updates.is_empty());
    let related_update = updates.iter().find(|u| u.field == "related").unwrap();
    assert_eq!(related_update.old_value, "docs/rfcs/RFC-020-foo.md");
    assert_eq!(related_update.new_value, "docs/rfcs/RFC-021-foo.md");

    let content = fs::read_to_string(fixture.root().join("docs/stories/STORY-042-bar.md")).unwrap();
    let meta = DocMeta::parse(&content).unwrap();
    assert_eq!(meta.related[0].target, "docs/rfcs/RFC-021-foo.md");
}

#[test]
fn cascade_updates_body_ref_directive() {
    let fixture = TestFixture::new();
    fixture.write_rfc("RFC-020-foo.md", "Foo", "accepted");

    let body_content = "---\ntitle: \"Story\"\ntype: story\nstatus: draft\nauthor: \"test\"\ndate: 2026-01-01\ntags: []\n---\nSee @ref docs/rfcs/RFC-020-foo.md#SomeStruct for details.\n";
    fixture.write_doc("docs/stories/STORY-050-uses-ref.md", body_content);

    let store = fixture.store();

    let updates = cascade_references(
        fixture.root(),
        &store,
        "docs/rfcs/RFC-020-foo.md",
        "docs/rfcs/RFC-021-foo.md",
        false,
        &RealFileSystem,
    );

    let body_update = updates.iter().find(|u| u.field == "body").unwrap();
    assert!(body_update.old_value.contains("docs/rfcs/RFC-020-foo.md"));
    assert!(body_update.new_value.contains("docs/rfcs/RFC-021-foo.md"));

    let content =
        fs::read_to_string(fixture.root().join("docs/stories/STORY-050-uses-ref.md")).unwrap();
    assert!(content.contains("docs/rfcs/RFC-021-foo.md"));
    assert!(!content.contains("docs/rfcs/RFC-020-foo.md"));
}

#[test]
fn cascade_subfolder_rename_updates_child_references() {
    let fixture = TestFixture::new();

    let parent_content = "---\ntitle: \"Parent RFC\"\ntype: rfc\nstatus: accepted\nauthor: \"test\"\ndate: 2026-01-01\ntags: []\n---\n";
    fixture.write_subfolder_doc("docs/rfcs/RFC-020-foo", parent_content);

    fixture.write_child_doc(
        "docs/rfcs/RFC-020-foo",
        "design.md",
        "---\ntitle: \"Design\"\ntype: rfc\nstatus: draft\nauthor: \"test\"\ndate: 2026-01-01\ntags: []\n---\n",
    );

    let story_content = "---\ntitle: \"Referencing story\"\ntype: story\nstatus: draft\nauthor: \"test\"\ndate: 2026-01-01\ntags: []\nrelated:\n- implements: docs/rfcs/RFC-020-foo/design.md\n---\nAlso see @ref docs/rfcs/RFC-020-foo/index.md for context.\n";
    fixture.write_doc("docs/stories/STORY-060-refs.md", story_content);

    let store = fixture.store();

    let updates = cascade_references(
        fixture.root(),
        &store,
        "docs/rfcs/RFC-020-foo/",
        "docs/rfcs/RFC-021-foo/",
        false,
        &RealFileSystem,
    );

    assert!(updates.len() >= 2);

    let related_update = updates.iter().find(|u| u.field == "related").unwrap();
    assert_eq!(related_update.old_value, "docs/rfcs/RFC-020-foo/design.md");
    assert_eq!(related_update.new_value, "docs/rfcs/RFC-021-foo/design.md");

    let body_update = updates.iter().find(|u| u.field == "body").unwrap();
    assert!(body_update.old_value.contains("docs/rfcs/RFC-020-foo/"));
    assert!(body_update.new_value.contains("docs/rfcs/RFC-021-foo/"));
}

#[test]
fn cascade_dry_run_returns_updates_without_modifying_files() {
    let fixture = fixture_with_related();
    let store = fixture.store();

    let content_before =
        fs::read_to_string(fixture.root().join("docs/stories/STORY-042-bar.md")).unwrap();

    let updates = cascade_references(
        fixture.root(),
        &store,
        "docs/rfcs/RFC-020-foo.md",
        "docs/rfcs/RFC-021-foo.md",
        true,
        &RealFileSystem,
    );

    assert!(!updates.is_empty());

    let content_after =
        fs::read_to_string(fixture.root().join("docs/stories/STORY-042-bar.md")).unwrap();
    assert_eq!(content_before, content_after);
}

#[test]
fn cascade_no_references_returns_empty_vec() {
    let fixture = TestFixture::new();
    fixture.write_rfc("RFC-001-unrelated.md", "Unrelated", "draft");
    fixture.write_story("STORY-001-other.md", "Other", "draft", None);

    let store = fixture.store();

    let updates = cascade_references(
        fixture.root(),
        &store,
        "docs/rfcs/RFC-999-nonexistent.md",
        "docs/rfcs/RFC-998-nonexistent.md",
        false,
        &RealFileSystem,
    );

    assert!(updates.is_empty());
}