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

Add: guide for typescript setup #130

Open
wants to merge 2 commits into
base: versions/2.0
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
48 changes: 48 additions & 0 deletions guide/using-nightwatch/typescript-setup.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
# Typescript Setup
Copy link
Member

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.


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
Binary file added images/typescript-demo.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.