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.

Sign up for GitHub

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

Jump to bottom

Make update to caching information in readme #968

Merged
merged 3 commits into from Jan 19, 2019
Merged

Make update to caching information in readme #968

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
781579a
Make update to caching information in readme
brokentone Jan 14, 2019
4711253
Upate cli yargs + hyphenation usage
brokentone Jan 14, 2019
7ef81b1
Test cache-dir change
brokentone Jan 14, 2019
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
View file
Open in desktop
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 `--cacheDir` flag.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Isn't it --cache-dir?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Turns out... that while this is processed with the rest of the config, it's not actually specified in the yargs -- which I assume means won't come through. Assumedly it can be specified from .nycrc files though.
https://github.com/istanbuljs/nyc/blob/master/lib/config-util.js#L105-L111

  1. I can add this to the yargs settings.
  2. I can remove the reference to it and let someone else work on this later.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It would be great to see it added! Cc @bcoe


## Configuring `nyc`

Expand Down