-
Notifications
You must be signed in to change notification settings - Fork 199
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
Add: guide for typescript setup #130
Open
vaibhavsingh97
wants to merge
2
commits into
nightwatchjs:versions/2.0
Choose a base branch
from
vaibhavsingh97:add/guides
base: versions/2.0
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,48 @@ | ||
# Typescript Setup | ||
|
||
We introduced a new tool called [Nightwatch Schematics][NightwatchSchematics], which helps you add Nightwatch config to your project, add sample tests and tsconfig for e2e tests. | ||
|
||
First, you need to add [Schematics CLI][SchematicsCli] globally. | ||
|
||
```bash | ||
npm install -g @angular-devkit/schematics-cli | ||
``` | ||
|
||
The above command will download schematics CLI, which is a template-based code generator. It helps in transforming a web-app project by generating or modifying code. | ||
|
||
|
||
After that, install Nightwatch-schematics in your project, using the below command: | ||
|
||
```bash | ||
npm install @nightwatch/schematics | ||
``` | ||
|
||
Once you have installed the Nightwatch schematics, you can add Nightwatch to your project by running: | ||
|
||
```bash | ||
schematics @nightwatch/schematics:ng-add | ||
``` | ||
|
||
It will prompt you with a set of questions that guides you through the setup of Nightwatch. You can also pass `--remove-protractor --environment='<chrome/firefox/safari>'` to skip the questionnaire and install it with the environment provided. | ||
|
||
This will create a `nightwatch` folder that contains tests and tsconfig, and `nightwatch.config.js` in the root folder. | ||
|
||
![Typescript Project structure](./../../images/typescript-demo.png) | ||
|
||
We had also added `scripts command` in `package.json`. You can start your e2e tests by running the `e2e:test` command: | ||
|
||
``` | ||
npm run e2e:test | ||
``` | ||
|
||
All Nightwatch CLI options will be available when triggering e2e tests, you just have to update `e2e:test` command. | ||
|
||
For example: | ||
Adding `--headless` will run e2e tests in headless mode | ||
|
||
``` | ||
"e2e:test": "./node_modules/.bin/tsc -p ./nightwatch/tsconfig.e2e.json && ./node_modules/.bin/nightwatch --env 'chrome' --config './nightwatch.conf.js'" --headless, | ||
``` | ||
|
||
[NightwatchSchematics]:https://github.com/nightwatchjs/nightwatch-schematics/ | ||
[SchematicsCli]:https://www.npmjs.com/package/@angular-devkit/schematics-cli |
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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.
We need a lot more info on how you can use Typescript with Nightwatch, also without schematics. We should have a section which will point to a boilerplate and details all the configs you need and shows a sample test.