pugio 0.1.5

A command-line dependency binary size graph visualisation tool
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
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228

use std::str::FromStr;

use clap::Args;
#[cfg(feature = "config")]
use serde::de;

use crate::{NodeColoringGradient, NodeColoringScheme};

// Obfuscate type for clap
type OptScheme = Option<NodeColoringScheme>;

#[cfg_attr(
    feature = "config",
    derive(serde::Deserialize),
    serde(rename_all = "kebab-case")
)]
#[derive(Args)]
pub struct Config {
    /// Package to inspect
    #[arg(short, long)]
    pub package: Option<String>,

    /// Binary to inspect
    #[arg(long = "bin")]
    pub binary: Option<String>,

    /// Space or comma separated list of features to activate
    #[arg(short = 'F', long)]
    pub features: Option<String>,

    /// Activate all available features
    #[arg(long)]
    #[cfg_attr(feature = "config", serde(default))]
    pub all_features: bool,

    /// Do not activate the `default` feature
    #[arg(long)]
    #[cfg_attr(feature = "config", serde(default))]
    pub no_default_features: bool,

    /// Build artifacts in release mode, with optimizations
    #[arg(long)]
    #[cfg_attr(feature = "config", serde(default))]
    pub release: bool,

    /// Exclude dependency names matching the regex patterns
    #[cfg(feature = "regex")]
    #[arg(short = 'E', long)]
    pub excludes: Option<Vec<String>>,

    /// Exclude dependency names matching the prefixes
    #[cfg(not(feature = "regex"))]
    #[arg(short = 'E', long)]
    pub excludes: Option<Vec<String>>,

    /// Change root to the unique depndency name matching the regex pattern
    #[cfg(feature = "regex")]
    #[arg(short = 'R', long)]
    pub root: Option<String>,

    /// Change root to the unique depndency name matching the prefix
    #[cfg(not(feature = "regex"))]
    #[arg(short = 'R', long)]
    pub root: Option<String>,

    /// Add std standalone node
    #[arg(long)]
    #[cfg_attr(feature = "config", serde(default))]
    pub std: bool,

    /// Color scheme of nodes
    ///  - "cum-sum": cumulative sum of the size of a node and its dependencies (default)
    ///  - "dep-count": dependency count; number of transitive dependency relations from a node
    ///  - "rev-dep-count": reverse dependency count; number of paths from the root to a node
    ///  - "none"
    #[cfg_attr(
        feature = "config",
        serde(deserialize_with = "de_scheme", default = "default_opt_scheme")
    )]
    #[arg(short, long, default_value = "cum-sum", hide_default_value = true, value_parser = parse_scheme, verbatim_doc_comment)]
    pub scheme: OptScheme,

    /// Color gradient of nodes
    ///  - "reds" (default), "oranges", "purples", "greens", "blues"
    ///  - custom CSS gradient format, e.g. "#fff, 75%, #00f"
    #[arg(short, long, verbatim_doc_comment)]
    pub gradient: Option<NodeColoringGradient>,

    /// Color gamma of nodes, between 0.0 and 1.0
    ///  default is scheme-specific
    #[arg(long, verbatim_doc_comment)]
    pub gamma: Option<f32>,

    /// Remove nodes that have cumulative sum below threshold
    ///  - human readable byte format, e.g. "21KiB", "69 KB"
    ///  - "non-zero"
    #[arg(short, long, value_parser = parse_threshold, verbatim_doc_comment)]
    #[cfg_attr(feature = "config", serde(deserialize_with = "de_threshold", default))]
    pub threshold: Option<usize>,

    /// Remove nodes that are more than max depth deep
    #[arg(short = 'd', long)]
    pub max_depth: Option<usize>,

    /// Inverse color gradient
    #[arg(long)]
    #[cfg_attr(feature = "config", serde(default))]
    pub inverse_gradient: bool,

    /// Dark mode for output svg file
    #[arg(long)]
    #[cfg_attr(feature = "config", serde(default))]
    pub dark_mode: bool,

    /// Scale factor for output svg file
    #[arg(long)]
    pub scale_factor: Option<f32>,

    /// Separation factor for output svg file
    #[arg(long)]
    pub separation_factor: Option<f32>,

    /// Highlight parts of the graph when hovered for output svg file
    ///  - "dep": all dependencies
    ///  - "rev-dep": all reverse dependencies
    ///    requires modern browser for `:has()` CSS pseudo-class support
    #[arg(long, value_parser = parse_highlight, verbatim_doc_comment)]
    #[cfg_attr(feature = "config", serde(deserialize_with = "de_highlight", default))]
    pub highlight: Option<bool>,

    /// Highlight amount for output svg file, between 0.0 and 1.0
    ///  default: 0.5
    #[arg(long, verbatim_doc_comment)]
    pub highlight_amount: Option<f32>,

    /// Custom node label formatting template
    ///  default: "{short}"
    #[arg(long, verbatim_doc_comment)]
    pub node_label_template: Option<String>,

    /// Custom node tooltip formatting template
    ///  default: "{full}\n{size_binary}"
    #[arg(long, verbatim_doc_comment)]
    pub node_tooltip_template: Option<String>,

    /// Custom edge label formatting template
    #[arg(long, verbatim_doc_comment)]
    pub edge_label_template: Option<String>,

    /// Custom edge tooltip formatting template
    ///  default: "{source} -> {target}"
    #[arg(long, verbatim_doc_comment)]
    pub edge_tooltip_template: Option<String>,

    /// Dot output file only
    #[arg(long)]
    #[cfg_attr(feature = "config", serde(default))]
    pub dot_only: bool,

    /// Output filename, default is output.*
    #[arg(short, long)]
    pub output: Option<String>,

    /// Do not open output svg file
    #[arg(long)]
    #[cfg_attr(feature = "config", serde(default))]
    pub no_open: bool,
}

#[cfg(feature = "config")]
fn default_opt_scheme() -> OptScheme {
    Some(NodeColoringScheme::CumSum)
}

#[cfg(feature = "config")]
fn de_scheme<'de, D: de::Deserializer<'de>>(d: D) -> Result<Option<NodeColoringScheme>, D::Error> {
    let str: String = de::Deserialize::deserialize(d)?;
    parse_scheme(&str).map_err(de::Error::custom)
}

#[cfg(feature = "config")]
fn de_highlight<'de, D: de::Deserializer<'de>>(d: D) -> Result<Option<bool>, D::Error> {
    let str: String = de::Deserialize::deserialize(d)?;
    parse_highlight(&str)
        .map(Option::Some)
        .map_err(de::Error::custom)
}

#[cfg(feature = "config")]
fn de_threshold<'de, D: de::Deserializer<'de>>(d: D) -> Result<Option<usize>, D::Error> {
    #[derive(serde::Deserialize)]
    #[serde(untagged)]
    enum Threshold {
        Usize(usize),
        String(String),
    }

    let threshold: Threshold = de::Deserialize::deserialize(d)?;
    match threshold {
        Threshold::Usize(u) => Ok(Some(u)),
        Threshold::String(s) => parse_threshold(&s)
            .map(Option::Some)
            .map_err(de::Error::custom),
    }
}

fn parse_scheme(s: &str) -> Result<Option<NodeColoringScheme>, strum::ParseError> {
    match s {
        "none" => Ok(None),
        _ => Ok(Some(NodeColoringScheme::from_str(s)?)),
    }
}

fn parse_highlight(h: &str) -> Result<bool, &'static str> {
    match h {
        "dep" => Ok(true),
        "rev-dep" => Ok(false),
        _ => Err("invalid highlight value"),
    }
}

fn parse_threshold(t: &str) -> Result<usize, parse_size::Error> {
    if t == "non-zero" {
        Ok(1)
    } else {
        parse_size::parse_size(t).map(|b| b as usize)
    }
}