Merge pull request #59 from epage/disable-colored-help

Add DisableColoredHelp setting to improve flexibility (clap-rs/clap#2956)

CHANGELOG.md

@@ -11,9 +11,6 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
 hands multiple times.  Unfortunately, our changelog might be incomplete,
 whether in changes or their motivation.
 
-TBD:
-- `AppSettings::ColoredHelp`: we are now relying solely on the `color` feature flag and `App::color` method
-
 ### Highlights
 
 **[StructOpt](https://docs.rs/structopt/) Integration**
@@ -111,6 +108,9 @@ Subtle changes (i.e. compiler won't catch):
 - `AppSettings::UnifiedHelpMessage` is now default behaviour
   - `{flags}` and `{unified}` will assert if present in `App::help_template`
   - See [clap-rs/clap#2807](https://github.com/clap-rs/clap/issues/2807)
+- `AppSettings::EnableColoredHelp` is now the default behavior but can be
+  opted-out with `AppSettings::DisableColoredHelp`
+  ([clap-rs/clap#2806](https://github.com/clap-rs/clap/issues/2806))
 - `App::override_usage` no longer implies a leading `\t`, allowing multi lined usages
 - `Arg::require_equals` no longer implies `ArgSettings::ForbidEmptyValues` ([#2233](https://github.com/clap-rs/clap/issues/2233))
 - `Arg::require_delimiter` no longer implies `ArgSettings::TakesValue` and `ArgSettings::UseValueDelimiter` ([#2233](https://github.com/clap-rs/clap/issues/2233))

src/build/app/settings.rs

@@ -25,6 +25,7 @@ bitflags! {
         const NO_POS_VALUES                  = 1 << 17;
         const NEXT_LINE_HELP                 = 1 << 18;
         const DERIVE_DISP_ORDER              = 1 << 19;
+        const DISABLE_COLORED_HELP           = 1 << 20;
         const COLOR_ALWAYS                   = 1 << 21;
         const COLOR_AUTO                     = 1 << 22;
         const COLOR_NEVER                    = 1 << 23;
@@ -99,6 +100,8 @@ impl_settings! { AppSettings, AppFlags,
         => Flags::DONT_COLLAPSE_ARGS,
     DeriveDisplayOrder("derivedisplayorder")
         => Flags::DERIVE_DISP_ORDER,
+    DisableColoredHelp("disablecoloredhelp")
+        => Flags::DISABLE_COLORED_HELP,
     DisableHelpSubcommand("disablehelpsubcommand")
         => Flags::DISABLE_HELP_SC,
     DisableHelpFlag("disablehelpflag")
@@ -571,6 +574,18 @@ pub enum AppSettings {
     /// [`Arg::use_delimiter(false)`]: crate::Arg::use_delimiter()
     DontDelimitTrailingValues,
 
+    /// Disables colorized help messages.
+    ///
+    /// # Examples
+    ///
+    /// ```no_run
+    /// # use clap::{App, AppSettings};
+    /// App::new("myprog")
+    ///     .setting(AppSettings::DisableColoredHelp)
+    ///     .get_matches();
+    /// ```
+    DisableColoredHelp,
+
     /// Disables `-h` and `--help` flag.
     ///
     /// # Examples
@@ -1194,6 +1209,10 @@ mod test {
             "derivedisplayorder".parse::<AppSettings>().unwrap(),
             AppSettings::DeriveDisplayOrder
         );
+        assert_eq!(
+            "disablecoloredhelp".parse::<AppSettings>().unwrap(),
+            AppSettings::DisableColoredHelp
+        );
         assert_eq!(
             "propagateversion".parse::<AppSettings>().unwrap(),
             AppSettings::PropagateVersion

src/lib.rs

@@ -24,13 +24,14 @@
 #[cfg(not(feature = "std"))]
 compile_error!("`std` feature is currently required to build `clap`");
 
+#[cfg(feature = "color")]
+pub use crate::util::color::ColorChoice;
 pub use crate::{
     build::{
         App, AppFlags, AppSettings, Arg, ArgFlags, ArgGroup, ArgSettings, PossibleValue, ValueHint,
     },
     parse::errors::{Error, ErrorKind, Result},
     parse::{ArgMatches, Indices, OsValues, Values},
-    util::color::ColorChoice,
 };
 
 pub use crate::derive::{ArgEnum, Args, FromArgMatches, IntoApp, Parser, Subcommand};

src/parse/parser.rs

@@ -19,7 +19,7 @@ use crate::{
     parse::features::suggestions,
     parse::{ArgMatcher, SubCommand},
     parse::{Validator, ValueType},
-    util::{ChildGraph, Id},
+    util::{color::ColorChoice, ChildGraph, Id},
     INTERNAL_ERROR_MSG, INVALID_UTF8,
 };
 
@@ -332,6 +332,16 @@ impl<'help, 'app> Parser<'help, 'app> {
             }
         }
     }
+
+    // Should we color the help?
+    pub(crate) fn color_help(&self) -> ColorChoice {
+        #[cfg(feature = "color")]
+        if self.is_set(AS::DisableColoredHelp) {
+            return ColorChoice::Never;
+        }
+
+        self.app.get_color()
+    }
 }
 
 // Parsing Methods
@@ -1869,7 +1879,7 @@ impl<'help, 'app> Parser<'help, 'app> {
     }