rename Opts to CliArgs

This commit is contained in:
João M. Bezerra 2023-02-02 20:11:05 -03:00
parent ab675e8dbb
commit 5b99f434c3
5 changed files with 23 additions and 22 deletions

View File

@ -27,7 +27,7 @@ use clap::{CommandFactory, ValueEnum};
use clap_complete::{generate_to, Shell}; use clap_complete::{generate_to, Shell};
use clap_mangen::Man; use clap_mangen::Man;
include!("src/opts.rs"); include!("src/cli/args.rs");
fn main() { fn main() {
println!("cargo:rerun-if-env-changed=OUCH_ARTIFACTS_FOLDER"); 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") { if let Some(dir) = env::var_os("OUCH_ARTIFACTS_FOLDER") {
let out = &Path::new(&dir); let out = &Path::new(&dir);
create_dir_all(out).unwrap(); create_dir_all(out).unwrap();
let cmd = &mut Opts::command(); let cmd = &mut CliArgs::command();
Man::new(cmd.clone()) Man::new(cmd.clone())
.render(&mut File::create(out.join("ouch.1")).unwrap()) .render(&mut File::create(out.join("ouch.1")).unwrap())

View File

@ -12,7 +12,7 @@ use clap::{Parser, ValueHint};
#[command(about, version)] #[command(about, version)]
// Disable rustdoc::bare_urls because rustdoc parses URLs differently than Clap // Disable rustdoc::bare_urls because rustdoc parses URLs differently than Clap
#[allow(rustdoc::bare_urls)] #[allow(rustdoc::bare_urls)]
pub struct Opts { pub struct CliArgs {
/// 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,

View File

@ -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::{ use std::{
io, io,
@ -9,25 +11,26 @@ use std::{
use clap::Parser; use clap::Parser;
use fs_err as fs; 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`. /// A helper method that calls `clap::Parser::parse`.
/// ///
/// And: /// And:
/// 1. Make paths absolute. /// 1. Make paths absolute.
/// 2. Checks the QuestionPolicy. /// 2. Checks the QuestionPolicy.
pub fn parse_args() -> crate::Result<(Self, QuestionPolicy, FileVisibilityPolicy)> { 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, .. } let (Subcommand::Compress { files, .. }
| Subcommand::Decompress { files, .. } | Subcommand::Decompress { files, .. }
| Subcommand::List { archives: files, .. }) = &mut opts.cmd; | Subcommand::List { archives: files, .. }) = &mut args.cmd;
*files = canonicalize_files(files)?; *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, (false, false) => QuestionPolicy::Ask,
(true, false) => QuestionPolicy::AlwaysYes, (true, false) => QuestionPolicy::AlwaysYes,
(false, true) => QuestionPolicy::AlwaysNo, (false, true) => QuestionPolicy::AlwaysNo,
@ -35,12 +38,12 @@ impl Opts {
}; };
let file_visibility_policy = FileVisibilityPolicy::new() let file_visibility_policy = FileVisibilityPolicy::new()
.read_git_exclude(opts.gitignore) .read_git_exclude(args.gitignore)
.read_ignore(opts.gitignore) .read_ignore(args.gitignore)
.read_git_ignore(opts.gitignore) .read_git_ignore(args.gitignore)
.read_hidden(opts.hidden); .read_hidden(args.hidden);
Ok((opts, skip_questions_positively, file_visibility_policy)) Ok((args, skip_questions_positively, file_visibility_policy))
} }
} }

View File

@ -13,6 +13,7 @@ use rayon::prelude::{IndexedParallelIterator, IntoParallelRefIterator, ParallelI
use utils::colors; use utils::colors;
use crate::{ use crate::{
cli::{CliArgs, Subcommand},
commands::{compress::compress_files, decompress::decompress_file, list::list_archive_contents}, commands::{compress::compress_files, decompress::decompress_file, list::list_archive_contents},
error::{Error, FinalError}, error::{Error, FinalError},
extension::{self, flatten_compression_formats, parse_format, Extension, SUPPORTED_EXTENSIONS}, 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, self, pretty_format_list_of_paths, to_utf, try_infer_extension, user_wants_to_continue, EscapedPathDisplay,
FileVisibilityPolicy, FileVisibilityPolicy,
}, },
warning, Opts, QuestionAction, QuestionPolicy, Subcommand, warning, QuestionAction, QuestionPolicy,
}; };
/// Warn the user that (de)compressing this .zip archive might freeze their system. /// 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<Extension>])
/// ///
/// There are a lot of custom errors to give enough error description and explanation. /// There are a lot of custom errors to give enough error description and explanation.
pub fn run( pub fn run(
args: Opts, args: CliArgs,
question_policy: QuestionPolicy, question_policy: QuestionPolicy,
file_visibility_policy: FileVisibilityPolicy, file_visibility_policy: FileVisibilityPolicy,
) -> crate::Result<()> { ) -> crate::Result<()> {

View File

@ -10,14 +10,11 @@ pub mod extension;
pub mod list; pub mod list;
pub mod utils; pub mod utils;
/// CLI argparsing definitions, using `clap`.
pub mod opts;
use std::{env, path::PathBuf}; use std::{env, path::PathBuf};
use cli::CliArgs;
use error::{Error, Result}; use error::{Error, Result};
use once_cell::sync::Lazy; use once_cell::sync::Lazy;
use opts::{Opts, Subcommand};
use utils::{QuestionAction, QuestionPolicy}; use utils::{QuestionAction, QuestionPolicy};
// Used in BufReader and BufWriter to perform less syscalls // Used in BufReader and BufWriter to perform less syscalls
@ -37,6 +34,6 @@ fn main() {
} }
fn run() -> Result<()> { 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) commands::run(args, skip_questions_positively, file_visibility_policy)
} }