review me

Author: Sk7Str1p3

src/cli.rs

@@ -6,12 +6,16 @@ use clap::builder::PossibleValuesParser;
 use clap::builder::TypedValueParser as _;
 use clap::{value_parser, Args, Command, Parser, ValueHint};
 use clap_complete::{generate, Generator, Shell};
+use merge::Merge;
 use num_format::CustomFormat;
 use onefetch_image::ImageProtocol;
 use onefetch_manifest::ManifestType;
 use regex::Regex;
-use serde::Serialize;
+use serde::de::Visitor;
+use serde::{Deserialize, Serialize, Serializer};
+use serde_json::error;
 use std::env;
+use std::fmt::Write;
 use std::io;
 use std::path::PathBuf;
 use std::str::FromStr;
@@ -20,12 +24,17 @@ use strum::IntoEnumIterator;
 const COLOR_RESOLUTIONS: [&str; 5] = ["16", "32", "64", "128", "256"];
 pub const NO_BOTS_DEFAULT_REGEX_PATTERN: &str = r"(?:-|\s)[Bb]ot$|\[[Bb]ot\]";
 
-#[derive(Clone, Debug, Parser, PartialEq, Eq)]
+#[derive(Clone, Debug, Parser, PartialEq, Eq, Deserialize, Serialize, Merge)]
 #[command(version, about)]
 pub struct CliOptions {
     /// Run as if onefetch was started in <input> instead of the current working directory
     #[arg(default_value = ".", hide_default_value = true, value_hint = ValueHint::DirPath)]
+    #[merge(skip)]
     pub input: PathBuf,
+    /// Specify custom path for config file. Default is $XDG_CONFIG_HOME/onefetch/config.toml
+    #[arg(long, value_hint = ValueHint::FilePath)]
+    #[merge(skip)]
+    pub config_path: Option<PathBuf>,
     #[command(flatten)]
     pub info: InfoCliOptions,
     #[command(flatten)]
@@ -42,7 +51,7 @@ pub struct CliOptions {
     pub other: OtherCliOptions,
 }
 
-#[derive(Clone, Debug, Args, PartialEq, Eq)]
+#[derive(Clone, Debug, Args, PartialEq, Eq, Merge, Deserialize, Serialize)]
 #[command(next_help_heading = "INFO")]
 pub struct InfoCliOptions {
     /// Allows you to disable FIELD(s) from appearing in the output
@@ -54,18 +63,23 @@ pub struct InfoCliOptions {
         value_enum,
         value_name = "FIELD"
     )]
+    #[merge(strategy = overwrite_vector)]
     pub disabled_fields: Vec<InfoType>,
     /// Hides the title
     #[arg(long)]
+    #[merge(strategy = merge::bool::overwrite_false)]
     pub no_title: bool,
     /// Maximum NUM of authors to be shown
     #[arg(long, default_value_t = 3usize, value_name = "NUM")]
+    #[merge(strategy = overwrite)]
     pub number_of_authors: usize,
     /// Maximum NUM of languages to be shown
     #[arg(long, default_value_t = 6usize, value_name = "NUM")]
+    #[merge(strategy = overwrite)]
     pub number_of_languages: usize,
     /// Maximum NUM of file churns to be shown
     #[arg(long, default_value_t = 3usize, value_name = "NUM")]
+    #[merge(strategy = overwrite)]
     pub number_of_file_churns: usize,
     /// Minimum NUM of commits from HEAD used to compute the churn summary
     ///
@@ -75,6 +89,7 @@ pub struct InfoCliOptions {
     pub churn_pool_size: Option<usize>,
     /// Ignore all files & directories matching EXCLUDE
     #[arg(long, short, num_args = 1..)]
+    #[merge(strategy = overwrite_vector)]
     pub exclude: Vec<String>,
     /// Exclude [bot] commits. Use <REGEX> to override the default pattern
     #[arg(
@@ -84,21 +99,27 @@ pub struct InfoCliOptions {
         default_missing_value = NO_BOTS_DEFAULT_REGEX_PATTERN,
         value_name = "REGEX"
     )]
+    #[merge(strategy = overwrite)]
     pub no_bots: Option<MyRegex>,
     /// Ignores merge commits
     #[arg(long)]
+    #[merge(strategy = merge::bool::overwrite_false)]
     pub no_merges: bool,
     /// Show the email address of each author
     #[arg(long, short = 'E')]
+    #[merge(strategy = merge::bool::overwrite_false)]
     pub email: bool,
     /// Display repository URL as HTTP
     #[arg(long)]
+    #[merge(strategy = merge::bool::overwrite_false)]
     pub http_url: bool,
     /// Hide token in repository URL
     #[arg(long)]
+    #[merge(strategy = merge::bool::overwrite_false)]
     pub hide_token: bool,
     /// Count hidden files and directories
     #[arg(long)]
+    #[merge(strategy = merge::bool::overwrite_false)]
     pub include_hidden: bool,
     /// Filters output by language type
     #[arg(
@@ -108,10 +129,11 @@ pub struct InfoCliOptions {
         short = 'T',
         value_enum,
     )]
+    #[merge(strategy = overwrite_vector)]
     pub r#type: Vec<LanguageType>,
 }
 
-#[derive(Clone, Debug, Args, PartialEq, Eq)]
+#[derive(Clone, Debug, Args, PartialEq, Eq, Merge, Deserialize, Serialize)]
 #[command(next_help_heading = "ASCII")]
 pub struct AsciiCliOptions {
     /// Takes a non-empty STRING as input to replace the ASCII logo
@@ -131,6 +153,7 @@ pub struct AsciiCliOptions {
         short = 'c',
         value_parser = value_parser!(u8).range(..16),
     )]
+    #[merge(strategy = overwrite_vector)]
     pub ascii_colors: Vec<u8>,
     /// Which LANGUAGE's ascii art to print
     #[arg(
@@ -140,22 +163,25 @@ pub struct AsciiCliOptions {
         value_enum,
         hide_possible_values = true
     )]
+    #[serde(skip)]
     pub ascii_language: Option<Language>,
     /// Specify when to use true color
     ///
     /// If set to auto: true color will be enabled if supported by the terminal
     #[arg(long, default_value = "auto", value_name = "WHEN", value_enum)]
+    #[merge(strategy = overwrite)]
     pub true_color: When,
 }
 
-#[derive(Clone, Debug, Args, PartialEq, Eq)]
+#[derive(Clone, Debug, Args, PartialEq, Eq, Merge, Deserialize, Serialize)]
 #[command(next_help_heading = "IMAGE")]
 pub struct ImageCliOptions {
     /// Path to the IMAGE file
     #[arg(long, short, value_hint = ValueHint::FilePath)]
     pub image: Option<PathBuf>,
     /// Which image PROTOCOL to use
     #[arg(long, value_enum, requires = "image", value_name = "PROTOCOL")]
+    #[serde(skip)]
     pub image_protocol: Option<ImageProtocol>,
     /// VALUE of color resolution to use with SIXEL backend
     #[arg(
@@ -166,10 +192,11 @@ pub struct ImageCliOptions {
         value_parser = PossibleValuesParser::new(COLOR_RESOLUTIONS)
             .map(|s| s.parse::<usize>().unwrap())
     )]
+    #[merge(strategy = overwrite)]
     pub color_resolution: usize,
 }
 
-#[derive(Clone, Debug, Args, PartialEq, Eq)]
+#[derive(Clone, Debug, Args, PartialEq, Eq, Merge, Deserialize, Serialize)]
 #[command(next_help_heading = "TEXT FORMATTING")]
 pub struct TextForamttingCliOptions {
     /// Changes the text colors (X X X...)
@@ -186,59 +213,71 @@ pub struct TextForamttingCliOptions {
         value_parser = value_parser!(u8).range(..16),
         num_args = 1..=6
     )]
+    #[merge(strategy = overwrite_vector)]
     pub text_colors: Vec<u8>,
     /// Use ISO 8601 formatted timestamps
     #[arg(long, short = 'z')]
+    #[merge(strategy = merge::bool::overwrite_false)]
     pub iso_time: bool,
     /// Which thousands SEPARATOR to use
     #[arg(long, value_name = "SEPARATOR", default_value = "plain", value_enum)]
+    #[merge(strategy = overwrite)]
     pub number_separator: NumberSeparator,
     /// Turns off bold formatting
     #[arg(long)]
+    #[merge(strategy = merge::bool::overwrite_false)]
     pub no_bold: bool,
 }
-#[derive(Clone, Debug, Args, PartialEq, Eq, Default)]
+#[derive(Clone, Debug, Args, PartialEq, Eq, Default, Merge, Deserialize, Serialize)]
 #[command(next_help_heading = "VISUALS")]
 pub struct VisualsCliOptions {
     /// Hides the color palette
     #[arg(long)]
+    #[merge(strategy = merge::bool::overwrite_false)]
     pub no_color_palette: bool,
     /// Hides the ascii art or image if provided
     #[arg(long)]
+    #[merge(strategy = merge::bool::overwrite_false)]
     pub no_art: bool,
     /// Use Nerd Font icons
     ///
     /// Replaces language chips with Nerd Font icons
     #[arg(long)]
+    #[merge(strategy = merge::bool::overwrite_false)]
     pub nerd_fonts: bool,
 }
 
-#[derive(Clone, Debug, Args, PartialEq, Eq, Default)]
+#[derive(Clone, Debug, Args, PartialEq, Eq, Default, Merge, Deserialize, Serialize)]
 #[command(next_help_heading = "DEVELOPER")]
 pub struct DeveloperCliOptions {
     /// Outputs Onefetch in a specific format
     #[arg(long, short, value_name = "FORMAT", value_enum)]
+    #[serde(skip)]
     pub output: Option<SerializationFormat>,
     /// If provided, outputs the completion file for given SHELL
     #[arg(long = "generate", value_name = "SHELL", value_enum)]
+    #[serde(skip)]
     pub completion: Option<Shell>,
 }
 
-#[derive(Clone, Debug, Args, PartialEq, Eq, Default)]
+#[derive(Clone, Debug, Args, PartialEq, Eq, Default, Merge, Deserialize, Serialize)]
 #[command(next_help_heading = "OTHER")]
 pub struct OtherCliOptions {
     /// Prints out supported languages
     #[arg(long, short)]
+    #[merge(strategy = merge::bool::overwrite_false)]
     pub languages: bool,
     /// Prints out supported package managers
     #[arg(long, short)]
+    #[merge(strategy = merge::bool::overwrite_false)]
     pub package_managers: bool,
 }
 
 impl Default for CliOptions {
     fn default() -> CliOptions {
         CliOptions {
             input: PathBuf::from("."),
+            config_path: Default::default(),
             info: InfoCliOptions::default(),
             text_formatting: TextForamttingCliOptions::default(),
             visuals: VisualsCliOptions::default(),
@@ -302,6 +341,15 @@ impl Default for ImageCliOptions {
     }
 }
 
+pub fn overwrite<T>(left: &mut T, right: T) {
+    *left = right; 
+}
+
+pub fn overwrite_vector<T>(left: &mut Vec<T>, mut right: Vec<T>) {
+    left.clear();
+    left.append(&mut right);
+}
+
 pub fn print_supported_languages() -> Result<()> {
     for l in Language::iter() {
         println!("{l}");
@@ -337,14 +385,14 @@ pub fn print_completions<G: Generator>(gen: G, cmd: &mut Command) {
     generate(gen, cmd, cmd.get_name().to_string(), &mut io::stdout());
 }
 
-#[derive(clap::ValueEnum, Clone, PartialEq, Eq, Debug)]
+#[derive(clap::ValueEnum, Clone, PartialEq, Eq, Debug, Deserialize, Serialize)]
 pub enum When {
     Auto,
     Never,
     Always,
 }
 
-#[derive(clap::ValueEnum, Clone, PartialEq, Eq, Debug, Serialize, Copy)]
+#[derive(clap::ValueEnum, Clone, PartialEq, Eq, Debug, Serialize, Deserialize, Copy)]
 pub enum NumberSeparator {
     Plain,
     Comma,
@@ -463,3 +511,37 @@ impl FromStr for MyRegex {
         Ok(MyRegex(Regex::new(s)?))
     }
 }
+
+impl Serialize for MyRegex {
+    fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
+    where
+        S: Serializer,
+        {serializer.serialize_str(self.0.as_str())}  
+}
+
+pub struct RegVisitor;
+
+impl <'de>Visitor<'de> for RegVisitor {
+    type Value = MyRegex;
+    
+    fn expecting(&self, formatter: &mut std::fmt::Formatter) -> std::fmt::Result {
+        formatter.write_str("regex")
+    }
+
+    fn visit_str<E>(self, v: &str) -> Result<Self::Value, E>
+        where
+            E: serde::de::Error, {
+        match MyRegex::from_str(v) {
+            Ok(regex) => Ok(regex),
+            Err(error) => Err(serde::de::Error::custom(error))
+        }
+    }
+}
+
+impl <'de>Deserialize<'de> for MyRegex {
+    fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>
+        where
+            D: serde::Deserializer<'de>, {
+        deserializer.deserialize_str(RegVisitor)
+    }
+}

src/configuration.rs

@@ -0,0 +1,46 @@
+use anyhow::{anyhow, Result};
+use crate::cli::CliOptions;
+use dirs::config_dir;
+use merge::Merge;
+use std::{fs::{self, create_dir, File}, path::Path};
+use std::io::{BufReader, Read};
+
+pub fn read_cfg_file<P: AsRef<Path>>(path: &P) -> Result<CliOptions> {
+    let file = File::open(&path)?;
+    let mut buf_reader = BufReader::new(file);
+    let mut contents = String::new();
+    buf_reader.read_to_string(&mut contents)?;
+    Ok(toml::from_str(contents.as_str()).unwrap())
+}
+
+pub fn load_cfg<P: AsRef<Path>>(path: Option<&P>) -> Result<CliOptions> {
+    match path {
+        Some(config_path) => read_cfg_file(config_path),
+        None => {
+            let mut default_path = config_dir().unwrap();
+            default_path.push("/onefetch/config.toml");
+            if default_path.exists() {
+                read_cfg_file(&default_path)
+            } else {
+                create_dir(&default_path)?;
+                write_default_cfg(&default_path);
+                Err(anyhow!("Configuration file at {:?} does not exist!", default_path))
+            }
+        }
+    }
+}
+
+pub fn write_default_cfg<P: AsRef<Path>>(default_path: &P) {
+    let toml = toml::to_string(&CliOptions::default()).expect("Config should be serializable");
+    fs::write(default_path, toml).expect("Unable to write file");
+}
+
+pub fn populate(config: CliOptions) -> CliOptions{
+    match load_cfg(config.config_path.as_ref()) {
+        Ok(mut cfg) =>{
+            cfg.merge(config);
+            cfg
+        },
+        Err(_) => config
+    }
+}

src/info/langs/language.rs

@@ -1,6 +1,5 @@
 use crate::info::utils::info_field::InfoField;
 use owo_colors::OwoColorize;
-use serde::Serialize;
 use tokei;
 
 include!(concat!(env!("OUT_DIR"), "/language.rs"));

src/info/langs/language.tera

@@ -5,6 +5,7 @@ use owo_colors::{
 use std::fmt;
 use std::fmt::Write;
 use strum::EnumIter;
+use serde::{Deserialize,Serialize};
 
 pub struct Colors {
     basic_colors: Vec<DynColors>,
@@ -13,7 +14,7 @@ pub struct Colors {
 
 const DEFAULT_CHIP_ICON: char = '\u{25CF}';
 
-#[derive(Clone, PartialEq, Eq, Debug, clap::ValueEnum)]
+#[derive(Clone, PartialEq, Eq, Debug, clap::ValueEnum, Deserialize, Serialize)]
 pub enum LanguageType {
     Programming,
     Markup,