Add CLI shortcuts

[bluwy]

Changes

Adds CLI shortcuts as an easter egg for the dev server. (Updated image)

I didn't add for the preview server because adapters can implement they're own preview servers, and I don't want to indirectly raise the bar for adapters to also implement shortcuts because of user expectations

Testing

Tested manually (as in the screenshot)

Docs

n/a. We're merging this as an easter egg, so I don't think we should document this in the next minor blog or highlight this in the docs for example.

[changeset-bot]

🦋 Changeset detected

Latest commit: 2f596f9

The changes in this PR will be included in the next version bump.

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

[github-actions]

This PR is blocked because it contains a minor changeset. A reviewer will merge this at the next release if approved.

[matthewp]

What's the reasoning for the + enter? Is this a CLI shortcut convention that I'm not aware of?

[bluwy]

The + enter convention stems from here: vitejs/vite#14342. The issue is that we can only detect keypresses line-by-line, or char-by-char.

Reading by character requires setRawMode, but that disables all the default OS shortcuts like ctrl+c, running in background, and any rare OS handling that will be very hard for us to maintain.

Reading by line is much simpler as we don't hijack the shortcuts, but it requires a enter press to create a new line. It works like cin >> my_name in C++ for example.

[ematipico]

That's a lovely addition!

[matthewp]

Want @FredKSchott to review

[natemoo-re]

Okay I took a pass and cleaned up the formatting a bit. Unfortunately I'm not seeing the shortcuts logged automatically, the messages have to be manually triggered with h + enter. The server also seems to hang when I press r + enter.

I don't love that we have to parse each message to reformat them. Ideally Vite could return the resolved shortcuts (default + custom - disabled) from bindCLIShortcuts so we could format them on a single line.

[bluwy]

I don't love that we have to parse each message to reformat them. Ideally Vite could return the resolved shortcuts (default + custom - disabled) from bindCLIShortcuts so we could format them on a single line.

ICYMI there was also a discussion about it at #9159 (comment)

[sarah11918]

Docs approves the changeset!

Would suggest a PR adding these three commands here in docs: https://docs.astro.build/en/reference/cli-reference/#astro-dev

[matthewp]

@bluwy can you give an update on where this PR is, in regards to the things that prevented it from coming out in 4.0? My fuzzy recollection is that we didn't merge it because:

1. @FredKSchott wanted to tweak the UI a little bit
2. Worry about introducing something new right before the release.

Were those the other two reasons? (2) is no longer relevant, did (1) happen?

[bluwy]

Yeah I think no1 is the main one. Nate made some commits to the formatting recently and volunteered to take on it on standup today, so perhaps once that's settled, we can have Fred to take another look again.

Once the formatting is resolved, it should be ready.

[FredKSchott]

FYI this is unblocked by me assuming that there is no change to the startup UI! Essentially, merged as an easter-egg for now.

For the startup UI changes, I'd like to pair / work 1:1 with someone to design and then add some sort of help message to startup. @matthewp you can either have someone grab time with me on my calendar, or just assign me a Linear ticket, I'd be happy with either path.

[matthewp]

The easter egg idea was ok when it was in order to get it out before 4.0, but now we don't have that time pressure so let's do it the right way and design the UI.

[bluwy]

I've went ahead and cleanup the PR based on an internal discussion in team-platform. We decided to keep this as an easter egg as we want to add more helpful shortcuts, and the current list is a little short. We may also implement showing "tips" in the CLI that may reveal this feature in the future.

@sarah11918 from your approval comment, since we're keeping this as an easter egg, I think we want to hold off documenting it for now.

[sarah11918]

@bluwy Yup, approval still stands, and changeset looks great! 🫡

We've talked about it!

Merge day