Make update to caching information in readme - #968
Conversation
1 similar comment
coreyfarrell
left a comment
coreyfarrell
left a comment
There was a problem hiding this comment.
Thanks for the contribution. Going to wait for a second approval before merging as grammar is not my strongest area.
JaKXz
left a comment
JaKXz
left a comment
There was a problem hiding this comment.
Other than one small question this looks great, thanks!
| 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. |
There was a problem hiding this comment.
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
- I can add this to the
yargssettings. - I can remove the reference to it and let someone else work on this later.
|
@JaKXz @coreyfarrell, etc -- I think I've made the necessary updates, please let me know if you need anything else from me! |
The scope of this PR has expanded since this review
|
I'll leave this to @bcoe or @coreyfarrell to merge |
5 participants
Since #454, caching has been enabled by default but the README does not reflect this. Our team lost some time following the README, so contributing back our findings for the next team!