feature-manifest 0.7.0

Document, validate, and render Cargo feature metadata.
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

use crate::model::{FeatureMetadata, FeatureRef};

pub(super) fn reference_summary(references: &[FeatureRef]) -> String {
    if references.is_empty() {
        return "—".to_owned();
    }

    references
        .iter()
        .map(|reference| format!("`{}`", escape_markdown_inline(&reference.to_string())))
        .collect::<Vec<_>>()
        .join(", ")
}

pub(super) fn sanitize_id(raw: &str) -> String {
    raw.chars()
        .map(|character| {
            if character.is_ascii_alphanumeric() {
                character
            } else {
                '_'
            }
        })
        .collect()
}

pub(super) fn status_summary(metadata: &FeatureMetadata) -> String {
    metadata.status_labels().join(", ")
}

pub(super) fn visibility_label(metadata: &FeatureMetadata) -> &'static str {
    if metadata.public { "public" } else { "private" }
}

pub(super) fn yes_no(value: bool) -> &'static str {
    if value { "yes" } else { "no" }
}

pub(super) fn escape_markdown_inline(value: &str) -> String {
    value
        .replace('\\', "\\\\")
        .replace('|', "\\|")
        .replace('\r', "")
        .replace('\n', "<br>")
}

pub(super) fn escape_markdown_cell(value: &str) -> String {
    escape_markdown_inline(value)
}

pub(super) fn escape_mermaid_label(value: &str) -> String {
    value
        .replace('\\', "\\\\")
        .replace('"', "\\\"")
        .replace('\r', "")
        .replace('\n', "\\n")
}