github/ouch
1
1
Fork 0
mirror of https://github.com/ouch-org/ouch.git synced 2025-06-07 12:05:46 +00:00
Code Issues 15 Packages Projects Releases Wiki Activity

Merge pull request #275 from ouch-org/show-aliases-in-help-message

Browse Source 
Show subcommand aliases on `--help`
This commit is contained in:
figsoda 2022-10-11 16:39:54 -04:00 committed by GitHub
commit fe0af16576
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 14 additions and 26 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

40
src/opts.rs
View File

@ -2,7 +2,7 @@ use std::path::PathBuf;
use clap::{Parser, ValueHint}; use clap::{Parser, ValueHint};
// Command line options // Ouch command line options (docstrings below are part of --help)
/// A command-line utility for easily compressing and decompressing files and directories. /// A command-line utility for easily compressing and decompressing files and directories.
/// ///
/// Supported formats: tar, zip, bz/bz2, gz, lz4, xz/lz/lzma, zst. /// Supported formats: tar, zip, bz/bz2, gz, lz4, xz/lz/lzma, zst.
@ -10,15 +10,14 @@ use clap::{Parser, ValueHint};
/// Repository: https://github.com/ouch-org/ouch /// Repository: https://github.com/ouch-org/ouch
#[derive(Parser, Debug)] #[derive(Parser, Debug)]
#[command(about, version)] #[command(about, version)]
// Ignore bare urls in the documentation of this file because the doc comments // Disable rustdoc::bare_urls because rustdoc parses URLs differently than Clap
// are also being used by Clap's --help generation
#[allow(rustdoc::bare_urls)] #[allow(rustdoc::bare_urls)]
pub struct Opts { pub struct Opts {
/// Skip [Y/n] questions positively. /// Skip [Y/n] questions positively
#[arg(short, long, conflicts_with = "no", global = true)] #[arg(short, long, conflicts_with = "no", global = true)]
pub yes: bool, pub yes: bool,
/// Skip [Y/n] questions negatively. /// Skip [Y/n] questions negatively
#[arg(short, long, global = true)] #[arg(short, long, global = true)]
pub no: bool, pub no: bool,
@ -39,44 +38,33 @@ pub struct Opts {
pub cmd: Subcommand, pub cmd: Subcommand,
} }
// CAREFUL: this docs can accidentally become part of the --help message if they get too long
// this was tested in clap 3.0.0-beta5.
/// Repository: https://github.com/ouch-org/ouch
//
// Ouch commands:
// - `compress`
// - `decompress`
// - `list`
//
// Clap commands:
// - `help`
#[derive(Parser, PartialEq, Eq, Debug)] #[derive(Parser, PartialEq, Eq, Debug)]
#[allow(rustdoc::bare_urls)] #[allow(rustdoc::bare_urls)]
pub enum Subcommand { pub enum Subcommand {
/// Compress one or more files into one output file. /// Compress one or more files into one output file
#[command(alias = "c")] #[command(visible_alias = "c")]
Compress { Compress {
/// Files to be compressed. /// Files to be compressed
#[arg(required = true, num_args = 1..)] #[arg(required = true, num_args = 1..)]
files: Vec<PathBuf>, files: Vec<PathBuf>,
/// The resulting file. Its extensions can be used to specify the compression formats. /// The resulting file. Its extensions can be used to specify the compression formats
#[arg(required = true, value_hint = ValueHint::FilePath)] #[arg(required = true, value_hint = ValueHint::FilePath)]
output: PathBuf, output: PathBuf,
}, },
/// Decompresses one or more files, optionally into another folder. /// Decompresses one or more files, optionally into another folder
#[command(alias = "d")] #[command(visible_alias = "d")]
Decompress { Decompress {
/// Files to be decompressed. /// Files to be decompressed
#[arg(required = true, num_args = 1..)] #[arg(required = true, num_args = 1..)]
files: Vec<PathBuf>, files: Vec<PathBuf>,
/// Place results in a directory other than the current one. /// Place results in a directory other than the current one
#[arg(short = 'd', long = "dir", value_hint = ValueHint::DirPath)] #[arg(short = 'd', long = "dir", value_hint = ValueHint::DirPath)]
output_dir: Option<PathBuf>, output_dir: Option<PathBuf>,
}, },
/// List contents. Alias: l /// List contents of an archive
#[command(alias = "l")] #[command(visible_alias = "l")]
List { List {
/// Archives whose contents should be listed /// Archives whose contents should be listed
#[arg(required = true, num_args = 1..)] #[arg(required = true, num_args = 1..)]