docs(cookbook): Style cargo plugin

Inspired by part of the conversation at clap-rs#3234
epage · Aug 8, 2024 · 65625b0 · 65625b0
1 parent ecb4dca
commit 65625b0
Show file tree

Hide file tree

Showing 5 changed files with 35 additions and 1 deletion.
diff --git a/Cargo.lock b/Cargo.lock
diff --git a/Cargo.toml b/Cargo.toml
@@ -187,6 +187,7 @@ humantime = "2.1.0"
 snapbox = "0.6.16"
 shlex = "1.3.0"
 automod = "1.0.14"
+clap-cargo = { version = "0.14.1", default-features = false }
 
 [[example]]
 name = "demo"

diff --git a/examples/cargo-example-derive.rs b/examples/cargo-example-derive.rs
@@ -3,10 +3,21 @@ use clap::Parser;
 #[derive(Parser)] // requires `derive` feature
 #[command(name = "cargo")]
 #[command(bin_name = "cargo")]
+#[command(styles = CLAP_STYLING)]
 enum CargoCli {
     ExampleDerive(ExampleDeriveArgs),
 }
 
+// See also `clap_cargo::style::CLAP_STYLING`
+pub const CLAP_STYLING: clap::builder::styling::Styles = clap::builder::styling::Styles::styled()
+    .header(clap_cargo::style::HEADER)
+    .usage(clap_cargo::style::USAGE)
+    .literal(clap_cargo::style::LITERAL)
+    .placeholder(clap_cargo::style::PLACEHOLDER)
+    .error(clap_cargo::style::ERROR)
+    .valid(clap_cargo::style::VALID)
+    .invalid(clap_cargo::style::INVALID);
+
 #[derive(clap::Args)]
 #[command(version, about, long_about = None)]
 struct ExampleDeriveArgs {

diff --git a/examples/cargo-example.rs b/examples/cargo-example.rs
@@ -1,6 +1,7 @@
 fn main() {
     let cmd = clap::Command::new("cargo")
         .bin_name("cargo")
+        .styles(CLAP_STYLING)
         .subcommand_required(true)
         .subcommand(
             clap::command!("example").arg(
@@ -16,3 +17,13 @@ fn main() {
     let manifest_path = matches.get_one::<std::path::PathBuf>("manifest-path");
     println!("{manifest_path:?}");
 }
+
+// See also `clap_cargo::style::CLAP_STYLING`
+pub const CLAP_STYLING: clap::builder::styling::Styles = clap::builder::styling::Styles::styled()
+    .header(clap_cargo::style::HEADER)
+    .usage(clap_cargo::style::USAGE)
+    .literal(clap_cargo::style::LITERAL)
+    .placeholder(clap_cargo::style::PLACEHOLDER)
+    .error(clap_cargo::style::ERROR)
+    .valid(clap_cargo::style::VALID)
+    .invalid(clap_cargo::style::INVALID);
diff --git a/src/_cookbook/mod.rs b/src/_cookbook/mod.rs
@@ -15,6 +15,7 @@
 //! - Topics:
 //!   - Subcommands
 //!   - Cargo plugins
+//!   - custom terminal [styles][crate::Command::styles] (colors)
 //!
 //! find-like interface: [builder][find]
 //! - Topics: