Add option to generate completion script.

Author: mgautierfr

Cargo.lock

@@ -13,6 +13,7 @@ license = "MIT"
 jbk = { git = "https://github.com/jubako/jubako.git", package = "jubako", version = "0.2.0" }
 clap = { version = "4.4.5", features = ["derive"] }
 clap_mangen = "0.2.20"
+clap_complete = "4.5.0"
 indicatif = "0.17.7"
 
 # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html

Cargo.toml

@@ -15,6 +15,7 @@ arx = { path = "../libarx", version = "0.2.0", package="libarx", features=["cmd_
 jbk.workspace = true
 clap.workspace = true
 clap_mangen.workspace = true
+clap_complete.workspace = true
 indicatif.workspace = true
 env_logger = "0.10.0"
 anyhow = "1.0.75"

arx/Cargo.toml

@@ -7,8 +7,10 @@ use std::path::PathBuf;
 use std::rc::Rc;
 use std::sync::Arc;
 
+use clap::{Parser, ValueHint};
+
 /// Create an archive.
-#[derive(clap::Parser, Debug)]
+#[derive(Parser, Debug)]
 pub struct Options {
     /// File path of the archive to create.
     ///
@@ -18,18 +20,19 @@ pub struct Options {
         short = 'f',
         long = "file",
         value_parser,
-        required_unless_present("list_compressions")
+        required_unless_present("list_compressions"),
+        value_hint=ValueHint::FilePath
     )]
     outfile: Option<PathBuf>,
 
     /// Remove STRIP_PREFIX from the entries' name added to the archive.
-    #[arg(long, required = false)]
+    #[arg(long, required = false, value_hint=ValueHint::DirPath)]
     strip_prefix: Option<arx::PathBuf>,
 
     /// Move to BASE_DIR before starting adding content to arx archive.
     ///
     /// Argument `INFILES` or `STRIP_PREFIX` must be relative to `BASE_DIR`.
-    #[arg(short = 'C', required = false)]
+    #[arg(short = 'C', required = false, value_hint=ValueHint::DirPath)]
     base_dir: Option<PathBuf>,
 
     /// Input files/directories
@@ -38,7 +41,7 @@ pub struct Options {
     ///
     /// In this mode `recurse` is true by default.
     /// Use `--no-recurse` to avoid recursion.
-    #[arg(value_parser, group = "input")]
+    #[arg(value_parser, group = "input", value_hint=ValueHint::AnyPath)]
     infiles: Vec<PathBuf>,
 
     /// Get the list of files/directories to add from the FILE_LIST (incompatible with INFILES)
@@ -48,7 +51,7 @@ pub struct Options {
     /// In this mode, `recurse` is false by default.
     /// This allow FILE_LIST listing both the directory and (subset of) files in the given directory.
     /// Use `--recurse` to activate recursion.
-    #[arg(short = 'L', long = "file-list", group = "input", verbatim_doc_comment)]
+    #[arg(short = 'L', long = "file-list", group = "input", verbatim_doc_comment, value_hint=ValueHint::FilePath)]
     file_list: Option<PathBuf>,
 
     /// Recurse in directories

arx/src/create.rs

@@ -1,3 +1,4 @@
+use clap::{Parser, ValueHint};
 use jbk::reader::builder::PropertyBuilderTrait;
 use log::info;
 use std::path::PathBuf;
@@ -39,18 +40,18 @@ fn dump_entry(
 }
 
 /// Print the content of an entry in the archive.
-#[derive(clap::Parser, Debug)]
+#[derive(Parser, Debug)]
 pub struct Options {
     /// Archive to read
-    #[arg(value_parser)]
+    #[arg(value_parser, value_hint=ValueHint::FilePath)]
     infile: PathBuf,
 
     /// Path of the entry to print
     #[arg(value_parser)]
     path: arx::PathBuf,
 
     /// Output Path. If not present or -, print to stdout
-    #[arg(value_parser)]
+    #[arg(value_parser, value_hint=ValueHint::FilePath)]
     output: Option<String>,
 
     #[arg(from_global)]

arx/src/dump.rs

@@ -1,3 +1,4 @@
+use clap::{Parser, ValueHint};
 use log::info;
 use std::collections::HashSet;
 use std::env::current_dir;
@@ -6,26 +7,31 @@ use std::io::{BufRead, BufReader};
 use std::path::PathBuf;
 
 /// Extract the content of an archive
-#[derive(clap::Parser, Debug)]
+#[derive(Parser, Debug)]
 pub struct Options {
     /// Archive to read
-    #[arg(short = 'f', long = "file")]
+    #[arg(short = 'f', long = "file", value_hint=ValueHint::FilePath)]
     infile: PathBuf,
 
     /// Directory in which extract the archive. (Default to current directory)
-    #[arg(short = 'C', required = false)]
+    #[arg(short = 'C', required = false, value_hint=ValueHint::DirPath)]
     outdir: Option<PathBuf>,
 
     /// Files to extract
-    #[arg(value_parser, group = "input")]
+    #[arg(value_parser, group = "input", value_hint=ValueHint::AnyPath)]
     extract_files: Vec<arx::PathBuf>,
 
     /// Print a progress bar of the extraction
     #[arg(short = 'p', long = "progress", default_value_t = false, action)]
     progress: bool,
 
     /// Get the list of files/directories to extract from the FILE_LIST (incompatible with EXTRACT_FILES)
-    #[arg(short = 'L', long = "file-list", group = "input")]
+    #[arg(
+        short = 'L',
+        long = "file-list",
+        group = "input",
+        value_hint = ValueHint::FilePath
+    )]
     file_list: Option<PathBuf>,
 
     #[arg(from_global)]

arx/src/extract.rs

@@ -8,6 +8,7 @@ use std::ops::DerefMut;
 use std::path::PathBuf;
 
 use anyhow::{anyhow, Context, Result};
+use clap::{Parser, ValueHint};
 
 type Path = Vec<u8>;
 
@@ -135,10 +136,10 @@ where
 }
 
 /// List the content in an archive.
-#[derive(clap::Parser, Debug)]
+#[derive(Parser, Debug)]
 pub struct Options {
     /// Archive to read
-    #[arg(value_parser)]
+    #[arg(value_parser, value_hint= ValueHint::FilePath)]
     infile: PathBuf,
 
     /// Use stable output (for scripting)

arx/src/list.rs

@@ -34,6 +34,9 @@ struct Cli {
     )]
     generate_man_page: Option<String>,
 
+    #[arg(long, help_heading = "Advanced")]
+    generate_complete: Option<clap_complete::Shell>,
+
     #[command(subcommand)]
     command: Option<Commands>,
 }
@@ -96,6 +99,13 @@ fn run() -> Result<()> {
         return Ok(());
     }
 
+    if let Some(what) = args.generate_complete {
+        let mut command = Cli::command();
+        let name = command.get_name().to_string();
+        clap_complete::generate(what, &mut command, name, &mut std::io::stdout());
+        return Ok(());
+    }
+
     match args.command {
         None => Ok(Cli::command().print_help()?),
         Some(c) => match c {

arx/src/main.rs

@@ -1,3 +1,4 @@
+use clap::{Parser, ValueHint};
 use log::info;
 use std::path::PathBuf;
 
@@ -89,14 +90,14 @@ impl std::fmt::Display for StatCounter {
 }
 
 /// Mount an archive in a directory.
-#[derive(clap::Parser, Debug)]
+#[derive(Parser, Debug)]
 pub struct Options {
     /// Archive to read
-    #[arg(value_parser)]
+    #[arg(value_parser, value_hint=ValueHint::FilePath)]
     infile: PathBuf,
 
     /// Target directory
-    #[arg(value_parser)]
+    #[arg(value_parser, value_hint=ValueHint::DirPath)]
     mountdir: PathBuf,
 
     #[arg(from_global)]

arx/src/mount.rs

@@ -16,5 +16,6 @@ jbk.workspace = true
 clap.workspace = true
 indicatif.workspace = true
 clap_mangen.workspace = true
+clap_complete.workspace = true
 tar = "0.4.39"
 niffler = "2.5.0"

tar2arx/Cargo.toml

@@ -1,4 +1,4 @@
-use clap::{CommandFactory, Parser};
+use clap::{CommandFactory, Parser, ValueHint};
 
 use arx::create::Adder;
 use std::io::Read;
@@ -13,18 +13,18 @@ use std::sync::Arc;
 #[command(name = "tar2arx", author, version, about, long_about=None)]
 struct Cli {
     /// Tar file to convert
-    #[arg(value_parser)]
-    tar_file: Option<String>,
-
-    #[arg(long, help_heading = "Advanced")]
-    generate_man_page: bool,
+    #[arg(value_parser, value_hint=ValueHint::FilePath)]
+    tar_file: Option<PathBuf>,
 
     /// Archive name to create
     #[arg(
         short,
         long,
         value_parser,
-        required_unless_present_any(["list_compressions", "generate_man_page"])
+        required_unless_present_any(
+            ["list_compressions", "generate_man_page", "generate_complete"]
+        ),
+        value_hint=ValueHint::FilePath
     )]
     outfile: Option<PathBuf>,
 
@@ -44,6 +44,13 @@ struct Cli {
     /// List available compression algorithms
     #[arg(long, default_value_t = false, action)]
     list_compressions: bool,
+
+    #[arg(long, help_heading = "Advanced")]
+    generate_man_page: bool,
+
+    #[arg(long, help_heading = "Advanced")]
+    generate_complete: Option<clap_complete::Shell>,
+
 }
 
 #[derive(Clone)]
@@ -272,6 +279,13 @@ fn main() -> jbk::Result<()> {
         return Ok(());
     }
 
+    if let Some(what) = args.generate_complete {
+        let mut command = Cli::command();
+        let name = command.get_name().to_string();
+        clap_complete::generate(what, &mut command, name, &mut std::io::stdout());
+        return Ok(());
+    }
+
     let mut input_size = None;
     let input: Box<dyn Read> = match args.tar_file {
         None => Box::new(std::io::stdin()),

tar2arx/src/main.rs

@@ -16,5 +16,6 @@ jbk.workspace = true
 clap.workspace = true
 indicatif.workspace = true
 clap_mangen.workspace = true
+clap_complete.workspace = true
 zip = "0.6.6"
 flate2 = "1.0.26"

zip2arx/Cargo.toml

@@ -1,4 +1,4 @@
-use clap::{CommandFactory, Parser};
+use clap::{CommandFactory, Parser, ValueHint};
 
 use arx::create::Adder;
 use std::io::{Read, Seek};
@@ -13,19 +13,22 @@ struct Cli {
     /// Zip file to convert
     #[arg(
         value_parser,
-        required_unless_present_any(["list_compressions", "generate_man_page"])
+        required_unless_present_any(
+            ["list_compressions", "generate_man_page", "generate_complete"]
+        ),
+        value_hint=ValueHint::FilePath
     )]
     zip_file: Option<PathBuf>,
 
-    #[arg(long, help_heading = "Advanced")]
-    generate_man_page: bool,
-
     /// Archive name to create
     #[arg(
         short,
         long,
         value_parser,
-        required_unless_present_any(["list_compressions", "generate_man_page"])
+        required_unless_present_any(
+            ["list_compressions", "generate_man_page", "generate_complete"]
+        ),
+        value_hint=ValueHint::FilePath
     )]
     outfile: Option<PathBuf>,
 
@@ -45,6 +48,13 @@ struct Cli {
     /// List available compression algorithms
     #[arg(long, default_value_t = false, action)]
     list_compressions: bool,
+
+    #[arg(long, help_heading = "Advanced")]
+    generate_man_page: bool,
+
+    #[arg(long, help_heading = "Advanced")]
+    generate_complete: Option<clap_complete::Shell>,
+
 }
 
 #[derive(Clone)]
@@ -242,6 +252,13 @@ fn main() -> jbk::Result<()> {
         return Ok(());
     }
 
+    if let Some(what) = args.generate_complete {
+        let mut command = Cli::command();
+        let name = command.get_name().to_string();
+        clap_complete::generate(what, &mut command, name, &mut std::io::stdout());
+        return Ok(());
+    }
+
     let file = std::fs::File::open(args.zip_file.as_ref().unwrap())?;
     let archive = zip::ZipArchive::new(file).unwrap();
     let converter = Converter::new(