From 5b99f434c3628ad934e43b08bfcb809b626d4a8d Mon Sep 17 00:00:00 2001 From: =?utf8?q?Jo=C3=A3o=20M=2E=20Bezerra?= Date: Thu, 2 Feb 2023 20:11:05 -0300 Subject: [PATCH] rename `Opts` to `CliArgs` --- build.rs | 4 ++-- src/{opts.rs => cli/args.rs} | 2 +- src/{cli.rs => cli/mod.rs} | 27 +++++++++++++++------------ src/commands/mod.rs | 5 +++-- src/main.rs | 7 ++----- 5 files changed, 23 insertions(+), 22 deletions(-) rename src/{opts.rs => cli/args.rs} (99%) rename src/{cli.rs => cli/mod.rs} (65%) diff --git a/build.rs b/build.rs index 6983dc4..c7a1f91 100644 --- a/build.rs +++ b/build.rs @@ -27,7 +27,7 @@ use clap::{CommandFactory, ValueEnum}; use clap_complete::{generate_to, Shell}; use clap_mangen::Man; -include!("src/opts.rs"); +include!("src/cli/args.rs"); fn main() { println!("cargo:rerun-if-env-changed=OUCH_ARTIFACTS_FOLDER"); @@ -35,7 +35,7 @@ fn main() { if let Some(dir) = env::var_os("OUCH_ARTIFACTS_FOLDER") { let out = &Path::new(&dir); create_dir_all(out).unwrap(); - let cmd = &mut Opts::command(); + let cmd = &mut CliArgs::command(); Man::new(cmd.clone()) .render(&mut File::create(out.join("ouch.1")).unwrap()) diff --git a/src/opts.rs b/src/cli/args.rs similarity index 99% rename from src/opts.rs rename to src/cli/args.rs index 8139647..6f31969 100644 --- a/src/opts.rs +++ b/src/cli/args.rs @@ -12,7 +12,7 @@ use clap::{Parser, ValueHint}; #[command(about, version)] // Disable rustdoc::bare_urls because rustdoc parses URLs differently than Clap #[allow(rustdoc::bare_urls)] -pub struct Opts { +pub struct CliArgs { /// Skip [Y/n] questions positively #[arg(short, long, conflicts_with = "no", global = true)] pub yes: bool, diff --git a/src/cli.rs b/src/cli/mod.rs similarity index 65% rename from src/cli.rs rename to src/cli/mod.rs index ee25e41..1fd7f38 100644 --- a/src/cli.rs +++ b/src/cli/mod.rs @@ -1,4 +1,6 @@ -//! CLI related functions, uses the clap argparsing definitions from `opts.rs`. +//! CLI related functions, uses the clap argparsing definitions from `args.rs`. + +mod args; use std::{ io, @@ -9,25 +11,26 @@ use std::{ use clap::Parser; use fs_err as fs; -use crate::{accessible::set_accessible, utils::FileVisibilityPolicy, Opts, QuestionPolicy, Subcommand}; +pub use self::args::{CliArgs, Subcommand}; +use crate::{accessible::set_accessible, utils::FileVisibilityPolicy, QuestionPolicy}; -impl Opts { +impl CliArgs { /// A helper method that calls `clap::Parser::parse`. /// /// And: /// 1. Make paths absolute. /// 2. Checks the QuestionPolicy. pub fn parse_args() -> crate::Result<(Self, QuestionPolicy, FileVisibilityPolicy)> { - let mut opts = Self::parse(); + let mut args = Self::parse(); - set_accessible(opts.accessible); + set_accessible(args.accessible); let (Subcommand::Compress { files, .. } | Subcommand::Decompress { files, .. } - | Subcommand::List { archives: files, .. }) = &mut opts.cmd; + | Subcommand::List { archives: files, .. }) = &mut args.cmd; *files = canonicalize_files(files)?; - let skip_questions_positively = match (opts.yes, opts.no) { + let skip_questions_positively = match (args.yes, args.no) { (false, false) => QuestionPolicy::Ask, (true, false) => QuestionPolicy::AlwaysYes, (false, true) => QuestionPolicy::AlwaysNo, @@ -35,12 +38,12 @@ impl Opts { }; let file_visibility_policy = FileVisibilityPolicy::new() - .read_git_exclude(opts.gitignore) - .read_ignore(opts.gitignore) - .read_git_ignore(opts.gitignore) - .read_hidden(opts.hidden); + .read_git_exclude(args.gitignore) + .read_ignore(args.gitignore) + .read_git_ignore(args.gitignore) + .read_hidden(args.hidden); - Ok((opts, skip_questions_positively, file_visibility_policy)) + Ok((args, skip_questions_positively, file_visibility_policy)) } } diff --git a/src/commands/mod.rs b/src/commands/mod.rs index 95f8cfc..f154b5b 100644 --- a/src/commands/mod.rs +++ b/src/commands/mod.rs @@ -13,6 +13,7 @@ use rayon::prelude::{IndexedParallelIterator, IntoParallelRefIterator, ParallelI use utils::colors; use crate::{ + cli::{CliArgs, Subcommand}, commands::{compress::compress_files, decompress::decompress_file, list::list_archive_contents}, error::{Error, FinalError}, extension::{self, flatten_compression_formats, parse_format, Extension, SUPPORTED_EXTENSIONS}, @@ -22,7 +23,7 @@ use crate::{ self, pretty_format_list_of_paths, to_utf, try_infer_extension, user_wants_to_continue, EscapedPathDisplay, FileVisibilityPolicy, }, - warning, Opts, QuestionAction, QuestionPolicy, Subcommand, + warning, QuestionAction, QuestionPolicy, }; /// Warn the user that (de)compressing this .zip archive might freeze their system. @@ -99,7 +100,7 @@ fn check_for_non_archive_formats(files: &[PathBuf], formats: &[Vec]) /// /// There are a lot of custom errors to give enough error description and explanation. pub fn run( - args: Opts, + args: CliArgs, question_policy: QuestionPolicy, file_visibility_policy: FileVisibilityPolicy, ) -> crate::Result<()> { diff --git a/src/main.rs b/src/main.rs index e10dc62..02119df 100644 --- a/src/main.rs +++ b/src/main.rs @@ -10,14 +10,11 @@ pub mod extension; pub mod list; pub mod utils; -/// CLI argparsing definitions, using `clap`. -pub mod opts; - use std::{env, path::PathBuf}; +use cli::CliArgs; use error::{Error, Result}; use once_cell::sync::Lazy; -use opts::{Opts, Subcommand}; use utils::{QuestionAction, QuestionPolicy}; // Used in BufReader and BufWriter to perform less syscalls @@ -37,6 +34,6 @@ fn main() { } fn run() -> Result<()> { - let (args, skip_questions_positively, file_visibility_policy) = Opts::parse_args()?; + let (args, skip_questions_positively, file_visibility_policy) = CliArgs::parse_args()?; commands::run(args, skip_questions_positively, file_visibility_policy) } -- 2.11.4.GIT