fix: read choices from clap args (#136)

Fixes #27
jdx · Oct 25, 2024 · 6a2fb88 · 6a2fb88
1 parent 37f5b53
commit 6a2fb88
Show file tree

Hide file tree

Showing 8 changed files with 535 additions and 165 deletions.
diff --git a/cli/tests/complete_word.rs b/cli/tests/complete_word.rs
@@ -59,6 +59,12 @@ fn complete_word_kitchen_sink() {
     assert_cmd("kitchen-sink.usage.kdl", &["--", "--shell", ""]).stdout("bash\nzsh\nfish\n");
 }
 
+#[test]
+fn complete_word_choices() {
+    assert_cmd("mise.usage.kdl", &["--", "env", "--shell", ""])
+        .stdout("bash\nfish\nnu\nxonsh\nzsh\n");
+}
+
 #[test]
 fn complete_word_shebang() {
     assert_cmd("example.sh", &["--", "-"]).stdout("--bar\n--defaulted\n--foo\n");

diff --git a/examples/mise.usage.kdl b/examples/mise.usage.kdl
diff --git a/lib/src/docs/markdown/cmd.rs b/lib/src/docs/markdown/cmd.rs
@@ -19,7 +19,7 @@ mod tests {
     #[test]
     fn test_render_markdown_cmd() {
         let ctx = MarkdownRenderer::new(&SPEC_KITCHEN_SINK).with_multi(true);
-        assert_snapshot!(ctx.render_cmd(&SPEC_KITCHEN_SINK.cmd).unwrap(), @r#####"
+        assert_snapshot!(ctx.render_cmd(&SPEC_KITCHEN_SINK.cmd).unwrap(), @r####"
         # `mycli`
 
         **Usage**: `mycli [FLAGS] <ARGS>… <SUBCOMMAND>`
@@ -34,15 +34,13 @@ mod tests {
 
         arg2 description
 
-        #### Choices
+        **Choices:**
 
         - `choice1`
         - `choice2`
         - `choice3`
 
-        #### Default
-
-        `default value`
+        **Default:** `default value`
 
         ### `<arg3>`
 
@@ -66,7 +64,7 @@ mod tests {
 
         ### `--shell <shell>`
 
-        #### Choices
+        **Choices:**
 
         - `bash`
         - `zsh`
@@ -75,6 +73,6 @@ mod tests {
         ## Subcommands
 
         * [`mycli plugin <SUBCOMMAND>`](/plugin.md)
-        "#####);
+        "####);
     }
 }
diff --git a/lib/src/docs/markdown/spec.rs b/lib/src/docs/markdown/spec.rs
@@ -40,15 +40,13 @@ mod tests {
 
         arg2 description
 
-        #### Choices
+        **Choices:**
 
         - `choice1`
         - `choice2`
         - `choice3`
 
-        #### Default
-
-        `default value`
+        **Default:** `default value`
 
         ### `<arg3>`
 
@@ -72,7 +70,7 @@ mod tests {
 
         ### `--shell <shell>`
 
-        #### Choices
+        **Choices:**
 
         - `bash`
         - `zsh`

diff --git a/lib/src/docs/markdown/templates/arg_template.md.tera b/lib/src/docs/markdown/templates/arg_template.md.tera
@@ -6,20 +6,16 @@
 {%- endif %}
 {%- if arg.choices %}
 
-{{ "#" | repeat(count=header_level) }}### Choices
+**Choices:**
 {% for choice in arg.choices.choices %}
 - `{{ choice }}`
 {%- endfor %}
 {%- endif %}
 {%- if arg.default %}
 
-{{ "#" | repeat(count=header_level) }}### Default
-
-`{{ arg.default }}`
+**Default:** `{{ arg.default }}`
 {%- endif %}
 {%- if arg.env %}
 
-{{ "#" | repeat(count=header_level) }}### Environment Variable
-
-`{{ arg.env }}`
+**Environment Variable:** `{{ arg.env }}`
 {%- endif -%}
diff --git a/lib/src/docs/markdown/templates/flag_template.md.tera b/lib/src/docs/markdown/templates/flag_template.md.tera
@@ -5,20 +5,16 @@
 {%- endif %}
 {%- if flag.arg.choices %}
 
-{{ "#" | repeat(count=header_level) }}### Choices
+**Choices:**
 {% for choice in flag.arg.choices.choices %}
 - `{{ choice }}`
 {%- endfor %}
 {%- endif %}
 {%- if flag.default %}
 
-{{ "#" | repeat(count=header_level) }}### Default
-
-`{{ flag.default }}`
+**Default:** `{{ flag.default }}`
 {%- endif %}
 {%- if flag.env %}
 
-{{ "#" | repeat(count=header_level) }}### Environment Variable
-
-`{{ flag.env }}`
+**Environment Variable:** `{{ flag.env }}`
 {%- endif -%}
diff --git a/lib/src/spec/arg.rs b/lib/src/spec/arg.rs
@@ -155,7 +155,12 @@ impl From<&clap::Arg> for SpecArg {
             arg.get_action(),
             clap::ArgAction::Count | clap::ArgAction::Append
         );
-        Self {
+        let choices = arg
+            .get_possible_values()
+            .iter()
+            .flat_map(|v| v.get_name_and_aliases().map(|s| s.to_string()))
+            .collect::<Vec<_>>();
+        let mut arg = Self {
             name: arg
                 .get_value_names()
                 .unwrap_or_default()
@@ -183,8 +188,13 @@ impl From<&clap::Arg> for SpecArg {
                         .join("|"),
                 )
             },
-            choices: None, // TODO: pull from clap
+            choices: None,
+        };
+        if !choices.is_empty() {
+            arg.choices = Some(SpecChoices { choices });
         }
+
+        arg
     }
 }
 

diff --git a/lib/src/spec/flag.rs b/lib/src/spec/flag.rs
@@ -244,12 +244,22 @@ impl From<&clap::Arg> for SpecFlag {
             .collect::<Vec<_>>();
         let name = get_name_from_short_and_long(&short, &long).unwrap_or_default();
         let arg = if let clap::ArgAction::Set | clap::ArgAction::Append = c.get_action() {
-            let arg = c
-                .get_value_names()
-                .map(|s| s.iter().map(|s| s.to_string()).join(" "))
-                .unwrap_or(name.clone())
-                .as_str()
-                .into();
+            let mut arg = SpecArg::from(
+                c.get_value_names()
+                    .map(|s| s.iter().map(|s| s.to_string()).join(" "))
+                    .unwrap_or(name.clone())
+                    .as_str(),
+            );
+
+            let choices = c
+                .get_possible_values()
+                .iter()
+                .flat_map(|v| v.get_name_and_aliases().map(|s| s.to_string()))
+                .collect::<Vec<_>>();
+            if !choices.is_empty() {
+                arg.choices = Some(SpecChoices { choices });
+            }
+
             Some(arg)
         } else {
             None