Make update to caching information in readme #968
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
1 similar comment
coreyfarrell
previously approved these changes
Jan 14, 2019
JaKXz
reviewed
Jan 14, 2019
README.md
Outdated
| 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.
There was a problem hiding this comment.
It would be great to see it added! Cc @bcoe
|
@JaKXz @coreyfarrell, etc -- I think I've made the necessary updates, please let me know if you need anything else from me! |
JaKXz
dismissed
coreyfarrell’s stale review
The scope of this PR has expanded since this review
coreyfarrell
approved these changes
Jan 18, 2019
|
I'll leave this to @bcoe or @coreyfarrell to merge |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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!