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

use std::collections::HashSet;

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

use super::{comment_line_unprefixed, extract, parse};

fn extract_simple(toml: &str) -> String {
    extract(toml, "{feature}", &HashSet::new()).unwrap()
}

#[test]
fn test_extract() {
    expect![[r#"
        - std *(enabled by default)* — Some docs about std
        - serde — Some docs about serde
        - something_undocumented
    "#]]
    .assert_eq(&extract_simple(indoc! {r#"
        [features]
        default = ["std"]
        ## Some docs about std
        std = []
        ## Some docs about serde
        serde = []
        something_undocumented = []
    "#}));
}

#[test]
fn test_extract_inline() {
    expect![[r#"
        - std *(enabled by default)*
        - serde
    "#]]
    .assert_eq(&extract_simple(indoc! {r#"
        features = { default = ["std"], std = [], serde = [] }
    "#}));
}

#[test]
fn test_extract_hidden() {
    expect![[r#"
        - documented — bla bla
        - undocumented
    "#]]
    .assert_eq(
        &extract(
            indoc! {r#"
        [features]
        ## bla bla
        documented = []
        undocumented = []
        ## blo blo
        hidden-documented = []
        hidden-undocumented = []
    "#},
            "{feature}",
            &["hidden-documented", "hidden-undocumented"].into_iter().collect(),
        )
        .unwrap(),
    );
}

#[test]
fn test_feature_syntax_no_space() {
    expect!["a non-empty feature docs comment line must start with a space"]
        .assert_eq(&parse("[features]\n##Evil docs.\nmy_feature = []").unwrap_err().to_string());
}

#[test]
fn test_feature_syntax_no_space_in_empty_line() {
    assert_eq!(
        "- my_feature — Good\n  \n  docs.\n",
        extract_simple("[features]\n## Good\n##\n## docs.\nmy_feature = []")
    );

    assert_eq!(
        "- my_feature — Good\n  \n  docs.\n",
        extract_simple("[features]\n## Good\n##\t \u{A0}\n## docs.\nmy_feature = []")
    );
}

#[test]
fn test_comment_line() {
    fn try_strip(s: &str) -> Result<&str> {
        comment_line_unprefixed(s)
    }

    #[track_caller]
    fn strip(s: &str) -> &str {
        try_strip(s).unwrap()
    }

    assert_eq!(strip(" "), "");
    assert_eq!(strip("\t"), "");
    assert_eq!(strip("\u{A0}"), "");

    assert_eq!(strip(" Hello"), "Hello");
    assert_eq!(strip("  Hello"), " Hello");

    assert!(try_strip("\tHello").is_err());
    assert!(try_strip("\u{A0}Hello").is_err());

    assert_eq!(strip(" Hello "), "Hello");
    assert_eq!(strip(" Hello  "), "Hello");
    assert_eq!(strip(" Hello\t"), "Hello");
    assert_eq!(strip(" Hello\u{A0}"), "Hello");
}