feat(cargo-shuttle): generate manpage

cargo-shuttle/Cargo.toml

@@ -20,6 +20,7 @@ cargo_metadata = { workspace = true }
 chrono = { workspace = true }
 clap = { workspace = true, features = ["env"] }
 clap_complete = "4.3.1"
+clap_mangen = "0.2.15"
 crossterm = { workspace = true }
 dialoguer = { version = "0.11.0", features = ["fuzzy-select"] }
 dirs = { workspace = true }

cargo-shuttle/README.md

@@ -102,7 +102,7 @@ Commands:
   clean       Remove cargo build artifacts in the shuttle environment
   login       Login to the shuttle platform
   logout      Log out of the shuttle platform
-  generate    Generate shell completions
+  generate    Generate shell completions and manpage
   feedback    Open an issue on GitHub and provide feedback
   help        Print this message or the help of the given subcommand(s)
 

cargo-shuttle/src/args.rs

@@ -131,14 +131,17 @@ pub enum Command {
     Login(LoginArgs),
     /// Log out of the Shuttle platform
     Logout(LogoutArgs),
-    /// Generate shell completions
+    /// Generate shell completions and manpage
     Generate {
         /// Which shell
-        #[arg(short, long, env, default_value_t = Shell::Bash)]
-        shell: Shell,
+        #[arg(short, long)]
+        shell: Option<Shell>,
         /// Output to a file (stdout by default)
         #[arg(short, long, env)]
         output: Option<PathBuf>,
+        /// Generate manpage to the standard output
+        #[arg(short, long)]
+        manpage: bool,
     },
     /// Open an issue on GitHub and provide feedback
     Feedback,

cargo-shuttle/src/lib.rs

@@ -14,6 +14,8 @@ use std::path::{Path, PathBuf};
 use std::process::exit;
 use std::str::FromStr;
 
+use clap_mangen::Man;
+
 use shuttle_common::{
     claims::{ClaimService, InjectPropagation},
     constants::{
@@ -205,7 +207,11 @@ impl Shuttle {
                 self.init(init_args, args.project_args, provided_path_to_init)
                     .await
             }
-            Command::Generate { shell, output } => self.complete(shell, output),
+            Command::Generate {
+                shell,
+                output,
+                manpage,
+            } => self.complete(shell, output, manpage),
             Command::Login(login_args) => self.login(login_args).await,
             Command::Logout(logout_args) => self.logout(logout_args).await,
             Command::Feedback => self.feedback(),
@@ -615,13 +621,24 @@ impl Shuttle {
         Ok(CommandOutcome::Ok)
     }
 
-    fn complete(&self, shell: Shell, output: Option<PathBuf>) -> Result<CommandOutcome> {
+    fn complete(
+        &self,
+        shell: Option<Shell>,
+        output: Option<PathBuf>,
+        manpage: bool,
+    ) -> Result<CommandOutcome> {
         let name = env!("CARGO_PKG_NAME");
         let mut app = Command::command();
-        match output {
-            Some(v) => generate(shell, &mut app, name, &mut File::create(v)?),
-            None => generate(shell, &mut app, name, &mut stdout()),
+        match (shell, output) {
+            (Some(shell), Some(output)) => {
+                generate(shell, &mut app, name, &mut File::create(output)?)
+            }
+            (Some(shell), None) => generate(shell, &mut app, name, &mut stdout()),
+            (None, _) => {}
         };
+        if manpage {
+            generate_manpage()?;
+        }
 
         Ok(CommandOutcome::Ok)
     }
@@ -1981,6 +1998,15 @@ impl Shuttle {
     }
 }
 
+fn generate_manpage() -> Result<(), std::io::Error> {
+    let app = ShuttleArgs::command();
+    let output = std::io::stdout();
+    let mut output_handle = output.lock();
+    Man::new(app).render(&mut output_handle)?;
+
+    Ok(())
+}
+
 fn is_dirty(repo: &Repository) -> Result<()> {
     let mut status_options = StatusOptions::new();
     status_options.include_untracked(true);