Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Improve style of prompts using rich #1901

Merged
merged 15 commits into from Aug 2, 2023
Merged

Improve style of prompts using rich #1901

merged 15 commits into from Aug 2, 2023

Conversation

vemonet
Copy link
Contributor

@vemonet vemonet commented Jul 17, 2023 •
edited

Hi, this PR adds rich to the cookiecutter dependencies and improve the style of the prompts without changing the prompt workflow

  • Add a counter, e.g. [1/10], at the start of each prompt so the user knows how many steps are left
  • Default values are shown between parenthesis in the cyan color
  • This enables cookiecutter template creators to use simple markup to style their questions, e.g. `What is [bold yellow]your name[/]"
  • The answers accepted for the different types of prompts are the same as before:
    • y/t/true/yes/on or n/f/false/no/off for boolean questions
    • Using integers for multiple choices questions
    • Json prompt supported the same was as before
  • Add a 2 spaces indent at the start of each prompts

You can find screenshots of the changes proposed in the issue #1885

I used rich as it seems the most mature, maintained, and popular package to style CLI apps in python

vemonet added 12 commits July 4, 2023 16:07
@vemonet
Added support for adding human readable description/question for each…
070049e 
… variable in the cookiecutter.json. Human readable questions are shown instead of variable names to the user when possible. cf. cookiecutter#1835
@vemonet
Only add select in choice questions when description is not defined
2350512
@vemonet
start adding rich
ef5fdec
@vemonet
merge with human readable prompts
5282df1
@vemonet
merge and improve rich prompts
df4c1c8
@vemonet
Fix tests, keep 100% coverage
f5936fd
@vemonet
add support for json prompt with rich
b5ce867
@vemonet
add tests for git config extraction, fix linting issues, reach 100% c…
428dbf9 
…overage

Add test for JsonPrompt process_response, reach 100% coverage
@vemonet
Merge branch 'main' into rich-prompts
40b9f4a
@vemonet
merge with upstream main and fix conflicts
3b42858
@vemonet
Extend the confirmation prompt to accept various yes/no answers, same…
fa32a8f 
… as before
@vemonet
add instructions to use rich markup to readme
91a50b5
@ericof ericof added this to the 2.3.0 milestone Jul 27, 2023
@ericof ericof added the enhancement This issue/PR relates to a feature request. label Jul 27, 2023
ericof
ericof reviewed Jul 27, 2023
View reviewed changes
.github/ISSUE_TEMPLATE/bug.yml Outdated
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Could you remove this file?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Oops, that was not supposed to be pushed in this branch! Well spotted, I removed it @ericof

ericof
ericof requested changes Jul 27, 2023
View reviewed changes
Copy link
Member

@ericof ericof left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Remove the bug.yml

@ericof ericof merged commit 90bd2f7 into cookiecutter:main Aug 2, 2023
21 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@ericof ericof ericof approved these changes

Assignees
No one assigned
Labels
enhancement This issue/PR relates to a feature request.
Projects
None yet
Milestone
2.3.0
Development

Successfully merging this pull request may close these issues.

None yet
2 participants
@vemonet @ericof