feat(help): Stabilize styling support

epage · epage · commit eb53db89f8d7 · 2023-08-28T09:49:48.000-05:00
Fixes #3234
diff --git a/Makefile b/Makefile
@@ -16,7 +16,7 @@ _FEATURES = minimal default wasm full debug release
 _FEATURES_minimal = --no-default-features --features "std"
 _FEATURES_default =
 _FEATURES_wasm = --no-default-features --features "std help usage error-context suggestions" --features "deprecated derive cargo env unicode string"
-_FEATURES_full = --features "deprecated derive cargo env unicode string wrap_help unstable-styles"
+_FEATURES_full = --features "deprecated derive cargo env unicode string wrap_help"
 _FEATURES_next = ${_FEATURES_full} --features unstable-v5
 _FEATURES_debug = ${_FEATURES_full} --features debug --features clap_complete/debug
 _FEATURES_release = ${_FEATURES_full} --release
diff --git a/clap_builder/Cargo.toml b/clap_builder/Cargo.toml
@@ -32,7 +32,7 @@ tag-name = "v{{version}}"
 [features]
 default = ["std", "color", "help", "usage", "error-context", "suggestions"]
 debug = ["dep:backtrace"] # Enables debug messages
-unstable-doc = ["cargo", "wrap_help", "env", "unicode", "string", "unstable-styles"] # for docs.rs
+unstable-doc = ["cargo", "wrap_help", "env", "unicode", "string"] # for docs.rs
 
 # Used in default
 std = ["anstyle/std"] # support for no_std in a backwards-compatible way
diff --git a/clap_builder/src/builder/command.rs b/clap_builder/src/builder/command.rs
@@ -1170,7 +1170,6 @@ impl Command {
     #[cfg(feature = "color")]
     #[inline]
     #[must_use]
-    #[cfg(feature = "unstable-styles")]
     pub fn styles(mut self, styles: Styles) -> Self {
         self.app_ext.set(styles);
         self
diff --git a/clap_builder/src/builder/mod.rs b/clap_builder/src/builder/mod.rs
@@ -23,10 +23,7 @@ mod debug_asserts;
 #[cfg(test)]
 mod tests;
 
-#[cfg(feature = "unstable-styles")]
 pub mod styling;
-#[cfg(not(feature = "unstable-styles"))]
-pub(crate) mod styling;
 
 pub use self::str::Str;
 pub use action::ArgAction;
@@ -40,7 +37,6 @@ pub use range::ValueRange;
 pub use resettable::IntoResettable;
 pub use resettable::Resettable;
 pub use styled_str::StyledStr;
-#[cfg(feature = "unstable-styles")]
 pub use styling::Styles;
 pub use value_hint::ValueHint;
 pub use value_parser::_AutoValueParser;
@@ -69,5 +65,3 @@ pub(crate) use self::str::Inner as StrInner;
 pub(crate) use action::CountType;
 pub(crate) use arg_settings::{ArgFlags, ArgSettings};
 pub(crate) use command::AppTag;
-#[cfg(not(feature = "unstable-styles"))]
-pub(crate) use styling::Styles;
diff --git a/clap_builder/src/builder/styling.rs b/clap_builder/src/builder/styling.rs
@@ -10,15 +10,13 @@ pub use anstyle::*;
 ///
 /// clap v3 styling
 /// ```rust
-/// # #[cfg(feature = "unstable-styles")] {
 /// # use clap_builder as clap;
 /// # use clap::builder::styling::*;
 /// let styles = Styles::styled()
 ///     .header(AnsiColor::Yellow.on_default())
 ///     .usage(AnsiColor::Green.on_default())
 ///     .literal(AnsiColor::Green.on_default())
 ///     .placeholder(AnsiColor::Green.on_default());
-/// # }
 /// ```
 #[derive(Clone, Debug)]
 #[allow(missing_copy_implementations)] // Large enough type that I want an explicit `clone()` for now
diff --git a/src/_features.rs b/src/_features.rs
@@ -26,4 +26,3 @@
 //! **Warning:** These may contain breaking changes between minor releases.
 //!
 //! * **unstable-v5**: Preview features which will be stable on the v5.0 release
-//! * **unstable-styles**: Custom theming support for clap
diff --git a/src/bin/stdio-fixture.rs b/src/bin/stdio-fixture.rs
@@ -12,7 +12,7 @@ fn main() {
                 .action(clap::ArgAction::SetTrue)
                 .long_help("more log"),
         );
-    #[cfg(feature = "unstable-styles")]
+    #[cfg(feature = "color")]
     {
         use clap::builder::styling;
         let styles = styling::Styles::styled()
diff --git a/tests/examples.rs b/tests/examples.rs
@@ -36,8 +36,6 @@ fn example_tests() {
         // In-work
         //#[cfg(feature = "unstable-v5")]  // Currently has failures
         //"unstable-v5",
-        #[cfg(feature = "unstable-styles")]
-        "unstable-styles",
     ]
     .join(" ");
     t.register_bins(trycmd::cargo::compile_examples(["--features", &features]).unwrap());
diff --git a/tests/ui.rs b/tests/ui.rs
@@ -36,8 +36,6 @@ fn ui_tests() {
         // In-work
         //#[cfg(feature = "unstable-v5")]  // Currently has failures
         //"unstable-v5",
-        #[cfg(feature = "unstable-styles")]
-        "unstable-styles",
     ]
     .join(" ");
     t.register_bins(trycmd::cargo::compile_examples(["--features", &features]).unwrap());

Original file line number	Diff line number	Diff line change
`@@ -12,7 +12,7 @@ fn main() {`
`12`	`12`	`.action(clap::ArgAction::SetTrue)`
`13`	`13`	`.long_help("more log"),`
`14`	`14`	`);`
`15`		`- #[cfg(feature = "unstable-styles")]`
	`15`	`+ #[cfg(feature = "color")]`
`16`	`16`	`{`
`17`	`17`	`use clap::builder::styling;`
`18`	`18`	`let styles = styling::Styles::styled()`
Original file line number	Diff line number	Diff line change
`@@ -36,8 +36,6 @@ fn example_tests() {`
`36`	`36`	`// In-work`
`37`	`37`	`//#[cfg(feature = "unstable-v5")] // Currently has failures`
`38`	`38`	`//"unstable-v5",`
`39`		`- #[cfg(feature = "unstable-styles")]`
`40`		`- "unstable-styles",`
`41`	`39`	`]`
`42`	`40`	`.join(" ");`
`43`	`41`	`t.register_bins(trycmd::cargo::compile_examples(["--features", &features]).unwrap());`
Original file line number	Diff line number	Diff line change
`@@ -36,8 +36,6 @@ fn ui_tests() {`
`36`	`36`	`// In-work`
`37`	`37`	`//#[cfg(feature = "unstable-v5")] // Currently has failures`
`38`	`38`	`//"unstable-v5",`
`39`		`- #[cfg(feature = "unstable-styles")]`
`40`		`- "unstable-styles",`
`41`	`39`	`]`
`42`	`40`	`.join(" ");`
`43`	`41`	`t.register_bins(trycmd::cargo::compile_examples(["--features", &features]).unwrap());`