Skip to content

Commit

Permalink
Update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
stoffeastrom committed Dec 6, 2017
1 parent 01989a2 commit bf76d9c
Show file tree
Hide file tree
Showing 2 changed files with 19 additions and 0 deletions.
19 changes: 19 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,25 @@ Commands:
aw puppeteer Run tests with puppeteer [aliases: puppet]
```

All commands support passing a config file for all options.

```shell
npx aw -c ./path/to/aw.config.js
```

However, passing an option from command line will override the config file option.

```shell
npx aw -c ./path/to/aw.config.js --glob /path/that/overrides/glob/in/config/file
```

This enables easy debugging setup from modern editors for example [Visual Studio Code](https://code.visualstudio.com/)

![](./docs/vscode-debug-config.png)

This will only run the current active file. And you don't have to worry about your tests timing out
since `after-work.js` will automatically detect running a debugger and set the appropriate options accordingly.

## Included Tools
The following tools are bundled into after-work.js:
* [Mocha](https://mochajs.org/): an extensible testing framework for TDD or BDD.
Expand Down
Binary file added docs/vscode-debug-config.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit bf76d9c

Please sign in to comment.