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

Update quickstart CLI reference, expose routes flag #2009

Merged
merged 2 commits into from
Apr 16, 2024
Merged

Conversation

gfscott
Copy link
Contributor

@gfscott gfscott commented Apr 16, 2024

This PR does three things:

  1. Updates the --quickstart description. This was previously handled in plain markdown in the docs but with the new reference generated by the manifest it needs to be directly in the codebase;
  2. Un-hides the --routes flag for init. Not clear to me why it was hidden in the first place;
  3. Hides the --styling flag, which is no longer supported.

@gfscott gfscott requested a review from frandiox April 16, 2024 16:31
Copy link
Contributor

We detected some changes in packages/*/package.json or packages/*/src, and there are no updates in the .changeset.
If the changes are user-facing and should cause a version bump, run npm run changeset add to track your changes and include them in the next release CHANGELOG.
If you are making simple updates to examples or documentation, you do not need to add a changeset.

packages/cli/src/lib/flags.ts Outdated Show resolved Hide resolved
packages/cli/src/lib/flags.ts Outdated Show resolved Hide resolved
@@ -56,7 +56,6 @@ export default class Init extends Command {
routes: Flags.boolean({
description: 'Generate routes for all pages.',
env: 'SHOPIFY_HYDROGEN_FLAG_ROUTES',
hidden: true,
Copy link
Contributor

Choose a reason for hiding this comment

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

I think it was hidden because nobody asked for it. I added it for my own testing but didn't double check on flag name, etc. But I think it's OK 😅

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Yeah, in this case I'd like to make it public so that what's happening under the hood with --quickstart is documented.

@frandiox
Copy link
Contributor

You'll need to run npm run build in the CLI directory to update oclif.manifest.json

Hide styling flag

revert hiding styling flag, handled elsewhere
Copy link
Contributor

shopify bot commented Apr 16, 2024

Oxygen deployed a preview of your quickstart-describe branch. Details:

Storefront Status Preview link Deployment details Last update (UTC)
subscriptions ✅ Successful (Logs) Preview deployment Inspect deployment April 16, 2024 4:57 PM
custom-cart-method ✅ Successful (Logs) Preview deployment Inspect deployment April 16, 2024 4:57 PM
third-party-queries-caching ✅ Successful (Logs) Preview deployment Inspect deployment April 16, 2024 4:57 PM
optimistic-cart-ui ✅ Successful (Logs) Preview deployment Inspect deployment April 16, 2024 4:57 PM
vite ✅ Successful (Logs) Preview deployment Inspect deployment April 16, 2024 4:57 PM
skeleton ✅ Successful (Logs) Preview deployment Inspect deployment April 16, 2024 4:57 PM

Learn more about Hydrogen's GitHub integration.

@gfscott gfscott self-assigned this Apr 16, 2024
@gfscott gfscott merged commit 8dd0607 into main Apr 16, 2024
15 checks passed
@gfscott gfscott deleted the quickstart-describe branch April 16, 2024 17:14
@gfscott gfscott restored the quickstart-describe branch April 18, 2024 14:30
@michenly michenly deleted the quickstart-describe branch May 6, 2024 14:48
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.

None yet

3 participants