Generalize --detect-color-scheme to --color-scheme

assets/completions/_bat.ps1.in

@@ -32,7 +32,7 @@ Register-ArgumentCompleter -Native -CommandName '{{PROJECT_EXECUTABLE}}' -Script
             [CompletionResult]::new('--color', 'color', [CompletionResultType]::ParameterName, 'When to use colors (*auto*, never, always).')
             [CompletionResult]::new('--italic-text', 'italic-text', [CompletionResultType]::ParameterName, 'Use italics in output (always, *never*)')
             [CompletionResult]::new('--decorations', 'decorations', [CompletionResultType]::ParameterName, 'When to show the decorations (*auto*, never, always).')
-            [CompletionResult]::new('--detect-color-scheme', 'detect-color-scheme', [CompletionResultType]::ParameterName, 'When to detect the terminal''s color scheme (*auto*, never, always).')
+            [CompletionResult]::new('--color-scheme', 'color-scheme', [CompletionResultType]::ParameterName, 'Whether to choose a dark or light syntax highlighting theme (*auto*, auto:always, dark, light, system).')
             [CompletionResult]::new('--paging', 'paging', [CompletionResultType]::ParameterName, 'Specify when to use the pager, or use `-P` to disable (*auto*, never, always).')
             [CompletionResult]::new('--pager', 'pager', [CompletionResultType]::ParameterName, 'Determine which pager to use.')
             [CompletionResult]::new('-m', 'm', [CompletionResultType]::ParameterName, 'Use the specified syntax for files matching the glob pattern (''*.cpp:C++'').')

assets/completions/bat.bash.in

@@ -99,10 +99,12 @@ _bat() {
 		COMPREPLY=($(compgen -W "auto never character" -- "$cur"))
 		return 0
 		;;
-	--color | --decorations | --paging | --detect-color-scheme)
+	--color | --decorations | --paging)
 		COMPREPLY=($(compgen -W "auto never always" -- "$cur"))
 		return 0
 		;;
+	--color-scheme)
+		COMPREPLY=($(compgen -W "auto auto:always dark light system" -- "$cur"))
 	--italic-text)
 		COMPREPLY=($(compgen -W "always never" -- "$cur"))
 		return 0
@@ -164,7 +166,6 @@ _bat() {
 			--color
 			--italic-text
 			--decorations
-			--detect-color-scheme
 			--force-colorization
 			--paging
 			--pager
@@ -173,6 +174,7 @@ _bat() {
 			--theme
 			--theme-dark
 			--theme-light
+			--color-scheme
 			--list-themes
 			--style
 			--line-range

assets/completions/bat.fish.in

@@ -99,7 +99,13 @@ set -l color_opts '
 '
 set -l decorations_opts $color_opts
 set -l paging_opts $color_opts
-set -l detect_color_scheme_opts $color_opts
+set -l color_scheme_opts "
+    auto\t'Use the terminal\'s color scheme if the output is not redirected (default)'
+    auto:always\t'Always use the terminal\'s color scheme'
+    dark\t'Use a dark syntax highlighting theme'
+    light\t'Use a light syntax highlighting theme'
+    system\t'Query the OS for its color scheme (macOS only)'
+"
 
 # Include some examples so we can indicate the default.
 set -l pager_opts '
@@ -142,7 +148,7 @@ complete -c $bat -l config-file -f -d "Display location of configuration file" -
 
 complete -c $bat -l decorations -x -a "$decorations_opts" -d "When to use --style decorations" -n __bat_no_excl_args
 
-complete -c $bat -l detect-color-scheme -x -a "$detect_color_scheme_opts" -d "When to detect the terminal's color scheme" -n __bat_no_excl_args
+complete -c $bat -l color-scheme -x -a "$color_scheme_opts" -d "Whether to choose a dark or light syntax highlighting theme" -n __bat_no_excl_args
 
 complete -c $bat -l diagnostic -d "Print diagnostic info for bug reports" -n __fish_is_first_arg
 

assets/completions/bat.zsh.in

@@ -40,7 +40,7 @@ _{{PROJECT_EXECUTABLE}}_main() {
         --color='[specify when to use colors]:when:(auto never always)'
         --italic-text='[use italics in output]:when:(always never)'
         --decorations='[specify when to show the decorations]:when:(auto never always)'
-        --detect-color-scheme="[specify when to detect the terminal's color scheme]:when:(auto never always)"
+        --color-scheme="[whether to choose a dark or light syntax highlighting theme]:scheme:(auto auto:always dark light system)"
         --paging='[specify when to use the pager]:when:(auto never always)'
         '(-m --map-syntax)'{-m+,--map-syntax=}'[map a glob pattern to an existing syntax name]: :->syntax-maps'
         '(--theme)'--theme='[set the color theme for syntax highlighting]:theme:->themes'

doc/long-help.txt

@@ -114,22 +114,22 @@ Options:
           add the '--theme="..."' option to the configuration file or export the BAT_THEME
           environment variable (e.g.: export BAT_THEME="...").
 
-      --detect-color-scheme <when>
-          Specify when to query the terminal for its colors in order to pick an appropriate syntax
-          highlighting theme. Use '--theme-light' and '--theme-dark' (or the environment variables
-          BAT_THEME_LIGHT and BAT_THEME_DARK) to configure which themes are picked. You may also use
-          '--theme' to set a theme that is used regardless of the terminal's colors.
+      --color-scheme <scheme>
+          Specify whether to choose a dark or light syntax highlighting theme. Use '--theme-light'
+          and '--theme-dark' (or the environment variables BAT_THEME_LIGHT and BAT_THEME_DARK) to
+          configure which themes are picked. You may also use '--theme' to set a theme that is used
+          regardless of this choice.
 
           Possible values:
           * auto (default):
-               Only query the terminals colors if the output is not redirected. This is to prevent
-               race conditions with pagers such as less.
-          * never
-               Never query the terminal for its colors and assume that the terminal has a dark
-               background.
-          * always
-               Always query the terminal for its colors, regardless of whether or not the output is
-               redirected.
+              Query the terminals for its color scheme if the output is not redirected. This is to
+              prevent race conditions with pagers such as less.
+          * 'auto:always':
+              Always query the terminal for its color scheme, regardless of whether or not the
+              output is redirected.
+          * dark: Use a dark syntax highlighting theme.
+          * light: Use a light syntax highlighting theme.
+          * system: Query the OS for its color scheme. Only works on macOS.
 
       --theme-light <theme>
           Sets the theme name for syntax highlighting used when the terminal uses a light

doc/short-help.txt

@@ -41,8 +41,8 @@ Options:
           Use the specified syntax for files matching the glob pattern ('*.cpp:C++').
       --theme <theme>
           Set the color theme for syntax highlighting.
-      --detect-color-scheme <when>
-          Specify when to query the terminal for its colors.
+      --color-scheme <scheme>
+          Specify whether to choose a dark or light theme.
       --theme-light <theme>
           Sets the color theme for syntax highlighting used for light backgrounds.
       --theme-dark <theme>

src/bin/bat/app.rs

@@ -8,7 +8,7 @@ use crate::{
     clap_app,
     config::{get_args_from_config_file, get_args_from_env_opts_var, get_args_from_env_vars},
 };
-use bat::theme::{theme, DetectColorScheme, ThemeOptions, ThemeRequest};
+use bat::theme::{theme, ColorSchemePreference, DetectColorScheme, ThemeOptions, ThemeRequest};
 use bat::StripAnsiMode;
 use clap::ArgMatches;
 
@@ -408,20 +408,22 @@ impl App {
             theme,
             theme_dark,
             theme_light,
-            detect_color_scheme: self.detect_color_scheme(),
+            color_scheme: self.color_scheme_preference(),
         }
     }
 
-    pub(crate) fn detect_color_scheme(&self) -> DetectColorScheme {
+    pub(crate) fn color_scheme_preference(&self) -> ColorSchemePreference {
         match self
             .matches
-            .get_one::<String>("detect-color-scheme")
+            .get_one::<String>("color-scheme")
             .map(|s| s.as_str())
         {
-            Some("auto") => DetectColorScheme::Auto,
-            Some("never") => DetectColorScheme::Never,
-            Some("always") => DetectColorScheme::Always,
-            _ => unreachable!("other values for --detect-color-scheme are not allowed"),
+            Some("auto") => ColorSchemePreference::Auto(DetectColorScheme::Auto),
+            Some("auto:always") => ColorSchemePreference::Auto(DetectColorScheme::Always),
+            Some("dark") => ColorSchemePreference::Dark,
+            Some("light") => ColorSchemePreference::Light,
+            Some("system") => ColorSchemePreference::System,
+            _ => unreachable!("other values for --color-scheme are not allowed"),
         }
     }
 }

src/bin/bat/clap_app.rs

@@ -382,30 +382,30 @@ pub fn build_app(interactive_output: bool) -> Command {
                 ),
         )
         .arg(
-            Arg::new("detect-color-scheme")
-                .long("detect-color-scheme")
-                .overrides_with("detect-color-scheme")
-                .value_name("when")
-                .value_parser(["auto", "never", "always"])
+            Arg::new("color-scheme")
+                .long("color-scheme")
+                .overrides_with("color-scheme")
+                .value_name("scheme")
+                .value_parser(["auto", "auto:always", "dark", "light", "system"])
                 .default_value("auto")
                 .hide_default_value(true)
-                .help("Specify when to query the terminal for its colors.")
+                .help("Specify whether to choose a dark or light theme.")
                 .long_help(
-                    "Specify when to query the terminal for its colors \
-                     in order to pick an appropriate syntax highlighting theme. \
+                    "Specify whether to choose a dark or light syntax highlighting theme. \
                      Use '--theme-light' and '--theme-dark' (or the environment variables \
                      BAT_THEME_LIGHT and BAT_THEME_DARK) to configure which themes are picked. \
-                     You may also use '--theme' to set a theme that is used regardless of the terminal's colors.\n\n\
+                     You may also use '--theme' to set a theme that is used regardless of this choice.\n\n\
                      Possible values:\n\
-                     * auto (default):\n     \
-                            Only query the terminals colors if the output is not redirected. \
+                     * auto (default):\n    \
+                            Query the terminals for its color scheme if the output is not redirected. \
                             This is to prevent race conditions with pagers such as less.\n\
-                     * never\n     \
-                           Never query the terminal for its colors \
-                           and assume that the terminal has a dark background.\n\
-                     * always\n     \
-                           Always query the terminal for its colors, \
-                           regardless of whether or not the output is redirected."),
+                     * 'auto:always':\n    \
+                            Always query the terminal for its color scheme, \
+                            regardless of whether or not the output is redirected.\n\
+                     * dark: Use a dark syntax highlighting theme.\n\
+                     * light: Use a light syntax highlighting theme.\n\
+                     * system: Query the OS for its color scheme. Only works on macOS.\n\
+                     "),
         )
         .arg(
             Arg::new("theme-light")

src/bin/bat/main.rs

@@ -35,7 +35,7 @@ use bat::{
     error::*,
     input::Input,
     style::{StyleComponent, StyleComponents},
-    theme::{color_scheme, default_theme, ColorScheme, DetectColorScheme},
+    theme::{color_scheme, default_theme, ColorScheme, ColorSchemePreference},
     MappingTarget, PagingMode,
 };
 
@@ -193,7 +193,7 @@ pub fn list_themes(
     cfg: &Config,
     config_dir: &Path,
     cache_dir: &Path,
-    detect_color_scheme: DetectColorScheme,
+    color_scheme_pref: ColorSchemePreference,
 ) -> Result<()> {
     let assets = assets_from_cache_or_binary(cfg.use_custom_assets, cache_dir)?;
     let mut config = cfg.clone();
@@ -205,7 +205,7 @@ pub fn list_themes(
     let stdout = io::stdout();
     let mut stdout = stdout.lock();
 
-    let default_theme_name = default_theme(color_scheme(detect_color_scheme));
+    let default_theme_name = default_theme(color_scheme(color_scheme_pref));
     for theme in assets.themes() {
         let default_theme_info = if default_theme_name == theme {
             " (default)"
@@ -380,7 +380,12 @@ fn run() -> Result<bool> {
                 };
                 run_controller(inputs, &plain_config, cache_dir)
             } else if app.matches.get_flag("list-themes") {
-                list_themes(&config, config_dir, cache_dir, app.detect_color_scheme())?;
+                list_themes(
+                    &config,
+                    config_dir,
+                    cache_dir,
+                    app.color_scheme_preference(),
+                )?;
                 Ok(true)
             } else if app.matches.get_flag("config-file") {
                 println!("{}", config_file().to_string_lossy());