use clap::{ crate_name, crate_version, value_parser, Arg, ArgAction, ArgGroup, ColorChoice, Command, }; use once_cell::sync::Lazy; use std::env; use std::path::{Path, PathBuf}; static VERSION: Lazy = Lazy::new(|| { #[cfg(feature = "bugreport")] let git_version = bugreport::git_version!(fallback = ""); #[cfg(not(feature = "bugreport"))] let git_version = ""; if git_version.is_empty() { crate_version!().to_string() } else { format!("{} ({})", crate_version!(), git_version) } }); pub fn build_app(interactive_output: bool) -> Command { let color_when = if interactive_output && env::var_os("NO_COLOR").is_none() { ColorChoice::Auto } else { ColorChoice::Never }; let mut app = Command::new(crate_name!()) .version(VERSION.as_str()) .color(color_when) .hide_possible_values(true) .args_conflicts_with_subcommands(true) .allow_external_subcommands(true) .disable_help_subcommand(true) .max_term_width(100) .about("A cat(1) clone with wings.") .long_about("A cat(1) clone with syntax highlighting and Git integration.") .arg( Arg::new("FILE") .help("File(s) to print / concatenate. Use '-' for standard input.") .long_help( "File(s) to print / concatenate. Use a dash ('-') or no argument at all \ to read from standard input.", ) .num_args(1..) .value_parser(value_parser!(PathBuf)), ) .arg( Arg::new("show-all") .long("show-all") .alias("show-nonprintable") .short('A') .action(ArgAction::SetTrue) .conflicts_with("language") .help("Show non-printable characters (space, tab, newline, ..).") .long_help( "Show non-printable characters like space, tab or newline. \ This option can also be used to print binary files. \ Use '--tabs' to control the width of the tab-placeholders.", ), ) .arg( Arg::new("plain") .overrides_with("plain") .overrides_with("number") .short('p') .long("plain") .action(ArgAction::Count) .help("Show plain style (alias for '--style=plain').") .long_help( "Only show plain style, no decorations. This is an alias for \ '--style=plain'. When '-p' is used twice ('-pp'), it also disables \ automatic paging (alias for '--style=plain --paging=never').", ), ) .arg( Arg::new("language") .short('l') .long("language") .overrides_with("language") .help("Set the language for syntax highlighting.") .long_help( "Explicitly set the language for syntax highlighting. The language can be \ specified as a name (like 'C++' or 'LaTeX') or possible file extension \ (like 'cpp', 'hpp' or 'md'). Use '--list-languages' to show all supported \ language names and file extensions.", ), ) .arg( Arg::new("highlight-line") .long("highlight-line") .short('H') .action(ArgAction::Append) .value_name("N:M") .help("Highlight lines N through M.") .long_help( "Highlight the specified line ranges with a different background color \ For example:\n \ '--highlight-line 40' highlights line 40\n \ '--highlight-line 30:40' highlights lines 30 to 40\n \ '--highlight-line :40' highlights lines 1 to 40\n \ '--highlight-line 40:' highlights lines 40 to the end of the file\n \ '--highlight-line 30:+10' highlights lines 30 to 40", ), ) .arg( Arg::new("file-name") .long("file-name") .action(ArgAction::Append) .value_name("name") .value_parser(value_parser!(PathBuf)) .help("Specify the name to display for a file.") .long_help( "Specify the name to display for a file. Useful when piping \ data to bat from STDIN when bat does not otherwise know \ the filename. Note that the provided file name is also \ used for syntax detection.", ), ); #[cfg(feature = "git")] { app = app .arg( Arg::new("diff") .long("diff") .short('d') .action(ArgAction::SetTrue) .conflicts_with("line-range") .help("Only show lines that have been added/removed/modified.") .long_help( "Only show lines that have been added/removed/modified with respect \ to the Git index. Use --diff-context=N to control how much context you want to see.", ), ) .arg( Arg::new("diff-context") .long("diff-context") .overrides_with("diff-context") .value_name("N") .value_parser( |n: &str| { n.parse::() .map_err(|_| "must be a number") .map(|_| n.to_owned()) // Convert to Result .map_err(|e| e.to_string()) }, // Convert to Result<(), String> ) .hide_short_help(true) .long_help( "Include N lines of context around added/removed/modified lines when using '--diff'.", ), ) } app = app.arg( Arg::new("tabs") .long("tabs") .overrides_with("tabs") .value_name("T") .value_parser( |t: &str| { t.parse::() .map_err(|_t| "must be a number") .map(|_t| t.to_owned()) // Convert to Result .map_err(|e| e.to_string()) }, // Convert to Result<(), String> ) .help("Set the tab width to T spaces.") .long_help( "Set the tab width to T spaces. Use a width of 0 to pass tabs through \ directly", ), ) .arg( Arg::new("wrap") .long("wrap") .overrides_with("wrap") .value_name("mode") .value_parser(["auto", "never", "character"]) .default_value("auto") .hide_default_value(true) .help("Specify the text-wrapping mode (*auto*, never, character).") .long_help("Specify the text-wrapping mode (*auto*, never, character). \ The '--terminal-width' option can be used in addition to \ control the output width."), ) .arg( Arg::new("chop-long-lines") .long("chop-long-lines") .short('S') .action(ArgAction::SetTrue) .help("Truncate all lines longer than screen width. Alias for '--wrap=never'."), ) .arg( Arg::new("terminal-width") .long("terminal-width") .value_name("width") .hide_short_help(true) .allow_hyphen_values(true) .value_parser( |t: &str| { let is_offset = t.starts_with('+') || t.starts_with('-'); t.parse::() .map_err(|_e| "must be an offset or number") .and_then(|v| if v == 0 && !is_offset { Err("terminal width cannot be zero") } else { Ok(t.to_owned()) }) .map_err(|e| e.to_string()) }) .help( "Explicitly set the width of the terminal instead of determining it \ automatically. If prefixed with '+' or '-', the value will be treated \ as an offset to the actual terminal width. See also: '--wrap'.", ), ) .arg( Arg::new("number") .long("number") .overrides_with("number") .short('n') .action(ArgAction::SetTrue) .help("Show line numbers (alias for '--style=numbers').") .long_help( "Only show line numbers, no other decorations. This is an alias for \ '--style=numbers'", ), ) .arg( Arg::new("color") .long("color") .overrides_with("color") .value_name("when") .value_parser(["auto", "never", "always"]) .hide_default_value(true) .default_value("auto") .help("When to use colors (*auto*, never, always).") .long_help( "Specify when to use colored output. The automatic mode \ only enables colors if an interactive terminal is detected - \ colors are automatically disabled if the output goes to a pipe.\n\ Possible values: *auto*, never, always.", ), ) .arg( Arg::new("italic-text") .long("italic-text") .value_name("when") .value_parser(["always", "never"]) .default_value("never") .hide_default_value(true) .help("Use italics in output (always, *never*)") .long_help("Specify when to use ANSI sequences for italic text in the output. Possible values: always, *never*."), ) .arg( Arg::new("decorations") .long("decorations") .overrides_with("decorations") .value_name("when") .value_parser(["auto", "never", "always"]) .default_value("auto") .hide_default_value(true) .help("When to show the decorations (*auto*, never, always).") .long_help( "Specify when to use the decorations that have been specified \ via '--style'. The automatic mode only enables decorations if \ an interactive terminal is detected. Possible values: *auto*, never, always.", ), ) .arg( Arg::new("force-colorization") .long("force-colorization") .short('f') .action(ArgAction::SetTrue) .conflicts_with("color") .conflicts_with("decorations") .overrides_with("force-colorization") .hide_short_help(true) .long_help("Alias for '--decorations=always --color=always'. This is useful \ if the output of bat is piped to another program, but you want \ to keep the colorization/decorations.") ) .arg( Arg::new("paging") .long("paging") .overrides_with("paging") .overrides_with("no-paging") .value_name("when") .value_parser(["auto", "never", "always"]) .default_value("auto") .hide_default_value(true) .help("Specify when to use the pager, or use `-P` to disable (*auto*, never, always).") .long_help( "Specify when to use the pager. To disable the pager, use \ --paging=never' or its alias,'-P'. To disable the pager permanently, \ set BAT_PAGER to an empty string. To control which pager is used, see the \ '--pager' option. Possible values: *auto*, never, always." ), ) .arg( Arg::new("no-paging") .short('P') .long("no-paging") .alias("no-pager") .action(ArgAction::SetTrue) .overrides_with("no-paging") .hide(true) .hide_short_help(true) .help("Alias for '--paging=never'") ) .arg( Arg::new("pager") .long("pager") .overrides_with("pager") .value_name("command") .hide_short_help(true) .help("Determine which pager to use.") .long_help( "Determine which pager is used. This option will override the \ PAGER and BAT_PAGER environment variables. The default pager is 'less'. \ To control when the pager is used, see the '--paging' option. \ Example: '--pager \"less -RF\"'." ), ) .arg( Arg::new("map-syntax") .short('m') .long("map-syntax") .action(ArgAction::Append) .value_name("glob:syntax") .help("Use the specified syntax for files matching the glob pattern ('*.cpp:C++').") .long_help( "Map a glob pattern to an existing syntax name. The glob pattern is matched \ on the full path and the filename. For example, to highlight *.build files \ with the Python syntax, use -m '*.build:Python'. To highlight files named \ '.myignore' with the Git Ignore syntax, use -m '.myignore:Git Ignore'. Note \ that the right-hand side is the *name* of the syntax, not a file extension.", ) ) .arg( Arg::new("ignored-suffix") .action(ArgAction::Append) .long("ignored-suffix") .hide_short_help(true) .help( "Ignore extension. For example:\n \ 'bat --ignored-suffix \".dev\" my_file.json.dev' will use JSON syntax, and ignore '.dev'" ) ) .arg( Arg::new("theme") .long("theme") .overrides_with("theme") .help("Set the color theme for syntax highlighting.") .long_help( "Set the theme for syntax highlighting. Use '--list-themes' to \ see all available themes. To set a default theme, add the \ '--theme=\"...\"' option to the configuration file or export the \ BAT_THEME environment variable (e.g.: export \ BAT_THEME=\"...\").", ), ) .arg( Arg::new("list-themes") .long("list-themes") .action(ArgAction::SetTrue) .help("Display all supported highlighting themes.") .long_help("Display a list of supported themes for syntax highlighting."), ) .arg( Arg::new("style") .long("style") .value_name("components") .overrides_with("style") .overrides_with("plain") .overrides_with("number") // Cannot use claps built in validation because we have to turn off clap's delimiters .value_parser(|val: &str| { let mut invalid_vals = val.split(',').filter(|style| { !&[ "auto", "full", "default", "plain", "header", "header-filename", "header-filesize", "grid", "rule", "numbers", "snip", #[cfg(feature = "git")] "changes", ].contains(style) }); if let Some(invalid) = invalid_vals.next() { Err(format!("Unknown style, '{}'", invalid)) } else { Ok(val.to_owned()) } }) .help( "Comma-separated list of style elements to display \ (*default*, auto, full, plain, changes, header, header-filename, header-filesize, grid, rule, numbers, snip).", ) .long_help( "Configure which elements (line numbers, file headers, grid \ borders, Git modifications, ..) to display in addition to the \ file contents. The argument is a comma-separated list of \ components to display (e.g. 'numbers,changes,grid') or a \ pre-defined style ('full'). To set a default style, add the \ '--style=\"..\"' option to the configuration file or export the \ BAT_STYLE environment variable (e.g.: export BAT_STYLE=\"..\").\n\n\ Possible values:\n\n \ * default: enables recommended style components (default).\n \ * full: enables all available components.\n \ * auto: same as 'default', unless the output is piped.\n \ * plain: disables all available components.\n \ * changes: show Git modification markers.\n \ * header: alias for 'header-filename'.\n \ * header-filename: show filenames before the content.\n \ * header-filesize: show file sizes before the content.\n \ * grid: vertical/horizontal lines to separate side bar\n \ and the header from the content.\n \ * rule: horizontal lines to delimit files.\n \ * numbers: show line numbers in the side bar.\n \ * snip: draw separation lines between distinct line ranges.", ), ) .arg( Arg::new("line-range") .long("line-range") .short('r') .action(ArgAction::Append) .value_name("N:M") .help("Only print the lines from N to M.") .long_help( "Only print the specified range of lines for each file. \ For example:\n \ '--line-range 30:40' prints lines 30 to 40\n \ '--line-range :40' prints lines 1 to 40\n \ '--line-range 40:' prints lines 40 to the end of the file\n \ '--line-range 40' only prints line 40\n \ '--line-range 30:+10' prints lines 30 to 40", ), ) .arg( Arg::new("list-languages") .long("list-languages") .short('L') .action(ArgAction::SetTrue) .conflicts_with("list-themes") .help("Display all supported languages.") .long_help("Display a list of supported languages for syntax highlighting."), ) .arg( Arg::new("unbuffered") .short('u') .long("unbuffered") .action(ArgAction::SetTrue) .hide_short_help(true) .long_help( "This option exists for POSIX-compliance reasons ('u' is for \ 'unbuffered'). The output is always unbuffered - this option \ is simply ignored.", ), ) .arg( Arg::new("no-config") .long("no-config") .action(ArgAction::SetTrue) .hide(true) .help("Do not use the configuration file"), ) .arg( Arg::new("no-custom-assets") .long("no-custom-assets") .action(ArgAction::SetTrue) .hide(true) .help("Do not load custom assets"), ) .arg( Arg::new("config-file") .long("config-file") .action(ArgAction::SetTrue) .conflicts_with("list-languages") .conflicts_with("list-themes") .hide(true) .help("Show path to the configuration file."), ) .arg( Arg::new("generate-config-file") .long("generate-config-file") .action(ArgAction::SetTrue) .conflicts_with("list-languages") .conflicts_with("list-themes") .hide(true) .help("Generates a default configuration file."), ) .arg( Arg::new("config-dir") .long("config-dir") .action(ArgAction::SetTrue) .hide(true) .help("Show bat's configuration directory."), ) .arg( Arg::new("cache-dir") .long("cache-dir") .action(ArgAction::SetTrue) .hide(true) .help("Show bat's cache directory."), ) .arg( Arg::new("diagnostic") .long("diagnostic") .alias("diagnostics") .action(ArgAction::SetTrue) .hide_short_help(true) .help("Show diagnostic information for bug reports.") ) .arg( Arg::new("acknowledgements") .long("acknowledgements") .action(ArgAction::SetTrue) .hide_short_help(true) .help("Show acknowledgements."), ); // Check if the current directory contains a file name cache. Otherwise, // enable the 'bat cache' subcommand. if Path::new("cache").exists() { app } else { app.subcommand( Command::new("cache") .hide(true) .about("Modify the syntax-definition and theme cache") .arg( Arg::new("build") .long("build") .short('b') .action(ArgAction::SetTrue) .help("Initialize (or update) the syntax/theme cache.") .long_help( "Initialize (or update) the syntax/theme cache by loading from \ the source directory (default: the configuration directory).", ), ) .arg( Arg::new("clear") .long("clear") .short('c') .action(ArgAction::SetTrue) .help("Remove the cached syntax definitions and themes."), ) .group( ArgGroup::new("cache-actions") .args(&["build", "clear"]) .required(true), ) .arg( Arg::new("source") .long("source") .requires("build") .value_name("dir") .help("Use a different directory to load syntaxes and themes from."), ) .arg( Arg::new("target") .long("target") .requires("build") .value_name("dir") .help( "Use a different directory to store the cached syntax and theme set.", ), ) .arg( Arg::new("blank") .long("blank") .action(ArgAction::SetTrue) .requires("build") .help( "Create completely new syntax and theme sets \ (instead of appending to the default sets).", ), ) .arg( Arg::new("acknowledgements") .long("acknowledgements") .action(ArgAction::SetTrue) .requires("build") .help("Build acknowledgements.bin."), ), ) .after_long_help( "You can use 'bat cache' to customize syntaxes and themes. \ See 'bat cache --help' for more information", ) } } #[test] fn verify_app() { build_app(false).debug_assert(); }