Merge pull request #4683 from wasmerio/gen-completions-manpages

Add subcommands to generate shell completions and manual pages

lib/cli/Cargo.toml

@@ -169,7 +169,7 @@ bytesize = "1.0"
 cfg-if = "1.0"
 tempfile = "3.6.0"
 serde = { version = "1.0.147", features = ["derive"] }
-dirs = { version = "4.0" }
+dirs = "4.0"
 serde_json = { version = "1.0" }
 target-lexicon = { version = "0.12", features = ["std"] }
 wasmer-config = { version = "0.2.0", path = "../config" }
@@ -227,6 +227,9 @@ tokio-tungstenite = { version = "0.20.1", features = [
 mac_address = { version = "1.1.5", optional = true }
 tun-tap = { version = "0.1.3", features = ["tokio"], optional = true }
 
+clap_complete = "4.5.2"
+clap_mangen = "0.2.20"
+
 # NOTE: Must use different features for clap because the "color" feature does not
 # work on wasi due to the anstream dependency not compiling.
 [target.'cfg(not(target_family = "wasm"))'.dependencies]

lib/cli/src/commands/app/delete.rs

@@ -6,7 +6,7 @@ use is_terminal::IsTerminal;
 use super::util::AppIdentOpts;
 use crate::{commands::AsyncCliCommand, opts::ApiOpts};
 
-/// Show an app.
+/// Delete an existing Edge app
 #[derive(clap::Parser, Debug)]
 pub struct CmdAppDelete {
     #[clap(flatten)]

lib/cli/src/commands/app/get.rs

@@ -8,7 +8,7 @@ use crate::{
     opts::{ApiOpts, ItemFormatOpts},
 };
 
-/// Show an app.
+/// Retrieve detailed informations about an app
 #[derive(clap::Parser, Debug)]
 pub struct CmdAppGet {
     #[clap(flatten)]

lib/cli/src/commands/app/list.rs

@@ -10,7 +10,7 @@ use crate::{
     opts::{ApiOpts, ListFormatOpts},
 };
 
-/// List apps.
+/// List apps belonging to a namespace
 #[derive(clap::Parser, Debug)]
 pub struct CmdAppList {
     #[clap(flatten)]

lib/cli/src/commands/app/logs.rs

@@ -17,7 +17,7 @@ pub enum LogStreamArg {
     Stderr,
 }
 
-/// Show an app.
+/// Retrieve the logs of an app
 #[derive(clap::Parser, Debug)]
 pub struct CmdAppLogs {
     #[clap(flatten)]

lib/cli/src/commands/gen_completions.rs

@@ -0,0 +1,34 @@
+use super::WasmerCmd;
+use clap::CommandFactory;
+use clap_complete::{generate, Shell};
+use std::fs::OpenOptions;
+
+#[derive(Debug, Clone, clap::Parser)]
+pub struct CmdGenCompletions {
+    /// The shell to generate the autocompletions script for.
+    pub shell: Shell,
+
+    /// Where to store the generated file(s) to. Defaults to stdout.
+    #[clap(long)]
+    pub out: Option<String>,
+}
+
+impl CmdGenCompletions {
+    pub fn execute(&self) -> anyhow::Result<()> {
+        let mut cmd = WasmerCmd::command();
+
+        let name = cmd.get_name().to_string();
+        if let Some(out) = &self.out {
+            let mut f = OpenOptions::new()
+                .truncate(true)
+                .create(true)
+                .write(true)
+                .open(out)?;
+            generate(self.shell, &mut cmd, name, &mut f);
+            Ok(())
+        } else {
+            generate(self.shell, &mut cmd, name, &mut std::io::stdout());
+            Ok(())
+        }
+    }
+}

lib/cli/src/commands/gen_manpage.rs

@@ -0,0 +1,26 @@
+use super::WasmerCmd;
+use anyhow::Context;
+use clap::CommandFactory;
+use clap_mangen::generate_to;
+use std::path::PathBuf;
+
+lazy_static::lazy_static! {
+    static ref DEFAULT_MAN_DIR_PATH: PathBuf = dirs::data_dir().unwrap_or_default().join("man");
+}
+
+#[derive(Debug, Clone, clap::Parser)]
+pub struct CmdGenManPage {
+    /// Where to store the generated file(s) to.
+    #[clap(long, default_value = DEFAULT_MAN_DIR_PATH.as_os_str())]
+    pub out: PathBuf,
+}
+
+impl CmdGenManPage {
+    pub fn execute(&self) -> anyhow::Result<()> {
+        let cmd = WasmerCmd::command();
+        generate_to(cmd, &self.out).context(format!(
+            "While generating the man page(s) to {}",
+            self.out.display()
+        ))
+    }
+}

lib/cli/src/commands/mod.rs

@@ -16,6 +16,8 @@ mod create_obj;
 pub(crate) mod domain;
 #[cfg(feature = "static-artifact-create")]
 mod gen_c_header;
+mod gen_completions;
+mod gen_manpage;
 mod init;
 mod inspect;
 #[cfg(feature = "journal")]
@@ -115,6 +117,8 @@ impl WasmerCmd {
         }
 
         match cmd {
+            Some(Cmd::GenManPage(cmd)) => cmd.execute(),
+            Some(Cmd::GenCompletions(cmd)) => cmd.execute(),
             Some(Cmd::Run(options)) => options.execute(output),
             Some(Cmd::SelfUpdate(options)) => options.execute(),
             Some(Cmd::Cache(cache)) => cache.execute(),
@@ -220,7 +224,7 @@ enum Cmd {
     #[clap(name = "publish")]
     Publish(crate::commands::package::publish::PackagePublish),
 
-    /// Wasmer cache
+    /// Manage the local Wasmer cache
     Cache(Cache),
 
     /// Validate a WebAssembly binary
@@ -363,6 +367,14 @@ enum Cmd {
     /// Manage DNS records
     #[clap(subcommand, alias = "domains")]
     Domain(crate::commands::domain::CmdDomain),
+
+    /// Generate autocompletion for different shells
+    #[clap(name = "gen-completions")]
+    GenCompletions(crate::commands::gen_completions::CmdGenCompletions),
+
+    /// Generate man pages
+    #[clap(name = "gen-man", hide = true)]
+    GenManPage(crate::commands::gen_manpage::CmdGenManPage),
 }
 
 fn is_binfmt_interpreter() -> bool {

lib/cli/src/commands/package/publish.rs

@@ -97,7 +97,6 @@ impl PackagePublish {
                 quiet: self.quiet,
                 package_namespace: self.package_namespace.clone(),
                 timeout: self.timeout,
-                bump: self.bump,
                 non_interactive: self.non_interactive,
                 wait: self.wait,
                 package_path: self.package_path.clone(),

lib/cli/src/commands/package/push.rs

@@ -41,10 +41,6 @@ pub struct PackagePush {
     #[clap(long, default_value = "5m")]
     pub timeout: humantime::Duration,
 
-    /// Whether or not the patch field of the version of the package - if any - should be bumped.
-    #[clap(long, conflicts_with = "version")]
-    pub bump: bool,
-
     /// Do not prompt for user input.
     #[clap(long, default_value_t = !std::io::stdin().is_terminal())]
     pub non_interactive: bool,

lib/cli/src/commands/run/mod.rs

@@ -79,7 +79,7 @@ pub struct Run {
     #[clap(short, long, aliases = &["command", "invoke", "command-name"])]
     entrypoint: Option<String>,
     /// Generate a coredump at this path if a WebAssembly trap occurs
-    #[clap(name = "COREDUMP PATH", long)]
+    #[clap(name = "COREDUMP_PATH", long)]
     coredump_on_trap: Option<PathBuf>,
     /// The file, URL, or package to run.
     #[clap(value_parser = PackageSource::infer)]