From 6ad6e7047fbed827af9dc310791fce9b598c4622 Mon Sep 17 00:00:00 2001 From: james south Date: Wed, 18 Jul 2018 00:14:36 -0500 Subject: [PATCH 1/2] add helpful note and fix typo 1. I tried several times to create a project by running vue create in my git bash on Windows, it will work and create something for you, but the option selection using arrows and space bar did not work and thus I had no way of knowing what would be created, so a note to this effect would have helped a lot, perhaps it can help others??? 2. fix same typo in docs that was fixed in the script in #1882 --- docs/guide/creating-a-project.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/docs/guide/creating-a-project.md b/docs/guide/creating-a-project.md index b4e5953828..c0b9830303 100644 --- a/docs/guide/creating-a-project.md +++ b/docs/guide/creating-a-project.md @@ -8,6 +8,8 @@ To create a new project, run: vue create hello-world ``` +NOTE: The create script may behave unpredictably in git bash. If so, run it in Windows command prompt or other applicable terminal. + You will be prompted to pick a preset. You can either choose the default preset which comes with a basic Babel + ESLint setup, or select "Manually select features" to pick the features you need. ![CLI preview](/cli-new-project.png) @@ -43,7 +45,7 @@ Options: -i, --inlinePreset Skip prompts and use inline JSON string as preset -m, --packageManager Use specified npm client when installing dependencies -r, --registry Use specified npm registry when installing dependencies (only for npm) - -g, --git [message|false] Force / skip git intialization, optionally specify initial commit message + -g, --git [message|false] Force / skip git initialization, optionally specify initial commit message -f, --force Overwrite target directory if it exists -c, --clone Use git clone when fetching remote preset -x, --proxy Use specified proxy when creating project From 8f3a5ec43e2feefd9c4c7c9abd75a704a708a644 Mon Sep 17 00:00:00 2001 From: Evan You Date: Fri, 20 Jul 2018 09:23:59 -0400 Subject: [PATCH 2/2] Update creating-a-project.md --- docs/guide/creating-a-project.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/docs/guide/creating-a-project.md b/docs/guide/creating-a-project.md index c0b9830303..b8767a82da 100644 --- a/docs/guide/creating-a-project.md +++ b/docs/guide/creating-a-project.md @@ -8,7 +8,9 @@ To create a new project, run: vue create hello-world ``` -NOTE: The create script may behave unpredictably in git bash. If so, run it in Windows command prompt or other applicable terminal. +::: warning +If you are on Windows using Git Bash with minTTY, the interactive prompts will not work. You must launch the command as `winpty vue.cmd create hello-world`. +::: You will be prompted to pick a preset. You can either choose the default preset which comes with a basic Babel + ESLint setup, or select "Manually select features" to pick the features you need.