feat: add config file option

Add new Config struct.

Rename images to examples and add config.toml example.

Author: my4ng

Cargo.lock

@@ -37,9 +37,20 @@ tinytemplate = "1.2"
 version = "0.1"
 optional = true
 
+[dependencies.serde_with]
+version = "3.16"
+optional = true
+
+[dependencies.toml]
+version = "0.9"
+default-features = false
+features = ["std", "serde", "parse"]
+optional = true
+
 [features]
-default = ["regex"]
+default = ["regex", "config"]
 regex = ["dep:regex-lite"]
+config = ["dep:serde_with", "dep:toml"]
 
 [profile.release]
 lto = "thin"

Cargo.toml

@@ -8,15 +8,15 @@ It is important to note that the sizes is and will always be only an *estimation
 
 ## Examples
 
-`pugio --release --gradient blues -t non-zero --scale-factor 1.2 --separation-factor 0.8 -o images/pugio.svg`
+`pugio -c examples/config.toml`
 
 ![pugio](images/pugio.svg)
 
-`pugio --bin rg --release --scheme dep-count --gradient purples -R "grep v0.4.1" -d 2 -t 1KiB --gamma 0.5 --dark-mode --std -o images/ripgrep.svg`
+`pugio --bin rg --release --scheme dep-count --gradient purples -R "grep v0.4.1" -d 2 -t 1KiB --gamma 0.5 --dark-mode --std -o examples/ripgrep.svg`
 
 ![ripgrep](images/ripgrep.svg)
 
-`pugio --release --node-label-template "{short}\n{value_binary}" -E 'clap|rand' -g reds -t non-zero --dark-mode --std -o images/hyperfine.svg`
+`pugio --release --node-label-template "{short}\n{value_binary}" -E 'clap|rand' -g reds -t non-zero --dark-mode --std -o examples/hyperfine.svg`
 
 ![hyperfine](images/hyperfine.svg)
 
@@ -44,8 +44,9 @@ To customise enabled Cargo features, add the options:
 
 ## Feature flags
 
-- `default`: `regex`
-- `regex`: support regex pattern matching in options
+- `default`: `regex`, `config`
+- `regex`: support regex pattern matching in options: [regex-lite syntax](https://docs.rs/regex-lite/latest/regex_lite/index.html#syntax)
+- `config`: support TOML config file
 
 ## Planned Features
 
@@ -62,6 +63,9 @@ A command-line dependency binary size graph visualisation tool
 Usage: pugio [OPTIONS]
 
 Options:
+  -c, --config <CONFIG_FILE>
+          Config TOML file path, "-" for stdin
+           disables all other options
   -p, --package <PACKAGE>
           Package to inspect
       --bin <BINARY>

README.md

@@ -0,0 +1,6 @@
+release = true
+gradient = "blues"
+threshold = "non-zero"
+scale-factor = 1.2
+separation-factor = 0.8
+output = "examples/pugio.svg"

examples/config.toml

@@ -7,7 +7,7 @@ use anyhow::{Context, bail};
 use petgraph::{graph::NodeIndex, prelude::StableGraph};
 use serde_json::Value;
 
-use crate::{Args, graph::NodeWeight};
+use crate::{config::Config, graph::NodeWeight};
 
 #[derive(Debug, Default)]
 pub struct CargoOptions {
@@ -19,8 +19,8 @@ pub struct CargoOptions {
     pub release: bool,
 }
 
-impl From<&Args> for CargoOptions {
-    fn from(value: &Args) -> Self {
+impl From<&Config> for CargoOptions {
+    fn from(value: &Config) -> Self {
         Self {
             package: value.package.clone(),
             binary: value.binary.clone(),

images/hyperfine.svg examples/hyperfine.svgimages/hyperfine.svg renamed to examples/hyperfine.svg

@@ -0,0 +1,200 @@
+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>,
+
+    /// 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_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) if s == "non-zero" => Ok(Some(1)),
+        Threshold::String(s) => parse_size::parse_size(s)
+            .map(|b| Some(b as usize))
+            .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_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)
+    }
+}