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