feature-manifest 0.7.7

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
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

use std::collections::BTreeSet;

use crate::model::{Feature, FeatureManifest, FeatureRef, WorkspaceManifest};

use super::shared::{escape_mermaid_label, sanitize_id, status_summary};

/// Renders selected packages as a Mermaid graph.
pub fn render_mermaid(workspace: &WorkspaceManifest, include_private: bool) -> String {
    if workspace.is_single_package() {
        return render_mermaid_package(&workspace.packages[0], include_private, None);
    }

    let mut lines = vec!["graph TD".to_owned()];

    for package in &workspace.packages {
        let package_name = package
            .package_name
            .as_deref()
            .unwrap_or("unknown-package")
            .to_owned();
        let package_prefix = sanitize_id(&package_name);
        lines.push(format!(
            "    subgraph package_{package_prefix}[\"{}\"]",
            escape_mermaid_label(&package_name)
        ));

        for line in render_mermaid_package(package, include_private, Some(&package_prefix))
            .lines()
            .skip(1)
        {
            lines.push(format!("    {line}"));
        }

        lines.push("    end".to_owned());
    }

    lines.join("\n")
}

fn render_mermaid_package(
    manifest: &FeatureManifest,
    include_private: bool,
    package_prefix: Option<&str>,
) -> String {
    let visible_features = manifest
        .ordered_features()
        .into_iter()
        .filter(|feature| include_private || feature.metadata.public)
        .collect::<Vec<_>>();

    if visible_features.is_empty() {
        return "graph TD\n    empty[\"No public features declared\"]".to_owned();
    }

    let visible_names = visible_features
        .iter()
        .map(|feature| feature.name.as_str())
        .collect::<BTreeSet<_>>();
    let mut lines = vec!["graph TD".to_owned()];

    if visible_features
        .iter()
        .any(|feature| feature.default_enabled)
    {
        lines.push(format!(
            "    {}[\"default\"]",
            default_node_id(package_prefix)
        ));
    }

    for feature in &visible_features {
        lines.push(format!(
            "    {}[\"{}\"]",
            feature_node_id(package_prefix, &feature.name),
            escape_mermaid_label(&feature_label(feature)),
        ));
    }

    let mut external_nodes = BTreeSet::new();

    for feature in &visible_features {
        if feature.default_enabled {
            lines.push(format!(
                "    {} --> {}",
                default_node_id(package_prefix),
                feature_node_id(package_prefix, &feature.name)
            ));
        }

        for reference in &feature.enables {
            if let Some(local_feature_name) = reference.local_feature_name() {
                if visible_names.contains(local_feature_name) {
                    lines.push(format!(
                        "    {} --> {}",
                        feature_node_id(package_prefix, &feature.name),
                        feature_node_id(package_prefix, local_feature_name)
                    ));
                    continue;
                }
            }

            let external_id = reference_node_id(package_prefix, reference);
            if external_nodes.insert(external_id.clone()) {
                lines.push(format!(
                    "    {}[\"{}\"]",
                    external_id,
                    escape_mermaid_label(&reference.to_string())
                ));
            }
            lines.push(format!(
                "    {} --> {}",
                feature_node_id(package_prefix, &feature.name),
                external_id
            ));
        }
    }

    lines.join("\n")
}

fn feature_label(feature: &Feature) -> String {
    let status = status_summary(&feature.metadata);
    if feature.default_enabled {
        format!("{}\\n{}, default", feature.name, status)
    } else {
        format!("{}\\n{}", feature.name, status)
    }
}

fn feature_node_id(package_prefix: Option<&str>, name: &str) -> String {
    prefixed_node_id(package_prefix, "feature", name)
}

fn reference_node_id(package_prefix: Option<&str>, reference: &FeatureRef) -> String {
    prefixed_node_id(package_prefix, "ref", &reference.to_string())
}

fn default_node_id(package_prefix: Option<&str>) -> String {
    match package_prefix {
        Some(prefix) => format!("default_{prefix}"),
        None => "default_".to_owned(),
    }
}

fn prefixed_node_id(package_prefix: Option<&str>, kind: &str, raw: &str) -> String {
    match package_prefix {
        Some(prefix) => format!("{kind}_{prefix}_{}", sanitize_id(raw)),
        None => format!("{kind}_{}", sanitize_id(raw)),
    }
}