Skip to content

Commit

Permalink
Improve help text
Browse files Browse the repository at this point in the history 
Instead of using the getopts crate’s dynamically-generated usage string, use a more static one:

- The options are organised by category now
- You can use `--help --long` to display only the ones that pertain to `--long`
- They’re aligned in a table sort of way

It could be generated statically, because all the options to change it are determined at compile time, but they’re not, yet...
  • Loading branch information
@ogham
ogham committed Nov 15, 2015
1 parent 590fb9c commit edeec0f
Showing 1 changed file with 74 additions and 14 deletions.
88 changes: 74 additions & 14 deletions src/options.rs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -36,39 +36,45 @@ impl Options {
#[allow(unused_results)]
pub fn getopts(args: &[String]) -> Result<(Options, Vec<String>), Misfire> {
let mut opts = getopts::Options::new();

opts.optflag("v", "version", "display version of exa");
opts.optflag("?", "help", "show list of command-line options");

// Display options
opts.optflag("1", "oneline", "display one entry per line");
opts.optflag("G", "grid", "display entries in a grid view (default)");
opts.optflag("l", "long", "display extended details and attributes");
opts.optflag("R", "recurse", "recurse into directories");
opts.optflag("T", "tree", "recurse into subdirectories in a tree view");
opts.optflag("x", "across", "sort multi-column view entries across");

// Filtering and sorting options
opts.optflag("", "group-directories-first", "list directories before other files");
opts.optflag("a", "all", "show dot-files");
opts.optflag("d", "list-dirs", "list directories as regular files");
opts.optflag("r", "reverse", "reverse order of files");
opts.optopt ("s", "sort", "field to sort by", "WORD");

// Long view options
opts.optflag("b", "binary", "use binary prefixes in file sizes");
opts.optflag("B", "bytes", "list file sizes in bytes, without prefixes");
opts.optflag("d", "list-dirs", "list directories as regular files");
opts.optflag("g", "group", "show group as well as user");
opts.optflag("G", "grid", "display entries in a grid view (default)");
opts.optflag("", "group-directories-first", "list directories before other files");
opts.optflag("h", "header", "show a header row at the top");
opts.optflag("H", "links", "show number of hard links");
opts.optflag("i", "inode", "show each file's inode number");
opts.optflag("l", "long", "display extended details and attributes");
opts.optopt ("L", "level", "maximum depth of recursion", "DEPTH");
opts.optflag("m", "modified", "display timestamp of most recent modification");
opts.optflag("r", "reverse", "reverse order of files");
opts.optflag("R", "recurse", "recurse into directories");
opts.optopt ("s", "sort", "field to sort by", "WORD");
opts.optflag("S", "blocks", "show number of file system blocks");
opts.optopt ("t", "time", "which timestamp to show for a file", "WORD");
opts.optflag("T", "tree", "recurse into subdirectories in a tree view");
opts.optflag("u", "accessed", "display timestamp of last access for a file");
opts.optflag("U", "created", "display timestamp of creation for a file");
opts.optflag("x", "across", "sort multi-column view entries across");

opts.optflag("", "version", "display version of exa");
opts.optflag("?", "help", "show list of command-line options");

if cfg!(feature="git") {
opts.optflag("", "git", "show git status");
}

if xattr::ENABLED {
opts.optflag("@", "extended", "display extended attribute keys and sizes in long (-l) output");
opts.optflag("@", "extended", "display extended attribute keys and sizes");
}

let matches = match opts.parse(args) {
Expand All @@ -77,7 +83,25 @@ impl Options {
};

if matches.opt_present("help") {
return Err(Misfire::Help(opts.usage("Usage:\n exa [options] [files...]")));
let mut help_string = "Usage:\n exa [options] [files...]\n".to_owned();

if !matches.opt_present("long") {
help_string.push_str(OPTIONS);
}

help_string.push_str(LONG_OPTIONS);

if cfg!(feature="git") {
help_string.push_str(GIT_HELP);
help_string.push('\n');
}

if xattr::ENABLED {
help_string.push_str(EXTENDED_HELP);
help_string.push('\n');
}

return Err(Misfire::Help(help_string));
}
else if matches.opt_present("version") {
return Err(Misfire::Version);
Expand Down Expand Up @@ -569,6 +593,42 @@ impl fmt::Display for Misfire {
}
}

static OPTIONS: &'static str = r##"
DISPLAY OPTIONS
-1, --oneline display one entry per line
-G, --grid display entries in a grid view (default)
-l, --long display extended details and attributes
-R, --recurse recurse into directories
-T, --tree recurse into subdirectories in a tree view
-x, --across sort multi-column view entries across
FILTERING AND SORTING OPTIONS
-a, --all show dot-files
-d, --list-dirs list directories as regular files
-r, --reverse reverse order of files
-s, --sort WORD field to sort by
--group-directories-first list directories before other files
"##;

static LONG_OPTIONS: &'static str = r##"
LONG VIEW OPTIONS
-b, --binary use binary prefixes in file sizes
-B, --bytes list file sizes in bytes, without prefixes
-g, --group show group as well as user
-h, --header show a header row at the top
-H, --links show number of hard links
-i, --inode show each file's inode number
-L, --level DEPTH maximum depth of recursion
-m, --modified display timestamp of most recent modification
-S, --blocks show number of file system blocks
-t, --time WORD which timestamp to show for a file
-u, --accessed display timestamp of last access for a file
-U, --created display timestamp of creation for a file
"##;

static GIT_HELP: &'static str = r##" -@, --extended display extended attribute keys and sizes"##;
static EXTENDED_HELP: &'static str = r##" --git show git status for files"##;


#[cfg(test)]
mod test {
Expand Down

0 comments on commit edeec0f

Please sign in to comment.