src/opts.rs

   1 use std::path::PathBuf;
   2
   3 use clap::{Parser, ValueHint};
   4
   5 // Ouch command line options (docstrings below are part of --help)
   6 /// A command-line utility for easily compressing and decompressing files and directories.
   7 ///
   8 /// Supported formats: tar, zip, bz/bz2, gz, lz4, xz/lz/lzma, zst.
   9 ///
  10 /// Repository: https://github.com/ouch-org/ouch
  11 #[derive(Parser, Debug)]
  12 #[command(about, version)]
  13 // Disable rustdoc::bare_urls because rustdoc parses URLs differently than Clap
  14 #[allow(rustdoc::bare_urls)]
  15 pub struct Opts {
  16     /// Skip [Y/n] questions positively
  17     #[arg(short, long, conflicts_with = "no", global = true)]
  18     pub yes: bool,
  19
  20     /// Skip [Y/n] questions negatively
  21     #[arg(short, long, global = true)]
  22     pub no: bool,
  23
  24     /// Activate accessibility mode, reducing visual noise
  25     #[arg(short = 'A', long, env = "ACCESSIBLE", global = true)]
  26     pub accessible: bool,
  27
  28     /// Ignores hidden files
  29     #[arg(short = 'H', long, global = true)]
  30     pub hidden: bool,
  31
  32     /// Silences output
  33     #[arg(short = 'q', long, global = true)]
  34     pub quiet: bool,
  35
  36     /// Ignores files matched by git's ignore files
  37     #[arg(short = 'g', long, global = true)]
  38     pub gitignore: bool,
  39
  40     /// Ouch and claps subcommands
  41     #[command(subcommand)]
  42     pub cmd: Subcommand,
  43 }
  44
  45 #[derive(Parser, PartialEq, Eq, Debug)]
  46 #[allow(rustdoc::bare_urls)]
  47 pub enum Subcommand {
  48     /// Compress one or more files into one output file
  49     #[command(visible_alias = "c")]
  50     Compress {
  51         /// Files to be compressed
  52         #[arg(required = true, num_args = 1..)]
  53         files: Vec<PathBuf>,
  54
  55         /// The resulting file. Its extensions can be used to specify the compression formats
  56         #[arg(required = true, value_hint = ValueHint::FilePath)]
  57         output: PathBuf,
  58     },
  59     /// Decompresses one or more files, optionally into another folder
  60     #[command(visible_alias = "d")]
  61     Decompress {
  62         /// Files to be decompressed
  63         #[arg(required = true, num_args = 1..)]
  64         files: Vec<PathBuf>,
  65
  66         /// Place results in a directory other than the current one
  67         #[arg(short = 'd', long = "dir", value_hint = ValueHint::DirPath)]
  68         output_dir: Option<PathBuf>,
  69     },
  70     /// List contents of an archive
  71     #[command(visible_alias = "l")]
  72     List {
  73         /// Archives whose contents should be listed
  74         #[arg(required = true, num_args = 1..)]
  75         archives: Vec<PathBuf>,
  76
  77         /// Show archive contents as a tree
  78         #[arg(short, long)]
  79         tree: bool,
  80     },
  81 }