Add numbered shortcuts and filter search to Question select/checkbox

copier/_user_data.py

@@ -19,11 +19,12 @@
 from jinja2 import StrictUndefined, UndefinedError
 from jinja2.sandbox import SandboxedEnvironment
 from prompt_toolkit.lexers import PygmentsLexer
-from pydantic import ConfigDict, Field, field_validator
+from pydantic import ConfigDict, Field, field_validator, model_validator
 from pydantic.dataclasses import dataclass
 from pydantic_core.core_schema import ValidationInfo
 from pygments.lexers.data import JsonLexer, YamlLexer
 from questionary.prompts.common import Choice
+from typing_extensions import Self
 
 from copier._jinja_ext import UnsetError
 from copier._settings import SettingsModel
@@ -201,6 +202,17 @@ 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`, allows selecting choice question items via
+            number shortcuts. Mutually exclusive with `multiselect` and
+            `use_search_filter`.
+
+        use_search_filter:
+            Condition that, if `True`, enables filtering choice question items by
+            typing a search string. Disables j/k navigation, as "j" and "k" can be part
+            of a prefix and therefore cannot be used for navigation.  Mutually exclusive
+            with `use_shortcuts`.
     """
 
     var_name: str
@@ -219,6 +231,8 @@ class Question:
     type: str = Field(default="", validate_default=True)
     validator: str = ""
     when: str | bool = True
+    use_shortcuts: bool = False
+    use_search_filter: bool = False
 
     @field_validator("var_name")
     @classmethod
@@ -244,6 +258,19 @@ def _check_secret_question_default_value(
             raise ValueError("Secret question requires a default value")
         return v
 
+    @model_validator(mode="after")
+    def _check_no_multiselect_or_search_filter_with_use_shortcuts(self) -> Self:
+        if self.use_shortcuts:
+            if self.multiselect:
+                raise ValueError(
+                    f"[Question Name: `{self.var_name}`]\n    `use_shortcuts` & `multiselect` are mutually exclusive\n    Use either `use_shortcuts: true` or `multiselect: true`\n   "
+                )
+            if self.use_search_filter:
+                raise ValueError(
+                    f"[Question Name: `{self.var_name}`]\n    `use_shortcuts` & `use_search_filter` are mutually exclusive\n    Use either `use_shortcuts: true` or `use_search_filter: true`\n   "
+                )
+        return self
+
     def cast_answer(self, answer: Any) -> Any:
         """Cast answer to expected type."""
         type_name = self.get_type_name()
@@ -417,6 +444,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_search_filter:
+                result["use_search_filter"] = True
+                result["use_jk_keys"] = False
+            if self.use_shortcuts:
+                result["use_shortcuts"] = True
+
             choices = self._formatted_choices
             # Select default choices for a multiselect question.
             if self.multiselect and isinstance(

docs/configuring.md

@@ -193,6 +193,122 @@ Supported keys:
 - **multiselect**: When set to `true`, allows multiple choices. The answer will be a
     `list[T]` instead of a `T` where `T` is of type `type`.
 
+- **use_shortcuts**: When set to `true`, allows selecting choice question items via
+    number shortcuts. Mutually exclusive with `multiselect` and `use_search_filter`.
+
+    !!! example
+
+        ```yaml title="copier.yml"
+        language:
+            type: str
+            help: Which programming language do you use?
+            use_shortcuts: true
+            choices:
+                - python
+                - node
+                - c
+                - c++
+                - rust
+                - zig
+                - asm
+        ```
+
+        Will result in:
+
+        <!-- rumdl-disable -->
+        <pre>
+        <span style="font-weight:bold">🎤 Which programming language do you use?</span>
+           (Use shortcuts or arrow keys)
+         » 1) python
+           2) node
+           3) c
+           4) c++
+           5) rust
+           6) zig
+           7) asm
+        </pre>
+        <!-- rumdl-enable -->
+
+        Pressing `5` gives:
+
+        <!-- rumdl-disable -->
+        <pre>
+        <span style="font-weight:bold">🎤 Which programming language do you use?</span>
+           (Use shortcuts or arrow keys)
+           1) python
+           2) node
+           3) c
+           4) c++
+         » 5) rust
+           6) zig
+           7) asm
+        </pre>
+        <!-- rumdl-enable -->
+
+- **use_search_filter**: When set to `true`, enables filtering choice question items
+    by typing a search string. Also deactivates the use of `j`/`k` keys for navigation,
+    as these are captured as prompts for the search filter. Mutually exclusive with
+    `use_shortcuts`.
+
+    !!! note
+
+        If `multiselect` is `true`, you cannot use ++space++ in the search, as this would only select the choice item. If it is `false`, ++space++ can be used.
+
+    !!! example
+
+        ```yaml title="copier.yml"
+        language:
+            type: str
+            help: Which programming language do you use?
+            use_search_filter: true
+            choices:
+                - python
+                - node
+                - c
+                - c++
+                - rust
+                - zig
+                - asm
+        ```
+
+        <!-- rumdl-disable -->
+        <pre>
+        <span style="font-weight:bold">🎤 Which programming language do you use?</span>
+           (Use arrow keys, type to filter)
+         » python
+           node
+           c
+           c++
+           rust
+           zig
+           asm
+        </pre>
+        <!-- rumdl-enable -->
+
+        ---
+
+        Typing `o`:
+
+        <!-- rumdl-disable -->
+        <pre>
+        <span style="font-weight:bold">🎤 Which programming language do you use?</span>
+           (Use arrow keys, type to filter)
+         » python
+           node
+
+
+        / <span style="color:green;font-weight:bold">o</span>...
+        </pre>
+        <!-- rumdl-enable -->
+
+        ---
+
+        When the filter fails, all options are displayed.
+
+        ---
+
+        You can use ++backspace++ to modify the search filter.
+
 - **default**: Leave empty to force the user to answer. Provide a default to save them
     from typing it if it's quite common. When using `choices`, the default must be the
     choice _value_, not its _key_, and it must match its _type_. If values are quite

mkdocs.yml

@@ -59,6 +59,7 @@ markdown_extensions:
           class: mermaid
           format: !!python/name:pymdownx.superfences.fence_code_format
   - pymdownx.emoji
+  - pymdownx.keys
   - pymdownx.magiclink
   - toc:
       permalink: true