Add create-nightwatch docs. #156
Conversation
garg3133
force-pushed
the
create-nightwatch
branch
from
251a8b5
to
d4115b2
Compare
| and answer a few questons. We'll setup everything for you based on your preferences. | ||
|
|
||
|
|
||
| If you'd like to skip all the questions (we'd assume best defualts for you), you can use the above commands with `--yes` or `-y` flag: |
There was a problem hiding this comment.
```suggestion
If you'd like to skip all the questions (we'd assume best defaults for you), you can use the above commands with `--yes` or `-y` flag:
|
|
||
| ##### 1) If you're in your existing project's root directory: | ||
|
|
||
| <pre><code class="language-bash">npm init nightwatch -- --yes |
There was a problem hiding this comment.
I don't think this is necessary because it's not intuitive at all what all those defaults will be and what will happen. I think if users will use this tool, they will always want to go through the questions, which in my opinion are very sensible and the number is pretty low.
Also many questions aren't yes/no, such as JavaScript vs TypeScript. Does the answer yes means JS? Or the test runner (default / mocha / cucumber)?
So I think we should simply remove this completely.
There was a problem hiding this comment.
How about just generating the default Nightwatch config file for them if they use the --yes option? The same config file which gets generated now when the users run their first test.
There was a problem hiding this comment.
On second thought, it wouldn't be a good idea to do so because we don't just generate the configuration file with this tool but also install all the required dependencies and if we just generate the same config file as we do now, we'd have to install a lot of unnecessary dependencies which is not a good idea at all.
|
|
||
| #### Usage | ||
|
|
||
| All you need to do is, run: |
There was a problem hiding this comment.
Would be really cool to have an animated gif that demo's the tool in action, such as the one in the schematics project or this video: https://vimeo.com/376838936
No description provided.