Add command to list environments

[graygilmore]

WHY are these changes introduced?

We're introducing the ability for developers to specify an environment to use variables from (#883) but they'd need to open the admin to see which branches are assigned to which environments in order to do so.

WHAT is this pull request doing?

Introduces a new env list command that will list all of the environments on the linked Hydrogen storefront that have a branch.

➜  demo-store git:(list-environments) ✗ h2 env list

Name        Branch   URL
──────────  ───────  ──────────────────────────────────────
Production  main     https://example.com
Staging     staging  https://staging-123.myshopify.dev
Queen       queen    https://queen-456.myshopify.dev
Preview     -        -

HOW to test your changes?

1. Pull the branch and navigate to the cli directory
2. Run npm run build
3. Navigate to the demo store directory cd ../../templates/demo-store
4. Run h2 env list (note: if h2 is unavailable run npx shopify hydrogen shortcut first) to see a list of your environments
   • You should be prompted to provide a shop
   • You should then be prompted to authenticate with that shop
   • You should be prompted that you need to link to a storefront
5. Confirm that the correct list of environments is shown

Checklist

• I've read the Contributing Guidelines
• I've considered possible cross-platform impacts (Mac, Linux, Windows)
• I've added a changeset if this PR contains user-facing or noteworthy changes
• I've added tests to cover my changes
• I've added or updated the documentation

[frandiox]

Looks good!

[frandiox]

Why do we need to filter out preview types? 🤔

[graygilmore]

This is a great question! I'm filtering it because it looks a little odd in the table because it doesn't have a branch or URL:

Name        Branch              URL
──────────  ──────────────────  ────────────────────────────────────────
Production  main                https://example.com
Staging     staging             https://staging-123.myshopify.dev
Preview

So it looks like it's dangling off the side. Maybe if I added something instead of empty strings?

Name        Branch              URL
──────────  ──────────────────  ────────────────────────────────────────
Production  main                https://example.com
Staging     staging             https://staging-123.myshopify.dev
Preview     -                   -

Actually that kind of looks good!

[frandiox]

Ah I see. But what would be the "branch" that we need to specify in this case in --branch? I guess we just omit it?

[graygilmore]

Exactly, Preview is the default. Right now environment names aren't unique so if you had multiple Staging branches there'd be no way to differentiate between them. Branches are unique on environments which is why we're using that field and making Preview default.

[graygilmore]

Force Push Patch Notes

• Combined renderMissingLink and renderMissingStorefront into a single file called render-errors.ts
• Stopped filtering out the Preview environment but made sure it always comes last in the list
• Added a comment around the production URL logic

[graygilmore]

Force Push Patch Notes

• Rebased with 2023-04 to fix merge conflict

[graygilmore]

Force Push Patch Notes

• Rebased with 2023-04 to fix failing test

[graygilmore]

Force Push Patch Notes

• Rebased with 2023-04 to fix merge conflicts
  • Most notable is that the first commit's changes move from pull.ts to pull-environment-variables.ts as that's where the logic moved to in a previously merged PR