JoshuaKGoldberg / create-typescript-app

Quickstart-friendly TypeScript template with comprehensive, configurable, opinionated tooling. 💝
MIT License
1.18k stars 75 forks source link

📝 Documentation: Clarify how to operate the Clack prompt #1121

Closed johnnyreilly closed 10 months ago

johnnyreilly commented 10 months ago

Bug Report Checklist

Overview

image displaying a screenshot of the terminal with a message I am unclear on

As you can probably gather, I didn't work out how and ended up with everything to my chagrin!

Additional Info

n/a

github-actions[bot] commented 10 months ago

Uh oh! @johnnyreilly, the image you shared is missing helpful alt text. Check your issue body.

Alt text is an invisible description that helps screen readers describe images to blind or low-vision users. If you are using markdown to display images, add your alt text inside the brackets of the markdown image.

Learn more about alt text at Basic writing and formatting syntax: images on GitHub Docs.

JoshuaKGoldberg commented 10 months ago

Backing context: That prompt UI comes from Clack. Direct answer: You can press and on the keyboard to change the selected item, then space to select.

Screenshot of the Clack prompt from create-typescript-app. A first item (Add all-contributors to track contributions and display them in a README.md table. (--exclude-all-contributors)) is not selected. A second item (Add a GitHub Actions workflow to verify that PRs match an expected format.) is selected.

Was this not clear from the prompt? Do you think there should be some text to explain it?

johnnyreilly commented 10 months ago

Was this not clear from the prompt? Do you think there should be some text to explain it?

I can only say it wasn't clear to me. It's possible everyone else knows that this is how you do it:

You can press ↑ and ↓ on the keyboard to change the selected item, then space to select.

I'd encourage including the text above

JoshuaKGoldberg commented 10 months ago

👍 makes sense, I agree it's not super intuitive as is. Thanks for calling it out! Accepting PRs to add a small indication to the prompt.

johnnyreilly commented 10 months ago

I did try and work out how to add it just now but couldn't work it out. Can you advise where i'd tweak?

JoshuaKGoldberg commented 10 months ago

but couldn't work it out

err, what do you mean by this?

johnnyreilly commented 10 months ago

nevermind - found it

github-actions[bot] commented 10 months ago

:tada: This is included in version v1.51.0 :tada:

The release is available on:

Cheers! 📦🚀