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.

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

Publicize new CLI commands #995

Merged
merged 1 commit into from
Jun 9, 2023
Merged

Publicize new CLI commands #995

merged 1 commit into from
Jun 9, 2023

Conversation

graygilmore
Copy link
Contributor

@graygilmore graygilmore commented Jun 8, 2023

WHY are these changes introduced?

Now that all of the commands have been fleshed out with updated UX it's time to start exposing them properly!

WHAT is this pull request doing?

➜  demo-store git:(show-new-commands) h2 --help
Hydrogen commands

USAGE
  $ shopify hydrogen COMMAND

TOPICS
  hydrogen env       List the environments on your linked Hydrogen storefront.
  hydrogen generate  Generates a standard Shopify route.

COMMANDS
  hydrogen build             Builds a Hydrogen storefront for production.
  hydrogen check             Returns diagnostic information about a Hydrogen storefront.
  hydrogen codegen-unstable  Generate types for the Storefront API queries found in your project.
  hydrogen dev               Runs Hydrogen storefront in an Oxygen worker for development.
  hydrogen init              Creates a new Hydrogen storefront.
  hydrogen link              Link a local project to one of your shop's Hydrogen storefronts.
  hydrogen list              Returns a list of Hydrogen storefronts available on a given shop.
  hydrogen preview           Runs a Hydrogen storefront in an Oxygen worker for production.
  hydrogen shortcut          Creates a global `h2` shortcut for the Hydrogen CLI
  hydrogen unlink            Unlink a local project from a Hydrogen storefront.

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

static description = 'List the environments on your Hydrogen storefront.';

static hidden = true;
static description =
Copy link
Contributor Author

Choose a reason for hiding this comment

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

@gfscott I wonder if this would be a good time to review all of the descriptions we have for items? I'll be adding content to shopify.dev, too.

Copy link
Contributor

@frandiox frandiox left a comment

Choose a reason for hiding this comment

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

Let's go 🚀

One last question... do you think we need a flag to disable requesting the remote env vars in the dev command? Is there a scenario where someone doesn't want the remote env but needs the storefront to be linked for something else?

Also, perhaps we should get this at the same time: #997

@graygilmore
Copy link
Contributor Author

Is there a scenario where someone doesn't want the remote env but needs the storefront to be linked for something else?

That's a good question! I think in that case they could unlink and do whatever they needed to do. I don't want to fall into a case of flagitis ahead of time but I think it's something we can keep an eye on for feedback.

@graygilmore graygilmore marked this pull request as ready for review June 9, 2023 18:19
Copy link
Contributor

@blittle blittle left a comment

Choose a reason for hiding this comment

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

🎉

@graygilmore graygilmore merged commit 428c78d into 2023-04 Jun 9, 2023
@graygilmore graygilmore deleted the show-new-commands branch June 9, 2023 21:21
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants