Add numbered shortcuts and filter search to Question select/checkbox

[RR5555]

PR Description

This PR adds the questionary options use_shortcuts & use_filter_search to Copier Question, to allow the usage of numbered shortcuts for select questions, and filter search for select/checkbox questions.

It addresses Issue #2155

It adds two new attributes to the Question class:

• use_shortcuts: bool
• use_filter_search: bool

Which are passed down to questionary, thus producing the desired effect.

Note

use_filter_search is not compatible with use_jk_keys questionary option which is activated by default. Thus, when use_filter_search is True for a select/checkbox question, we pass and put use_jk_keys to False.

Choice

Although, it is possible to pass both {use_filter_search: True, use_shortcuts: True} for select questions, I have decided to make use_filter_search have precedence over use_shortcuts to avoid any ambiguity. Thus, if both are True for a select question, only use_filter_search is passed and activated.

Usage

use_shortcuts

copier.yaml

 select:
     type: str
     help: Select one option only
     use_shortcuts: true
     default: first
     choices:
         one: first
         two: second
         three: third

This will display:

1) one
2) two
3) three

And pressing 3 will direct the cursor onto 3) three .

use_filter_search

copier.yaml

checkbox:
    type: str
    help: Select any
    multiselect: true
    use_filter_search: true
    choices:
        one: first
        two: second
        three: third
        four: fourth

Pressing t will make a field appeared at the bottom left with / t... while only showing:

o two
o three

Next, pressing w will change the bottom field to / tw.. while only showing:

o two

Pressing Backspace will delete the searched letter one at a time, allowing for correction or new/additional filter search.

Limitation

The two new attributes are only booleans, they are not str|bool, and not rendered.

[codecov]

Codecov Report

❌ Patch coverage is 91.00000% with 9 lines in your changes missing coverage. Please review.
✅ Project coverage is 96.81%. Comparing base (4e969bf) to head (aa1c05a).
⚠️ Report is 114 commits behind head on master.

Files with missing lines	Patch %	Lines
copier/_user_data.py	47.05%	9 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##           master    #2446      +/-   ##
==========================================
- Coverage   97.17%   96.81%   -0.37%     
==========================================
  Files          60       61       +1     
  Lines        7147     7246      +99     
==========================================
+ Hits         6945     7015      +70     
- Misses        202      231      +29     

Flag	Coverage Δ
unittests	96.81% <91.00%> (-0.37%)	⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

[sisp]

Thanks for contributing these great enhancements of choice questions, @RR5555! 🙏

I have a few inline remarks. And could you please document these settings in the docs?

[RR5555]

Thank you for reviewing another of my PRs ^^

I had a first go at the documentation of the settings (docs(docs/configuring.md): add docs for use_shortcuts & use_search_filter[f8c695e]).
Please let me know what you think.

[RR5555]

Thank you for your previous round of review. Sorry for the delay.
Please let me know if I have missed something, or if other improvements are required.

[sisp]

Looks great, thank you! 👍 Just a minor request and a question, then we're ready to merge. 🎉