feat: add man pages and shell completions

Cargo.toml

@@ -20,6 +20,12 @@ dirs = "6.0.0"
 serde = { version = "1.0.217", features = ["derive"] }
 toml = "0.8.19"
 
+[build-dependencies]
+clap = { version = "4.5.27", features = ["derive"] }
+clap_complete = "4.5.32"
+clap_mangen = "0.2.23"
+serde = { version = "1.0.217", features = ["derive"] }
+
 [profile.release]
 strip = true
 opt-level = 3

build.rs

@@ -0,0 +1,69 @@
+#[allow(dead_code)]
+#[path = "src/color.rs"]
+mod color;
+
+#[allow(dead_code)]
+#[path = "src/position.rs"]
+mod position;
+
+#[path = "src/cli/args.rs"]
+mod args;
+
+use std::error::Error;
+use std::fs;
+use std::path::PathBuf;
+
+use clap::{Command, CommandFactory};
+use clap_complete::generate_to;
+use clap_complete::Shell::{Bash, Fish, Zsh};
+use clap_mangen::Man;
+
+fn generate_man_pages(name: &str, cmd: &Command) -> Result<(), Box<dyn Error>> {
+    let man_dir = PathBuf::from(env!("CARGO_MANIFEST_DIR")).join("target/man");
+    let mut buffer = Vec::default();
+
+    Man::new(cmd.clone()).render(&mut buffer)?;
+    fs::create_dir_all(&man_dir)?;
+    fs::write(man_dir.join(name.to_owned() + ".1"), buffer)?;
+
+    for subcommand in cmd.get_subcommands() {
+        let mut buffer = Vec::default();
+
+        Man::new(subcommand.clone()).render(&mut buffer)?;
+
+        fs::write(
+            man_dir.join(name.to_owned() + "-" + subcommand.get_name() + ".1"),
+            buffer,
+        )?;
+    }
+
+    Ok(())
+}
+
+fn generate_shell_completions(name: &str, mut cmd: Command) -> Result<(), Box<dyn Error>> {
+    let comp_dir = PathBuf::from(env!("CARGO_MANIFEST_DIR")).join("target/completions");
+
+    fs::create_dir_all(&comp_dir)?;
+
+    for shell in [Bash, Fish, Zsh] {
+        generate_to(shell, &mut cmd, name, &comp_dir)?;
+    }
+
+    Ok(())
+}
+
+fn generate(name: &str, mut cmd: Command) {
+    cmd.set_bin_name(name);
+
+    if let Err(err) = generate_man_pages(name, &cmd) {
+        println!("cargo::warning=error generating man page for {name}: {err}");
+    }
+
+    if let Err(err) = generate_shell_completions(name, cmd) {
+        println!("cargo::warning=error generating completions for {name}: {err}");
+    }
+}
+
+fn main() {
+    generate("clock-rs", args::Args::command());
+}

src/cli.rs → src/cli/args.rs

@@ -1,4 +1,4 @@
-use crate::{color::Color, config::Config, position::Position};
+use crate::{color::Color, position::Position};
 
 use clap::{
     builder::styling::{AnsiColor, Effects, Styles},
@@ -69,38 +69,3 @@ pub struct TimerArgs {
     #[clap(long, short)]
     pub kill: bool,
 }
-
-impl Args {
-    pub fn overwrite(self, config: &mut Config) {
-        if let Some(color) = self.color {
-            config.general.color = color;
-        }
-        if let Some(interval) = self.interval {
-            config.general.interval = interval;
-        }
-        if let Some(x_pos) = self.x_pos {
-            config.position.x = x_pos;
-        }
-        if let Some(y_pos) = self.y_pos {
-            config.position.y = y_pos;
-        }
-        if self.blink {
-            config.general.blink = true;
-        }
-        if self.bold {
-            config.general.bold = true;
-        }
-        if let Some(fmt) = self.fmt {
-            config.date.fmt = fmt;
-        }
-        if self.use_12h {
-            config.date.use_12h = true;
-        }
-        if self.utc {
-            config.date.utc = true;
-        }
-        if self.hide_seconds {
-            config.date.hide_seconds = true;
-        }
-    }
-}

src/cli/mod.rs

@@ -0,0 +1,38 @@
+pub mod args;
+
+use crate::config::Config;
+
+impl args::Args {
+    pub fn overwrite(self, config: &mut Config) {
+        if let Some(color) = self.color {
+            config.general.color = color;
+        }
+        if let Some(interval) = self.interval {
+            config.general.interval = interval;
+        }
+        if let Some(x_pos) = self.x_pos {
+            config.position.x = x_pos;
+        }
+        if let Some(y_pos) = self.y_pos {
+            config.position.y = y_pos;
+        }
+        if self.blink {
+            config.general.blink = true;
+        }
+        if self.bold {
+            config.general.bold = true;
+        }
+        if let Some(fmt) = self.fmt {
+            config.date.fmt = fmt;
+        }
+        if self.use_12h {
+            config.date.use_12h = true;
+        }
+        if self.utc {
+            config.date.utc = true;
+        }
+        if self.hide_seconds {
+            config.date.hide_seconds = true;
+        }
+    }
+}

src/state.rs

@@ -12,7 +12,7 @@ use crossterm::{
 };
 
 use crate::{
-    cli::{Args, Mode},
+    cli::args::{Args, Mode},
     clock::{counter::Counter, counter::CounterType, mode::ClockMode, time_zone::TimeZone, Clock},
     config::Config,
     error::Error,