bin: completions (#1035)

* bin: completions

* fix powershell

Author: BrettMayson

Cargo.lock

@@ -35,6 +35,7 @@ hemtt-wss = { path = "../libs/wss" }
 arma3-wiki = { workspace = true }
 byteorder = { workspace = true }
 clap = { workspace = true, features = ["derive"] }
+clap_complete = "4.5.55"
 dialoguer = "0.11.0"
 dirs = { workspace = true }
 fs_extra = "1.3.0"

bin/Cargo.toml

@@ -0,0 +1,112 @@
+use std::{
+    fs::{File, OpenOptions},
+    io::{Read, Write},
+    path::PathBuf,
+};
+
+use clap::CommandFactory;
+use clap_complete::{Shell, generate_to};
+
+use crate::{Cli, Error, report::Report};
+
+#[derive(clap::Parser)]
+#[command(arg_required_else_help = true)]
+/// Manage HEMTT features installed on your system
+pub struct Command {
+    #[command(subcommand)]
+    commands: Subcommands,
+
+    #[clap(flatten)]
+    global: crate::GlobalArgs,
+}
+
+#[derive(clap::Subcommand)]
+enum Subcommands {
+    /// Install shell completions
+    Completions {
+        #[arg(value_enum)]
+        shell: Shell,
+    },
+    #[cfg(windows)]
+    Powershell,
+}
+
+/// Execute the manage command
+///
+/// # Errors
+/// Will not return an error
+pub fn execute(cmd: &Command) -> Result<Report, Error> {
+    match &cmd.commands {
+        Subcommands::Completions { shell } => {
+            clap_complete::generate(
+                *shell,
+                &mut Cli::command(),
+                env!("CARGO_PKG_NAME"),
+                &mut std::io::stdout(),
+            );
+        }
+        #[cfg(windows)]
+        Subcommands::Powershell => {
+            install_powershell_completions_sourced()?;
+        }
+    }
+    std::process::exit(0);
+}
+
+#[allow(dead_code)]
+fn install_powershell_completions_sourced() -> std::io::Result<()> {
+    let script_path = dirs::config_dir()
+        .expect("Could not locate config directory (APPDATA)")
+        .join("hemtt")
+        .join("_hemtt.ps1");
+
+    let script_dir = script_path
+        .parent()
+        .expect("Could not determine script directory");
+    std::fs::create_dir_all(script_dir)?;
+
+    generate_to(
+        Shell::PowerShell,
+        &mut Cli::command(),
+        env!("CARGO_PKG_NAME"),
+        script_dir,
+    )?;
+
+    let profile_path =
+        get_powershell_profile_path().expect("Could not determine PowerShell profile path");
+
+    if let Some(parent) = profile_path.parent() {
+        std::fs::create_dir_all(parent)?;
+    }
+    if !profile_path.exists() {
+        File::create(&profile_path)?;
+    }
+
+    let import_line = r#". "$env:APPDATA\hemtt\_hemtt.ps1""#;
+
+    let mut profile_content = String::new();
+    File::open(&profile_path)?.read_to_string(&mut profile_content)?;
+
+    if profile_content.contains(import_line) {
+        info!("PowerShell completions already configured in your profile.");
+        return Ok(());
+    }
+    let mut file = OpenOptions::new().append(true).open(&profile_path)?;
+    writeln!(
+        file,
+        "\n# hemtt manage completions powershell\n{import_line}"
+    )?;
+
+    debug!("Completion script saved to: {}", script_path.display());
+    info!("Restart PowerShell or run:  . $PROFILE");
+
+    Ok(())
+}
+
+fn get_powershell_profile_path() -> Option<PathBuf> {
+    dirs::home_dir().map(|home| {
+        home.join("Documents")
+            .join("WindowsPowerShell")
+            .join("Microsoft.PowerShell_profile.ps1")
+    })
+}

bin/src/commands/manage.rs

@@ -4,6 +4,7 @@ pub mod check;
 pub mod dev;
 pub mod launch;
 pub mod localization;
+pub mod manage;
 pub mod new;
 pub mod release;
 pub mod script;

bin/src/commands/mod.rs

@@ -29,5 +29,5 @@ enum Subcommands {
 pub fn execute(_cmd: &Command) -> Result<Report, Error> {
     // TODO right now just assumes force-pull since that's the only subcommand
     let _ = Database::empty(true);
-    Ok(Report::new())
+    std::process::exit(0);
 }

bin/src/commands/wiki.rs

@@ -61,6 +61,7 @@ enum Commands {
     Utils(commands::utils::Command),
     Value(commands::value::Command),
     Wiki(commands::wiki::Command),
+    Manage(commands::manage::Command),
     #[cfg(windows)]
     Photoshoot(commands::photoshoot::Command),
 }
@@ -99,7 +100,13 @@ pub fn execute(cli: &Cli) -> Result<(), Error> {
             cli.global.verbosity,
             !matches!(
                 cli.command,
-                Some(Commands::Utils(_) | Commands::Wiki(_) | Commands::New(_) | Commands::Book(_))
+                Some(
+                    Commands::Utils(_)
+                        | Commands::Wiki(_)
+                        | Commands::New(_)
+                        | Commands::Book(_)
+                        | Commands::Manage(_)
+                )
             ),
         )?;
     }
@@ -136,6 +143,7 @@ pub fn execute(cli: &Cli) -> Result<(), Error> {
         Commands::Utils(cmd) => commands::utils::execute(cmd),
         Commands::Value(cmd) => commands::value::execute(cmd),
         Commands::Wiki(cmd) => commands::wiki::execute(cmd),
+        Commands::Manage(cmd) => commands::manage::execute(cmd),
         #[cfg(windows)]
         Commands::Photoshoot(cmd) => commands::photoshoot::execute(cmd),
     };

bin/src/lib.rs

@@ -54,12 +54,23 @@ mkdir -p "$binaryLocation"
 if ! echo "$PATH" | grep -q "$binaryLocation"; then
     config_files="$HOME/.bashrc $HOME/.bash_profile $HOME/.zshrc $HOME/.profile"
     for config in $config_files; do
+        addedByHEMTT=false
         if [ -f "$config" ]; then
             if ! grep -q -s "export PATH=$binaryLocation:\$PATH" "$config"; then
                 echo "Appending $binaryLocation to $config"
                 echo "" >>"$config"
                 echo "# Added by HEMTT" >>"$config"
                 echo "export PATH=$binaryLocation:\$PATH" >>"$config"
+                addedByHEMTT=true
+                fi
+            fi
+            if ! grep -q -s "source <(hemtt manage completions" "$config"; then
+                echo "Adding completions to $config"
+                echo "" >>"$config"
+                if [ "$addedByHEMTT" = false ]; then
+                    echo "# Added by HEMTT" >>"$config"
+                fi
+                echo "source <(hemtt manage completions \$(basename \$SHELL))" >>"$config"
             fi
         fi
     done
@@ -73,4 +84,9 @@ else
     exit 1
 fi
 
+if ! "$binaryLocation/hemtt" --version >/dev/null 2>&1; then
+    echo "Error: HEMTT binary was installed, but is not compatible with your system"
+    exit 1
+fi
+
 echo "Installation complete. You can run HEMTT using 'hemtt'"