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

quick start flags must be preceded by -- #37019

Closed
2 tasks done
SheetJSDev opened this issue Nov 11, 2022 · 5 comments · Fixed by #37041
Closed
2 tasks done

quick start flags must be preceded by -- #37019

SheetJSDev opened this issue Nov 11, 2022 · 5 comments · Fixed by #37041
Labels
good first issue Issue that doesn't require previous experience with Gatsby help wanted Issue with a clear description that the community can help with. type: documentation An issue or pull request for improving or updating Gatsby's documentation

Comments

@SheetJSDev
Copy link
Contributor

Preliminary Checks

Summary

Current docs:

"""
Flags are not positional, so these commands are equivalent:

  • npm init gatsby -y -ts my-site-name
  • npm init gatsby my-site-name -y -ts

"""

Running against Node 18.12.1 + npm 8.19.2 on macOS, the questionnaire shows up even with the -y flag.

To force the -y to be passed along, -- is needed. For example:

npm init gatsby -- -y -ts my-site-name

Steps to Resolve this Issue

Run the example commands, observe they do not appear to skip the questionnaire, and include examples that do behave as expected.

@SheetJSDev SheetJSDev added the type: documentation An issue or pull request for improving or updating Gatsby's documentation label Nov 11, 2022
@gatsbot gatsbot bot added the status: triage needed Issue or pull request that need to be triaged and assigned to a reviewer label Nov 11, 2022
@tyhopp
Copy link
Contributor

tyhopp commented Nov 14, 2022

Hi @SheetJSDev, thanks! You are correct, this seems to have changed in later npm versions.

If you or anyone else would like to pick this up the docs update would be for this page/section -> https://github.com/gatsbyjs/gatsby/blob/master/docs/docs/quick-start.md#use-flags

@tyhopp tyhopp added help wanted Issue with a clear description that the community can help with. good first issue Issue that doesn't require previous experience with Gatsby and removed status: triage needed Issue or pull request that need to be triaged and assigned to a reviewer labels Nov 14, 2022
@shogohida
Copy link
Contributor

Hi @tyhopp, can I take this issue?

@tyhopp
Copy link
Contributor

tyhopp commented Nov 15, 2022

Hi @tyhopp, can I take this issue?

Absolutely! We have a docs contribution guide with some info you might find helpful if this is your first contribution to Gatsby

shogohida added a commit to shogohida/gatsby that referenced this issue Nov 15, 2022
@shogohida
Copy link
Contributor

@tyhopp
I made a pull request so please have a look when you have time!

#37041

@tyhopp
Copy link
Contributor

tyhopp commented Nov 16, 2022

Thank you @shogohida!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
good first issue Issue that doesn't require previous experience with Gatsby help wanted Issue with a clear description that the community can help with. type: documentation An issue or pull request for improving or updating Gatsby's documentation
Projects
None yet
3 participants