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

Make update to caching information in readme #968

Merged
merged 3 commits into from Jan 19, 2019
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
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