mirror of
https://github.com/bootandy/dust.git
synced 2026-06-08 11:29:05 +03:00
chore(cli): Migrate to Derive API
Change the definition of CLI from the Builder API to the Derive API.
This commit is contained in:
Shun Sakai
andy.boot
+253
-321
@@ -1,326 +1,258 @@
|
||||
use clap::{Arg, Command, builder::PossibleValue, value_parser};
|
||||
use std::fmt;
|
||||
|
||||
use clap::{Parser, ValueEnum, ValueHint};
|
||||
|
||||
// For single thread mode set this variable on your command line:
|
||||
// export RAYON_NUM_THREADS=1
|
||||
|
||||
pub fn build_cli() -> Command {
|
||||
Command::new("Dust")
|
||||
.about("Like du but more intuitive")
|
||||
.version(env!("CARGO_PKG_VERSION"))
|
||||
.arg(
|
||||
Arg::new("depth")
|
||||
.short('d')
|
||||
.long("depth")
|
||||
.value_name("DEPTH")
|
||||
.value_parser(value_parser!(usize))
|
||||
.help("Depth to show")
|
||||
.num_args(1)
|
||||
)
|
||||
.arg(
|
||||
Arg::new("threads")
|
||||
.short('T')
|
||||
.long("threads")
|
||||
.value_parser(value_parser!(usize))
|
||||
.help("Number of threads to use")
|
||||
.num_args(1)
|
||||
)
|
||||
.arg(
|
||||
Arg::new("config")
|
||||
.long("config")
|
||||
.help("Specify a config file to use")
|
||||
.value_name("FILE")
|
||||
.value_hint(clap::ValueHint::FilePath)
|
||||
.value_parser(value_parser!(String))
|
||||
.num_args(1)
|
||||
)
|
||||
.arg(
|
||||
Arg::new("number_of_lines")
|
||||
.short('n')
|
||||
.long("number-of-lines")
|
||||
.value_name("NUMBER")
|
||||
.value_parser(value_parser!(usize))
|
||||
.help("Number of lines of output to show. (Default is terminal_height - 10)")
|
||||
.num_args(1)
|
||||
)
|
||||
.arg(
|
||||
Arg::new("display_full_paths")
|
||||
.short('p')
|
||||
.long("full-paths")
|
||||
.action(clap::ArgAction::SetTrue)
|
||||
.help("Subdirectories will not have their path shortened"),
|
||||
)
|
||||
.arg(
|
||||
Arg::new("ignore_directory")
|
||||
.short('X')
|
||||
.long("ignore-directory")
|
||||
.value_name("PATH")
|
||||
.value_hint(clap::ValueHint::AnyPath)
|
||||
.action(clap::ArgAction::Append)
|
||||
.help("Exclude any file or directory with this path"),
|
||||
)
|
||||
.arg(
|
||||
Arg::new("ignore_all_in_file")
|
||||
.short('I')
|
||||
.long("ignore-all-in-file")
|
||||
.value_name("FILE")
|
||||
.value_hint(clap::ValueHint::FilePath)
|
||||
.value_parser(value_parser!(String))
|
||||
.help("Exclude any file or directory with a regex matching that listed in this file, the file entries will be added to the ignore regexs provided by --invert_filter"),
|
||||
)
|
||||
.arg(
|
||||
Arg::new("dereference_links")
|
||||
.short('L')
|
||||
.long("dereference-links")
|
||||
.action(clap::ArgAction::SetTrue)
|
||||
.help("dereference sym links - Treat sym links as directories and go into them"),
|
||||
)
|
||||
.arg(
|
||||
Arg::new("limit_filesystem")
|
||||
.short('x')
|
||||
.long("limit-filesystem")
|
||||
.action(clap::ArgAction::SetTrue)
|
||||
.help("Only count the files and directories on the same filesystem as the supplied directory"),
|
||||
)
|
||||
.arg(
|
||||
Arg::new("display_apparent_size")
|
||||
.short('s')
|
||||
.long("apparent-size")
|
||||
.action(clap::ArgAction::SetTrue)
|
||||
.help("Use file length instead of blocks"),
|
||||
)
|
||||
.arg(
|
||||
Arg::new("reverse")
|
||||
.short('r')
|
||||
.long("reverse")
|
||||
.action(clap::ArgAction::SetTrue)
|
||||
.help("Print tree upside down (biggest highest)"),
|
||||
)
|
||||
.arg(
|
||||
Arg::new("no_colors")
|
||||
.short('c')
|
||||
.long("no-colors")
|
||||
.action(clap::ArgAction::SetTrue)
|
||||
.help("No colors will be printed (Useful for commands like: watch)"),
|
||||
)
|
||||
.arg(
|
||||
Arg::new("force_colors")
|
||||
.short('C')
|
||||
.long("force-colors")
|
||||
.action(clap::ArgAction::SetTrue)
|
||||
.help("Force colors print"),
|
||||
)
|
||||
.arg(
|
||||
Arg::new("no_bars")
|
||||
.short('b')
|
||||
.long("no-percent-bars")
|
||||
.action(clap::ArgAction::SetTrue)
|
||||
.help("No percent bars or percentages will be displayed"),
|
||||
)
|
||||
.arg(
|
||||
Arg::new("bars_on_right")
|
||||
.short('B')
|
||||
.long("bars-on-right")
|
||||
.action(clap::ArgAction::SetTrue)
|
||||
.help("percent bars moved to right side of screen"),
|
||||
)
|
||||
.arg(
|
||||
Arg::new("min_size")
|
||||
.short('z')
|
||||
.long("min-size")
|
||||
.value_name("MIN_SIZE")
|
||||
.num_args(1)
|
||||
.help("Minimum size file to include in output"),
|
||||
)
|
||||
.arg(
|
||||
Arg::new("screen_reader")
|
||||
.short('R')
|
||||
.long("screen-reader")
|
||||
.action(clap::ArgAction::SetTrue)
|
||||
.help("For screen readers. Removes bars. Adds new column: depth level (May want to use -p too for full path)"),
|
||||
)
|
||||
.arg(
|
||||
Arg::new("skip_total")
|
||||
.long("skip-total")
|
||||
.action(clap::ArgAction::SetTrue)
|
||||
.help("No total row will be displayed"),
|
||||
)
|
||||
.arg(
|
||||
Arg::new("by_filecount")
|
||||
.short('f')
|
||||
.long("filecount")
|
||||
.action(clap::ArgAction::SetTrue)
|
||||
.help("Directory 'size' is number of child files instead of disk size"),
|
||||
)
|
||||
.arg(
|
||||
Arg::new("ignore_hidden")
|
||||
.short('i') // Do not use 'h' this is used by 'help'
|
||||
.long("ignore-hidden")
|
||||
.action(clap::ArgAction::SetTrue)
|
||||
.help("Do not display hidden files"),
|
||||
)
|
||||
.arg(
|
||||
Arg::new("invert_filter")
|
||||
.short('v')
|
||||
.long("invert-filter")
|
||||
.value_name("REGEX")
|
||||
.action(clap::ArgAction::Append)
|
||||
.conflicts_with("filter")
|
||||
.conflicts_with("types")
|
||||
.help("Exclude filepaths matching this regex. To ignore png files type: -v \"\\.png$\" "),
|
||||
)
|
||||
.arg(
|
||||
Arg::new("filter")
|
||||
.short('e')
|
||||
.long("filter")
|
||||
.value_name("REGEX")
|
||||
.action(clap::ArgAction::Append)
|
||||
.conflicts_with("types")
|
||||
.help("Only include filepaths matching this regex. For png files type: -e \"\\.png$\" "),
|
||||
)
|
||||
.arg(
|
||||
Arg::new("types")
|
||||
.short('t')
|
||||
.long("file-types")
|
||||
.conflicts_with("depth")
|
||||
.conflicts_with("only_dir")
|
||||
.action(clap::ArgAction::SetTrue)
|
||||
.help("show only these file types"),
|
||||
)
|
||||
.arg(
|
||||
Arg::new("width")
|
||||
.short('w')
|
||||
.long("terminal-width")
|
||||
.value_name("WIDTH")
|
||||
.value_parser(value_parser!(usize))
|
||||
.num_args(1)
|
||||
.help("Specify width of output overriding the auto detection of terminal width"),
|
||||
)
|
||||
.arg(
|
||||
Arg::new("disable_progress")
|
||||
.short('P')
|
||||
.long("no-progress")
|
||||
.action(clap::ArgAction::SetTrue)
|
||||
.help("Disable the progress indication."),
|
||||
)
|
||||
.arg(
|
||||
Arg::new("print_errors")
|
||||
.long("print-errors")
|
||||
.action(clap::ArgAction::SetTrue)
|
||||
.help("Print path with errors."),
|
||||
)
|
||||
.arg(
|
||||
Arg::new("only_dir")
|
||||
.short('D')
|
||||
.long("only-dir")
|
||||
.conflicts_with("only_file")
|
||||
.conflicts_with("types")
|
||||
.action(clap::ArgAction::SetTrue)
|
||||
.help("Only directories will be displayed."),
|
||||
)
|
||||
.arg(
|
||||
Arg::new("only_file")
|
||||
.short('F')
|
||||
.long("only-file")
|
||||
.conflicts_with("only_dir")
|
||||
.action(clap::ArgAction::SetTrue)
|
||||
.help("Only files will be displayed. (Finds your largest files)"),
|
||||
)
|
||||
.arg(
|
||||
Arg::new("output_format")
|
||||
.short('o')
|
||||
.long("output-format")
|
||||
.value_name("FORMAT")
|
||||
.value_parser([
|
||||
PossibleValue::new("si"),
|
||||
PossibleValue::new("b"),
|
||||
PossibleValue::new("k").alias("kib"),
|
||||
PossibleValue::new("m").alias("mib"),
|
||||
PossibleValue::new("g").alias("gib"),
|
||||
PossibleValue::new("t").alias("tib"),
|
||||
PossibleValue::new("kb"),
|
||||
PossibleValue::new("mb"),
|
||||
PossibleValue::new("gb"),
|
||||
PossibleValue::new("tb"),
|
||||
])
|
||||
.ignore_case(true)
|
||||
.help("Changes output display size. si will print sizes in powers of 1000. b k m g t kb mb gb tb will print the whole tree in that size.")
|
||||
)
|
||||
.arg(
|
||||
Arg::new("stack_size")
|
||||
.short('S')
|
||||
.long("stack-size")
|
||||
.value_name("STACK_SIZE")
|
||||
.value_parser(value_parser!(usize))
|
||||
.num_args(1)
|
||||
.help("Specify memory to use as stack size - use if you see: 'fatal runtime error: stack overflow' (default low memory=1048576, high memory=1073741824)"),
|
||||
)
|
||||
.arg(
|
||||
Arg::new("params")
|
||||
.value_name("PATH")
|
||||
.value_hint(clap::ValueHint::AnyPath)
|
||||
.value_parser(value_parser!(String))
|
||||
.num_args(1..)
|
||||
)
|
||||
.arg(
|
||||
Arg::new("output_json")
|
||||
.short('j')
|
||||
.long("output-json")
|
||||
.action(clap::ArgAction::SetTrue)
|
||||
.help("Output the directory tree as json to the current directory"),
|
||||
)
|
||||
.arg(
|
||||
Arg::new("mtime")
|
||||
.short('M')
|
||||
.long("mtime")
|
||||
.num_args(1)
|
||||
.allow_hyphen_values(true)
|
||||
.value_parser(value_parser!(String))
|
||||
.help("+/-n matches files modified more/less than n days ago , and n matches files modified exactly n days ago, days are rounded down.That is +n => (−∞, curr−(n+1)), n => [curr−(n+1), curr−n), and -n => (𝑐𝑢𝑟𝑟−𝑛, +∞)")
|
||||
)
|
||||
.arg(
|
||||
Arg::new("atime")
|
||||
.short('A')
|
||||
.long("atime")
|
||||
.num_args(1)
|
||||
.allow_hyphen_values(true)
|
||||
.value_parser(value_parser!(String))
|
||||
.help("just like -mtime, but based on file access time")
|
||||
)
|
||||
.arg(
|
||||
Arg::new("ctime")
|
||||
.short('y')
|
||||
.long("ctime")
|
||||
.num_args(1)
|
||||
.allow_hyphen_values(true)
|
||||
.value_parser(value_parser!(String))
|
||||
.help("just like -mtime, but based on file change time")
|
||||
)
|
||||
.arg(
|
||||
Arg::new("files0_from")
|
||||
.long("files0-from")
|
||||
.value_hint(clap::ValueHint::AnyPath)
|
||||
.value_parser(value_parser!(String))
|
||||
.num_args(1)
|
||||
.help("run dust on NUL-terminated file names specified in file; if argument is -, then read names from standard input"),
|
||||
)
|
||||
.arg(
|
||||
Arg::new("collapse")
|
||||
.long("collapse")
|
||||
.value_hint(clap::ValueHint::AnyPath)
|
||||
.value_parser(value_parser!(String))
|
||||
.action(clap::ArgAction::Append)
|
||||
.help("Keep these directories collapsed"),
|
||||
)
|
||||
.arg(
|
||||
Arg::new("filetime")
|
||||
.short('m')
|
||||
.long("filetime")
|
||||
.num_args(1)
|
||||
.value_parser([
|
||||
PossibleValue::new("a").alias("accessed"),
|
||||
PossibleValue::new("c").alias("changed"),
|
||||
PossibleValue::new("m").alias("modified"),
|
||||
])
|
||||
.help("Directory 'size' is max filetime of child files instead of disk size. while a/c/m for last accessed/changed/modified time"),
|
||||
)
|
||||
/// Like du but more intuitive
|
||||
#[derive(Debug, Parser)]
|
||||
#[command(name("Dust"), version)]
|
||||
pub struct Cli {
|
||||
/// Depth to show
|
||||
#[arg(short, long)]
|
||||
pub depth: Option<usize>,
|
||||
|
||||
/// Number of threads to use
|
||||
#[arg(short('T'), long)]
|
||||
pub threads: Option<usize>,
|
||||
|
||||
/// Specify a config file to use
|
||||
#[arg(long, value_name("FILE"), value_hint(ValueHint::FilePath))]
|
||||
pub config: Option<String>,
|
||||
|
||||
/// Number of lines of output to show. (Default is terminal_height - 10)
|
||||
#[arg(short, long, value_name("NUMBER"))]
|
||||
pub number_of_lines: Option<usize>,
|
||||
|
||||
/// Subdirectories will not have their path shortened
|
||||
#[arg(short('p'), long)]
|
||||
pub full_paths: bool,
|
||||
|
||||
/// Exclude any file or directory with this path
|
||||
#[arg(short('X'), long, value_name("PATH"), value_hint(ValueHint::AnyPath))]
|
||||
pub ignore_directory: Option<Vec<String>>,
|
||||
|
||||
/// Exclude any file or directory with a regex matching that listed in this
|
||||
/// file, the file entries will be added to the ignore regexs provided by
|
||||
/// --invert_filter
|
||||
#[arg(short('I'), long, value_name("FILE"), value_hint(ValueHint::FilePath))]
|
||||
pub ignore_all_in_file: Option<String>,
|
||||
|
||||
/// dereference sym links - Treat sym links as directories and go into them
|
||||
#[arg(short('L'), long)]
|
||||
pub dereference_links: bool,
|
||||
|
||||
/// Only count the files and directories on the same filesystem as the
|
||||
/// supplied directory
|
||||
#[arg(short('x'), long)]
|
||||
pub limit_filesystem: bool,
|
||||
|
||||
/// Use file length instead of blocks
|
||||
#[arg(short('s'), long)]
|
||||
pub apparent_size: bool,
|
||||
|
||||
/// Print tree upside down (biggest highest)
|
||||
#[arg(short, long)]
|
||||
pub reverse: bool,
|
||||
|
||||
/// No colors will be printed (Useful for commands like: watch)
|
||||
#[arg(short('c'), long)]
|
||||
pub no_colors: bool,
|
||||
|
||||
/// Force colors print
|
||||
#[arg(short('C'), long)]
|
||||
pub force_colors: bool,
|
||||
|
||||
/// No percent bars or percentages will be displayed
|
||||
#[arg(short('b'), long)]
|
||||
pub no_percent_bars: bool,
|
||||
|
||||
/// percent bars moved to right side of screen
|
||||
#[arg(short('B'), long)]
|
||||
pub bars_on_right: bool,
|
||||
|
||||
/// Minimum size file to include in output
|
||||
#[arg(short('z'), long)]
|
||||
pub min_size: Option<String>,
|
||||
|
||||
/// For screen readers. Removes bars. Adds new column: depth level (May want
|
||||
/// to use -p too for full path)
|
||||
#[arg(short('R'), long)]
|
||||
pub screen_reader: bool,
|
||||
|
||||
/// No total row will be displayed
|
||||
#[arg(long)]
|
||||
pub skip_total: bool,
|
||||
|
||||
/// Directory 'size' is number of child files instead of disk size
|
||||
#[arg(short, long)]
|
||||
pub filecount: bool,
|
||||
|
||||
/// Do not display hidden files
|
||||
// Do not use 'h' this is used by 'help'
|
||||
#[arg(short, long)]
|
||||
pub ignore_hidden: bool,
|
||||
|
||||
/// Exclude filepaths matching this regex. To ignore png files type: -v
|
||||
/// "\.png$"
|
||||
#[arg(
|
||||
short('v'),
|
||||
long,
|
||||
value_name("REGEX"),
|
||||
conflicts_with("filter"),
|
||||
conflicts_with("file_types")
|
||||
)]
|
||||
pub invert_filter: Option<Vec<String>>,
|
||||
|
||||
/// Only include filepaths matching this regex. For png files type: -e
|
||||
/// "\.png$"
|
||||
#[arg(short('e'), long, value_name("REGEX"), conflicts_with("file_types"))]
|
||||
pub filter: Option<Vec<String>>,
|
||||
|
||||
/// show only these file types
|
||||
#[arg(short('t'), long, conflicts_with("depth"), conflicts_with("only_dir"))]
|
||||
pub file_types: bool,
|
||||
|
||||
/// Specify width of output overriding the auto detection of terminal width
|
||||
#[arg(short('w'), long, value_name("WIDTH"))]
|
||||
pub terminal_width: Option<usize>,
|
||||
|
||||
/// Disable the progress indication.
|
||||
#[arg(short('P'), long)]
|
||||
pub no_progress: bool,
|
||||
|
||||
/// Print path with errors.
|
||||
#[arg(long)]
|
||||
pub print_errors: bool,
|
||||
|
||||
/// Only directories will be displayed.
|
||||
#[arg(
|
||||
short('D'),
|
||||
long,
|
||||
conflicts_with("only_file"),
|
||||
conflicts_with("file_types")
|
||||
)]
|
||||
pub only_dir: bool,
|
||||
|
||||
/// Only files will be displayed. (Finds your largest files)
|
||||
#[arg(short('F'), long, conflicts_with("only_dir"))]
|
||||
pub only_file: bool,
|
||||
|
||||
/// Changes output display size. si will print sizes in powers of 1000. b k
|
||||
/// m g t kb mb gb tb will print the whole tree in that size.
|
||||
#[arg(short, long, value_enum, value_name("FORMAT"), ignore_case(true))]
|
||||
pub output_format: Option<OutputFormat>,
|
||||
|
||||
/// Specify memory to use as stack size - use if you see: 'fatal runtime
|
||||
/// error: stack overflow' (default low memory=1048576, high
|
||||
/// memory=1073741824)
|
||||
#[arg(short('S'), long)]
|
||||
pub stack_size: Option<usize>,
|
||||
|
||||
/// Input files or directories.
|
||||
#[arg(value_name("PATH"), value_hint(ValueHint::AnyPath))]
|
||||
pub params: Option<Vec<String>>,
|
||||
|
||||
/// Output the directory tree as json to the current directory
|
||||
#[arg(short('j'), long)]
|
||||
pub output_json: bool,
|
||||
|
||||
/// +/-n matches files modified more/less than n days ago , and n matches
|
||||
/// files modified exactly n days ago, days are rounded down.That is +n =>
|
||||
/// (−∞, curr−(n+1)), n => [curr−(n+1), curr−n), and -n => (𝑐𝑢𝑟𝑟−𝑛, +∞)
|
||||
#[arg(short('M'), long, allow_hyphen_values(true))]
|
||||
pub mtime: Option<String>,
|
||||
|
||||
/// just like -mtime, but based on file access time
|
||||
#[arg(short('A'), long, allow_hyphen_values(true))]
|
||||
pub atime: Option<String>,
|
||||
|
||||
/// just like -mtime, but based on file change time
|
||||
#[arg(short('y'), long, allow_hyphen_values(true))]
|
||||
pub ctime: Option<String>,
|
||||
|
||||
/// run dust on NUL-terminated file names specified in file; if argument is
|
||||
/// -, then read names from standard input
|
||||
#[arg(long, value_hint(ValueHint::AnyPath))]
|
||||
pub files0_from: Option<String>,
|
||||
|
||||
/// Keep these directories collapsed
|
||||
#[arg(long, value_hint(ValueHint::AnyPath))]
|
||||
pub collapse: Option<Vec<String>>,
|
||||
|
||||
/// Directory 'size' is max filetime of child files instead of disk size.
|
||||
/// while a/c/m for last accessed/changed/modified time
|
||||
#[arg(short('m'), long, value_enum)]
|
||||
pub filetime: Option<FileTime>,
|
||||
}
|
||||
|
||||
#[derive(Clone, Copy, Debug, ValueEnum)]
|
||||
#[value(rename_all = "lower")]
|
||||
pub enum OutputFormat {
|
||||
/// SI prefix (powers of 1000)
|
||||
SI,
|
||||
|
||||
/// byte (B)
|
||||
B,
|
||||
|
||||
/// kibibyte (KiB)
|
||||
#[value(name = "k", alias("kib"))]
|
||||
KiB,
|
||||
|
||||
/// mebibyte (MiB)
|
||||
#[value(name = "m", alias("mib"))]
|
||||
MiB,
|
||||
|
||||
/// gibibyte (GiB)
|
||||
#[value(name = "g", alias("gib"))]
|
||||
GiB,
|
||||
|
||||
/// tebibyte (TiB)
|
||||
#[value(name = "t", alias("tib"))]
|
||||
TiB,
|
||||
|
||||
/// kilobyte (kB)
|
||||
KB,
|
||||
|
||||
/// megabyte (MB)
|
||||
MB,
|
||||
|
||||
/// gigabyte (GB)
|
||||
GB,
|
||||
|
||||
/// terabyte (TB)
|
||||
TB,
|
||||
}
|
||||
|
||||
impl fmt::Display for OutputFormat {
|
||||
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
|
||||
match self {
|
||||
Self::SI => write!(f, "si"),
|
||||
Self::B => write!(f, "b"),
|
||||
Self::KiB => write!(f, "k"),
|
||||
Self::MiB => write!(f, "m"),
|
||||
Self::GiB => write!(f, "g"),
|
||||
Self::TiB => write!(f, "t"),
|
||||
Self::KB => write!(f, "kb"),
|
||||
Self::MB => write!(f, "mb"),
|
||||
Self::GB => write!(f, "gb"),
|
||||
Self::TB => write!(f, "tb"),
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
#[derive(Clone, Copy, Debug, ValueEnum)]
|
||||
pub enum FileTime {
|
||||
/// last accessed time
|
||||
#[value(name = "a", alias("accessed"))]
|
||||
Accessed,
|
||||
|
||||
/// last changed time
|
||||
#[value(name = "c", alias("changed"))]
|
||||
Changed,
|
||||
|
||||
/// last modified time
|
||||
#[value(name = "m", alias("modified"))]
|
||||
Modified,
|
||||
}
|
||||
|
||||
Reference in New Issue
Block a user