-
Notifications
You must be signed in to change notification settings - Fork 497
fix: correct the command to show help in README.md #658
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
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for the PR
The npm create vue@latest -- --help command is correct on macOS and displays the help:
npm create vue@latest -- --help
Need to install the following packages:
create-vue@3.13.0
Ok to proceed? (y)
> npx
> create-vue --help
Usage: create-vue [FEATURE_FLAGS...] [OPTIONS...] [DIRECTORY]
Create a new Vue.js project.
Start the CLI in interactive mode when no FEATURE_FLAGS is provided, or if the DIRECTORY argument is not a valid package name.
Options:
--force
Create the project even if the directory is not empty.
--bare
Create a barebone project without example code.
--help
Display this help message.
--version
Display the version number of this CLI.
The npx version that works for you on Windows sadly doesn't work properly on macOS and executes create-vue as if a project was created:
npx create-vue@latest -- --help
Vue.js - The Progressive JavaScript Framework
✖ Add TypeScript ? ... No / Yes
@cexbrayat I tried again and found that:
- In
cmd, thenpmversion works but thenpxdoes not, jsut like on your MacOS. - In PowerShell, the
npxversion works but thenpmdoes not.
This is interesting. I'll investigate it later.
Anyway, I believe that it's a problem related to npm.
@cexbrayat OK, I think I found out the answer. It's the PowerShell who is causing this problem behind the scene. According to my test and this question, the syntax of PowerShell will treat -- specially, so executing npm create vue@latest -- --help will be treated as npm create vue@latest --help. A solution is to use npm create vue@latest '--' --help.
Do you think we should add a notice about this for Windows users?
Yes, maybe you can add a mention for Powershell users 👍
e25efa1 to
7a5bce2
Compare
@cexbrayat I've updated. Could you please review again?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thank you 👍
The old command will show the help of
npm create, not the help ofcreate-vue.Description
Current documentation says we can use
npm create vue@latest -- --helpto show the help ofcreate-vue, but I found it will print the help ofnpm create. I'm not sure if it's a bug ofnpm, butnpx create-vue@latest -- --helpworks fine.My Enviroment
Windows 11 + npm 10.9.0