src/opts.rs

   1 use std::path::PathBuf;
   2
   3 use clap::{Parser, ValueHint};
   4
   5 // Command line options
   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 #[clap(about, version)]
  13 // Ignore bare urls in the documentation of this file because the doc comments
  14 // are also being used by Clap's --help generation
  15 #[allow(rustdoc::bare_urls)]
  16 pub struct Opts {
  17     /// Skip [Y/n] questions positively.
  18     #[clap(short, long, conflicts_with = "no", global = true)]
  19     pub yes: bool,
  20
  21     /// Skip [Y/n] questions negatively.
  22     #[clap(short, long, global = true)]
  23     pub no: bool,
  24
  25     /// Activate accessibility mode, reducing visual noise
  26     #[clap(short = 'A', long, env = "ACCESSIBLE", global = true)]
  27     pub accessible: bool,
  28
  29     /// Ignores hidden files
  30     #[clap(short = 'H', long)]
  31     pub hidden: bool,
  32
  33     /// Ignores files matched by git's ignore files
  34     #[clap(short = 'g', long)]
  35     pub gitignore: bool,
  36
  37     /// Ouch and claps subcommands
  38     #[clap(subcommand)]
  39     pub cmd: Subcommand,
  40 }
  41
  42 // CAREFUL: this docs can accidentally become part of the --help message if they get too long
  43 // this was tested in clap 3.0.0-beta5.
  44 /// Repository: https://github.com/ouch-org/ouch
  45 //
  46 // Ouch commands:
  47 // - `compress`
  48 // - `decompress`
  49 // - `list`
  50 //
  51 // Clap commands:
  52 //  - `help`
  53 #[derive(Parser, PartialEq, Eq, Debug)]
  54 #[allow(rustdoc::bare_urls)]
  55 pub enum Subcommand {
  56     /// Compress one or more files into one output file.
  57     #[clap(alias = "c")]
  58     Compress {
  59         /// Files to be compressed.
  60         #[clap(required = true, min_values = 1)]
  61         files: Vec<PathBuf>,
  62
  63         /// The resulting file. Its extensions can be used to specify the compression formats.
  64         #[clap(required = true, value_hint = ValueHint::FilePath)]
  65         output: PathBuf,
  66     },
  67     /// Decompresses one or more files, optionally into another folder.
  68     #[clap(alias = "d")]
  69     Decompress {
  70         /// Files to be decompressed.
  71         #[clap(required = true, min_values = 1)]
  72         files: Vec<PathBuf>,
  73
  74         /// Place results in a directory other than the current one.
  75         #[clap(short = 'd', long = "dir", value_hint = ValueHint::DirPath)]
  76         output_dir: Option<PathBuf>,
  77     },
  78     /// List contents.     Alias: l
  79     #[clap(alias = "l")]
  80     List {
  81         /// Archives whose contents should be listed
  82         #[clap(required = true, min_values = 1)]
  83         archives: Vec<PathBuf>,
  84
  85         /// Show archive contents as a tree
  86         #[clap(short, long)]
  87         tree: bool,
  88     },
  89 }