Add numbered shortcuts and filter search to Question select/checkbox

copier/_user_data.py

@@ -203,6 +203,12 @@ class Question:
             If it is a boolean, it is used directly. If it is a str, it is
             converted to boolean using a parser similar to YAML, but only for
             boolean values.
+
+        use_shortcuts:
+            Condition that, if `True`, will use `use_shortcuts` in `select` question, allowing for selection via automatically numbered shortcut. Will be deactivated if `use_filter_search` is `True`.
+
+        use_filter_search:
+            Condition that, if `True`, uses `use_search_filter` in `checkbox`/`select` question while deactivating `use_jk_keys`, allowing for selection via filtering.
     """
 
     var_name: str
@@ -221,6 +227,8 @@ class Question:
     type: str = Field(default="", validate_default=True)
     validator: str = ""
     when: str | bool = True
+    use_shortcuts: bool = False
+    use_filter_search: bool = False
 
     @field_validator("var_name")
     @classmethod
@@ -419,6 +427,13 @@ def _validate(answer: str) -> str | Literal[True]:
                 result["default"] = False
         if self.choices:
             questionary_type = "checkbox" if self.multiselect else "select"
+
+            if self.use_filter_search:
+                result["use_search_filter"] = True
+                result["use_jk_keys"] = False
+            elif self.use_shortcuts and questionary_type == "select":
+                result["use_shortcuts"] = True
+
             choices = self._formatted_choices
             # Select default choices for a multiselect question.
             if self.multiselect and isinstance(

tests/test_shortcut.py

@@ -0,0 +1,234 @@
+from __future__ import annotations
+
+from collections import deque
+from textwrap import dedent
+
+import pexpect
+import pytest
+from plumbum import local
+
+from .helpers import (
+    BRACKET_ENVOPS,
+    BRACKET_ENVOPS_JSON,
+    COPIER_PATH,
+    SUFFIX_TMPL,
+    Keyboard,
+    Spawn,
+    build_file_tree,
+    expect_prompt,
+)
+
+BLK_START = BRACKET_ENVOPS["block_start_string"]
+BLK_END = BRACKET_ENVOPS["block_end_string"]
+
+
+@pytest.mark.parametrize(
+    "copier_file, input_select, result",
+    [
+        (
+            f"""\
+            _templates_suffix: {SUFFIX_TMPL}
+            _envops: {BRACKET_ENVOPS_JSON}
+            select:
+                type: str
+                help: Select one option only
+                use_shortcuts: true
+                default: first
+                choices:
+                    one: first
+                    two: second
+                    three: third
+            checkbox:
+                type: str
+                help: Select any
+                multiselect: true
+                use_filter_search: true
+                choices:
+                    one: first
+                    two: second
+                    three: third
+                    four: fourth
+            """,
+            "3",
+            dedent(
+                """\
+                    select: "third"
+                    checkbox: ["third"]
+                """,
+            ),
+        ),
+        (
+            f"""\
+            _templates_suffix: {SUFFIX_TMPL}
+            _envops: {BRACKET_ENVOPS_JSON}
+            select:
+                type: str
+                help: Select one option only
+                default: first
+                choices:
+                    one: first
+                    two: second
+                    three: third
+            checkbox:
+                type: str
+                help: Select any
+                multiselect: true
+                choices:
+                    one: first
+                    two: second
+                    three: third
+                    four: fourth
+            """,
+            "3",
+            dedent(
+                """\
+                    select: "first"
+                    checkbox: ["first"]
+                """
+            ),
+        ),
+        (
+            f"""\
+            _templates_suffix: {SUFFIX_TMPL}
+            _envops: {BRACKET_ENVOPS_JSON}
+            select:
+                type: str
+                help: Select one option only
+                use_shortcuts: true
+                default: first
+                choices:
+                    one: first
+                    two: second
+                    three: third
+            checkbox:
+                type: str
+                help: Select any
+                multiselect: true
+                choices:
+                    one: first
+                    two: second
+                    three: third
+                    four: fourth
+            """,
+            "3",
+            dedent(
+                """\
+                    select: "third"
+                    checkbox: ["first"]
+                """
+            ),
+        ),
+        (
+            f"""\
+            _templates_suffix: {SUFFIX_TMPL}
+            _envops: {BRACKET_ENVOPS_JSON}
+            select:
+                type: str
+                help: Select one option only
+                default: first
+                choices:
+                    one: first
+                    two: second
+                    three: third
+            checkbox:
+                type: str
+                help: Select any
+                multiselect: true
+                use_filter_search: true
+                choices:
+                    one: first
+                    two: second
+                    three: third
+                    four: fourth
+            """,
+            "3",
+            dedent(
+                """\
+                    select: "first"
+                    checkbox: ["third"]
+                """
+            ),
+        ),
+        (
+            f"""\
+            _templates_suffix: {SUFFIX_TMPL}
+            _envops: {BRACKET_ENVOPS_JSON}
+            select:
+                type: str
+                help: Select one option only
+                use_filter_search: true
+                default: first
+                choices:
+                    one: first
+                    two: second
+                    three: third
+            checkbox:
+                type: str
+                help: Select any
+                multiselect: true
+                choices:
+                    one: first
+                    two: second
+                    three: third
+                    four: fourth
+            """,
+            "tw",
+            dedent(
+                """\
+                    select: "second"
+                    checkbox: ["first"]
+                """
+            ),
+        ),
+    ],
+)
+def test_shortcuts(
+    tmp_path_factory: pytest.TempPathFactory,
+    copier_file: str,
+    input_select: str,
+    result: str,
+    spawn: Spawn,
+) -> None:
+    """Test shortcuts."""
+    # tui = spawn(COPIER_PATH + ("copy", path, str(tmp_path)))
+
+    src, dst = map(tmp_path_factory.mktemp, ("src", "dst"))
+
+    with local.cwd(src):
+        build_file_tree(
+            {
+                "copier.yml": copier_file,
+                "results.txt.tmpl": """\
+                    select: [[select|tojson]]
+                    checkbox: [[checkbox|tojson]]
+                """,
+            }
+        )
+
+    tui = spawn(COPIER_PATH + ("copy", str(src), str(dst)))
+
+    expect_prompt(tui, "select", "str", help="Select one option only")
+    deque(
+        map(
+            tui.expect_exact,
+            [
+                "one",
+                "two",
+                "three",
+            ],
+        )
+    )
+    tui.send(input_select)
+    tui.send(Keyboard.Enter)
+
+    expect_prompt(tui, "checkbox", "str", help="Select any")
+    deque(
+        map(
+            tui.expect_exact,
+            ["one", "two", "three", "four"],
+        )
+    )
+    tui.send("th ")
+    tui.send(Keyboard.Enter)
+    tui.expect_exact(pexpect.EOF)
+    assert (dst / "results.txt").read_text() == result