docs(cookbook): Add local enum to typed-derive

Author: epage

examples/typed-derive/implicit.md

@@ -4,18 +4,35 @@ $ typed-derive implicit --help
 Usage: typed-derive implicit [OPTIONS]
 
 Options:
-  -O <OPTIMIZATION>      Implicitly using `std::str::FromStr`
-  -I <DIR>               Allow invalid UTF-8 paths
-      --bind <BIND>      Handle IP addresses
-      --sleep <SLEEP>    Allow human-readable durations
-  -h, --help             Print help
+  -O <OPTIMIZATION>
+          Implicitly using `std::str::FromStr`
+
+  -I <DIR>
+          Allow invalid UTF-8 paths
+
+      --bind <BIND>
+          Handle IP addresses
+
+      --sleep <SLEEP>
+          Allow human-readable durations
+
+      --bump-level <BUMP_LEVEL>
+          Custom enums
+
+          Possible values:
+          - major: Increase the major version (x.0.0)
+          - minor: Increase the minor version (x.y.0)
+          - patch: Increase the patch version (x.y.z)
+
+  -h, --help
+          Print help (see a summary with '-h')
 
 ```
 
 Optimization-level (number)
 ```console
 $ typed-derive implicit -O 1
-Implicit(ImplicitParsers { optimization: Some(1), include: None, bind: None, sleep: None })
+Implicit(ImplicitParsers { optimization: Some(1), include: None, bind: None, sleep: None, bump_level: None })
 
 $ typed-derive implicit -O plaid
 ? failed
@@ -28,14 +45,14 @@ For more information, try '--help'.
 Include (path)
 ```console
 $ typed-derive implicit -I../hello
-Implicit(ImplicitParsers { optimization: None, include: Some("../hello"), bind: None, sleep: None })
+Implicit(ImplicitParsers { optimization: None, include: Some("../hello"), bind: None, sleep: None, bump_level: None })
 
 ```
 
 IP Address
 ```console
 $ typed-derive implicit --bind 192.0.0.1
-Implicit(ImplicitParsers { optimization: None, include: None, bind: Some(192.0.0.1), sleep: None })
+Implicit(ImplicitParsers { optimization: None, include: None, bind: Some(192.0.0.1), sleep: None, bump_level: None })
 
 $ typed-derive implicit --bind localhost
 ? failed
@@ -48,7 +65,7 @@ For more information, try '--help'.
 Time
 ```console
 $ typed-derive implicit --sleep 10s
-Implicit(ImplicitParsers { optimization: None, include: None, bind: None, sleep: Some(10s) })
+Implicit(ImplicitParsers { optimization: None, include: None, bind: None, sleep: Some(10s), bump_level: None })
 
 $ typed-derive implicit --sleep forever
 ? failed
@@ -57,3 +74,24 @@ error: invalid value 'forever' for '--sleep <SLEEP>': failed to parse "forever"
 For more information, try '--help'.
 
 ```
+
+Version field
+```console
+$ typed-derive implicit --bump-level minor
+Implicit(ImplicitParsers { optimization: None, include: None, bind: None, sleep: None, bump_level: Some(Minor) })
+
+$ typed-derive implicit --bump-level 10.0.0
+? failed
+error: invalid value '10.0.0' for '--bump-level <BUMP_LEVEL>'
+  [possible values: major, minor, patch]
+
+For more information, try '--help'.
+
+$ typed-derive implicit --bump-level blue
+? failed
+error: invalid value 'blue' for '--bump-level <BUMP_LEVEL>'
+  [possible values: major, minor, patch]
+
+For more information, try '--help'.
+
+```

examples/typed-derive/implicit.rs

@@ -1,4 +1,5 @@
 use clap::Args;
+use clap::ValueEnum;
 
 #[derive(Args, Debug)]
 pub(crate) struct ImplicitParsers {
@@ -17,4 +18,45 @@ pub(crate) struct ImplicitParsers {
     /// Allow human-readable durations
     #[arg(long)]
     sleep: Option<jiff::SignedDuration>,
+
+    /// Custom enums
+    #[arg(long)]
+    bump_level: Option<BumpLevel>,
+}
+
+#[derive(Debug, Clone, Copy, ValueEnum)]
+#[value(rename_all = "kebab-case")]
+pub(crate) enum BumpLevel {
+    /// Increase the major version (x.0.0)
+    Major,
+    /// Increase the minor version (x.y.0)
+    Minor,
+    /// Increase the patch version (x.y.z)
+    Patch,
+}
+
+impl std::fmt::Display for BumpLevel {
+    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
+        use clap::ValueEnum;
+
+        self.to_possible_value()
+            .expect("no values are skipped")
+            .get_name()
+            .fmt(f)
+    }
+}
+
+impl std::str::FromStr for BumpLevel {
+    type Err = String;
+
+    fn from_str(s: &str) -> Result<Self, Self::Err> {
+        use clap::ValueEnum;
+
+        for variant in Self::value_variants() {
+            if variant.to_possible_value().unwrap().matches(s, false) {
+                return Ok(*variant);
+            }
+        }
+        Err(format!("Invalid variant: {s}"))
+    }
 }