cli(script): gen screenshot for cli helps

[Ellie-Yen]

Description

Add a script to generate screenshot of all cli help contents.

Checklist

• Add test cases to all the changes you introduce
• Run ./scripts/format and ./scripts/test locally to ensure this change passes linter check and test
• Test the changes on the local machine manually
• Update the documentation for the changes

Expected behavior

Execute scripts/gen_cli_help_screenshots.py will generate screenshots of cli help instructions

Steps to Test This Pull Request

1. Execute scripts/gen_cli_help_screenshots.py
2. Check each of content insides commitizen.cli's data is match its screenshot in docs/images/cli_help/ folder.

Additional context

Considering the purpose of the file is more closed to a script, put it into scripts folder.
Should add test and update the documentation accordinately after the change is accepted.

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 97.48%. Comparing base (120d514) to head (cba2c06).
Report is 255 commits behind head on master.

Additional details and impacted files

@@            Coverage Diff             @@
##           master    #1048      +/-   ##
==========================================
+ Coverage   97.33%   97.48%   +0.15%     
==========================================
  Files          42       55      +13     
  Lines        2104     2429     +325     
==========================================
+ Hits         2048     2368     +320     
- Misses         56       61       +5     

Flag	Coverage Δ
unittests	97.48% <ø> (+0.15%)	⬆️

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

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

[woile]

This looks super cool, do you think it's possible to generate animated gifs as well?

[Lee-W]

Hi @Ellie-Yen , thank you for your immediate PR! This looks promising! But there are a few things I will need your help with before we can merge it.

1. address the comments we have in separate files
2. reword the commit messages into ci instead of feat as they're not commitizen features but more like a documentation improvement

After we merge this one, there are a few steps we want to do

1. Add these images to the document (somewhere like https://commitizen-tools.github.io/commitizen/init/)
2. Automate the update images scripts in github actions

Thanks again for this cool script

[Lee-W]

Thank you for the prompt update! We're really close to merging.

[Lee-W]

Suggested change

	print(f'created {images_root}')
	print(f"Created {images_root}")

[Lee-W]

we can run ruff or black against these files to improve style consistency

[Ellie-Yen]

Okay. I run ruff fomat on this file and its style is consistent now.
Btw, I notice only commitizen and tests are included in the scripts/format as below.
Do you think including scripts and other folders is a good idea ?

[Lee-W]

yep, I think that what we should do

[Lee-W]

@Ellie-Yen Great job! I think we're good to merge this one, but I'll keep it open for a few days so that others can take a look. btw are you interested in finishing these
#1048 (review)

@woile @noirbizarre I'm planning on merging this one these days. Let me know if you have any thoughts. Thanks!

[Lee-W]

This looks super cool, do you think it's possible to generate animated gifs as well?

We could make it a future improvement 👍
These help texts might not be as useful. but for demonstrating the interactive TUI, it could be really helpful. I'm thinking of using https://docs.asciinema.org/

[Ellie-Yen]

Thanks for reviewing ~
I'll try https://docs.asciinema.org/ soon and let's see if it could get better !