More specific help message for --completions and an example for builtins to aid with testing it (#60)

Author: softdevca

crates/figue/examples/builtins.rs

@@ -0,0 +1,21 @@
+use figue::{self as args, FigueBuiltins};
+use facet::Facet;
+
+#[derive(Facet, Debug)]
+struct Args {
+    /// Your actual arguments
+    #[facet(args::positional)]
+    filename: String,
+
+    /// Provides standard CLI options like --help, --version and --completions
+    #[facet(flatten)]
+    builtins: FigueBuiltins,
+}
+
+fn main() {
+    // The builtins are automatically available. They will print their help, version or completion
+    // script and then exit.
+    let args: Args = figue::from_std_args().unwrap();
+    println!("A regular argument was provided: {}", args.filename);
+}
+

crates/figue/src/lib.rs

@@ -400,7 +400,7 @@ pub struct FigueBuiltins {
     #[facet(args::named, args::short = 'V', args::version, default)]
     pub version: bool,
 
-    /// Generate shell completions.
+    /// Generate shell completions for Bash, Fish, or Zsh.
     #[facet(args::named, args::completions, default)]
     pub completions: Option<Shell>,
 }

crates/figue/tests/integration/snapshots/main__integration__help__help_simple_struct.snap

@@ -1,5 +1,5 @@
 ---
-source: tests/integration/help.rs
+source: crates/figue/tests/integration/help.rs
 expression: "$crate :: common ::\nstrip_binary_paths(& $crate :: common :: strip_ansi(& help))"
 ---
 myapp 1.0.0
@@ -27,4 +27,4 @@ OPTIONS:
     -V, --version
             Show version and exit.
         --completions <SHELL>
-            Generate shell completions.
+            Generate shell completions for Bash, Fish, or Zsh.

crates/figue/tests/integration/snapshots/main__integration__help__help_with_subcommands.snap

@@ -1,5 +1,5 @@
 ---
-source: tests/integration/help.rs
+source: crates/figue/tests/integration/help.rs
 expression: "$crate :: common ::\nstrip_binary_paths(& $crate :: common :: strip_ansi(& help))"
 ---
 git 2.40.0
@@ -15,7 +15,7 @@ OPTIONS:
     -V, --version
             Show version and exit.
         --completions <SHELL>
-            Generate shell completions.
+            Generate shell completions for Bash, Fish, or Zsh.
 
 COMMANDS:
     clone

crates/figue/tests/integration/snapshots/main__integration__help__subcommand_root_help.snap

@@ -1,5 +1,5 @@
 ---
-source: tests/integration/help.rs
+source: crates/figue/tests/integration/help.rs
 expression: "$crate :: common ::\nstrip_binary_paths(& $crate :: common :: strip_ansi(& help))"
 ---
 <PROGRAM>
@@ -15,7 +15,7 @@ OPTIONS:
     -V, --version
             Show version and exit.
         --completions <SHELL>
-            Generate shell completions.
+            Generate shell completions for Bash, Fish, or Zsh.
 
 COMMANDS:
     install

crates/figue/tests/integration/snapshots/main__integration__help__tuple_variant_main_help.snap

@@ -1,5 +1,5 @@
 ---
-source: tests/integration/help.rs
+source: crates/figue/tests/integration/help.rs
 expression: "$crate :: common ::\nstrip_binary_paths(& $crate :: common :: strip_ansi(& help))"
 ---
 myapp
@@ -13,7 +13,7 @@ OPTIONS:
     -V, --version
             Show version and exit.
         --completions <SHELL>
-            Generate shell completions.
+            Generate shell completions for Bash, Fish, or Zsh.
 
 COMMANDS:
     build