cargo-insert-docs 1.6.0

Inserts feature docs into crate docs, and crate docs into README.
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
158
159
160

use color_eyre::eyre::Result;
use expect_test::expect;
use indoc::indoc;

use super::FeatureDocsSection;

fn replace_section(
    source: &str,
    section_name: &str,
    section_content: &str,
) -> Result<Option<String>> {
    if let Some(section) = FeatureDocsSection::find(source, section_name)? {
        section.replace(section_content).map(Some)
    } else {
        Ok(None)
    }
}

#[test]
fn raw() {
    expect![[r##"
        #![doc = "prefix"]
        #![doc = "keep <!-- section start --> remove"]
        //! multi
        //! line
        //! content
        #![doc = "remove <!-- section end --> keep"]
        #![doc = "suffix"]
    "##]]
    .assert_eq(
        &replace_section(
            indoc! {r#"
            #![doc = "prefix"]
            #![doc = "keep <!-- section start --> remove"]
            #![doc = "remove <!-- section end --> keep"]
            #![doc = "suffix"]
            "#},
            "section",
            "multi\nline\ncontent",
        )
        .unwrap()
        .unwrap(),
    );
}

#[test]
fn line() {
    expect![[r#"
        //! prefix
        //! keep <!-- section start --> remove
        //! multi
        //! line
        //! content
        //! remove <!-- section end --> keep
        //! suffix
    "#]]
    .assert_eq(
        &replace_section(
            indoc! {r#"
            //! prefix
            //! keep <!-- section start --> remove
            //! remove <!-- section end --> keep
            //! suffix
            "#},
            "section",
            "multi\nline\ncontent",
        )
        .unwrap()
        .unwrap(),
    );
}

#[test]
#[ignore = "todo"]
fn block() {
    expect![[r#""#]].assert_eq(
        &replace_section(
            indoc! {r#"
            /*! prefix
             * keep <!-- section start --> remove
             * remove <!-- section end --> keep
             * suffix
             */
            "#},
            "section",
            "multi\nline\ncontent",
        )
        .unwrap()
        .unwrap(),
    );
}

#[test]
fn block_separate() {
    expect![[r#"
        /*! prefix
         * keep <!-- section start --> remove
         */
        //! multi
        //! line
        //! content
        /*! remove <!-- section end --> keep
         * suffix
         */
    "#]]
    .assert_eq(
        &replace_section(
            indoc! {r#"
            /*! prefix
             * keep <!-- section start --> remove
             */
            /*! remove <!-- section end --> keep
             * suffix
             */
            "#},
            "section",
            "multi\nline\ncontent",
        )
        .unwrap()
        .unwrap(),
    );
}

#[test]
fn test_escaped_section() {
    let lib_rs = indoc! {r#"
        //! ```text
        //! <!-- feature documentation start -->
        //! <!-- feature documentation end -->
        //! ```
    "#};

    let new_lib_rs = replace_section(lib_rs, "feature documentation", "whatever").unwrap();

    assert!(new_lib_rs.is_none());
}

#[test]
fn test_trim_end() {
    let lib_rs = indoc! {r#"
        //! <!-- feature documentation start -->
        //! <!-- feature documentation end -->
    "#};

    let new_lib_rs = replace_section(
        lib_rs,
        "feature documentation",
        "lots of whitespace for some reason:    \t   \u{A0}",
    )
    .unwrap()
    .unwrap();

    assert_eq!(
        "\
        //! <!-- feature documentation start -->\n\
        //! lots of whitespace for some reason:\n\
        //! <!-- feature documentation end -->\n",
        new_lib_rs
    );
}