Skip to content

Commit

Permalink
feat: document the fact that cacheDir is configurable (#968)
Browse files Browse the repository at this point in the history
  • Loading branch information
brokentone authored and bcoe committed Jan 19, 2019
1 parent ff834aa commit 35cd49a
Show file tree
Hide file tree
Showing 3 changed files with 9 additions and 5 deletions.
4 changes: 1 addition & 3 deletions README.md
Expand Up @@ -251,9 +251,7 @@ modules should be required in the subprocess collecting coverage:

## Caching

You can run `nyc` with the optional `--cache` flag, to prevent it from
instrumenting the same files multiple times. This can significantly
improve runtime performance.
`nyc`'s default behavior is to cache instrumented files to disk to prevent instrumenting source files multiple times, and speed `nyc` execution times. You can disable this behavior by running `nyc` with the `--cache false` flag. You can also change the default cache directory from `./node_modules/.cache/nyc` by setting the `--cache-dir` flag.

## Configuring `nyc`

Expand Down
4 changes: 4 additions & 0 deletions lib/config-util.js
Expand Up @@ -109,6 +109,10 @@ Config.buildYargs = function (cwd) {
describe: 'cache instrumentation results for improved performance',
global: false
})
.option('cache-dir', {
describe: 'explicitly set location for instrumentation cache',
global: false
})
.option('babel-cache', {
default: false,
type: 'boolean',
Expand Down
6 changes: 4 additions & 2 deletions test/nyc-bin.js
Expand Up @@ -278,15 +278,17 @@ describe('the nyc cli', function () {
'--include=env.js',
'--exclude=batman.js',
'--extension=.js',
'--cache=true',
'--cache=false',
'--cache-dir=/tmp',
'--source-map=true',
process.execPath,
'./env.js'
]
var expected = {
instrumenter: './lib/instrumenters/istanbul',
silent: true,
cache: true,
cacheDir: '/tmp',
cache: false,
sourceMap: true
}

Expand Down

0 comments on commit 35cd49a

Please sign in to comment.