Skip to content

Commit

Permalink
[skip ci] Rough draft for nyc instrument docs
Browse files Browse the repository at this point in the history
Adds basic usage and key limitations
  • Loading branch information
Andrew Finlay committed Mar 21, 2019
1 parent 1f6c3d4 commit 2a74827
Showing 1 changed file with 12 additions and 0 deletions.
12 changes: 12 additions & 0 deletions README.md
Expand Up @@ -195,6 +195,18 @@ Install custom reporters as a development dependency and you can use the `--repo
nyc report --reporter=<custom-reporter-name>
```

## Producing instrumented source

nyc can produce a set of instrumented source files, suitable for client side deployment, by running:

```bash
nyc instrument <input> [output]
```

Where `input` can be any file or directory within the project root directory.
The `output` directory is optional and can be located anywhere, if it is not set the instrumented code with be sent to `stdout`.


## Setting the project root directory

nyc runs a lot of file system operations relative to the project root directory.
Expand Down

0 comments on commit 2a74827

Please sign in to comment.