-
-
Notifications
You must be signed in to change notification settings - Fork 24
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
Document steps in nyc execution #138
Comments
@dtgriscom I appreciate this issue, sorry it's taken so long to get back to you. I would love to see a PR here, under the docs/advanced features section: https://github.com/istanbuljs/istanbuljs.github.io/tree/development/content/docs/advanced |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
I'm using nyc to capture code coverage in my TypeScript project, and it's working well (excellent tool). However, now that I want to do more sophisticated things (e.g. merge multiple coverage captures into a single report) I'm finding that there's a total lack of documentation on just what steps nyc takes when it runs, and how to control them.
After a lot of sniffing around the various fragments of doc and
--help
output, I believe the default process is something like the following:.nyc_output
a. Whenever node loads a .js file, instrument it (default is to cache results)
b. Run target code, accumulating coverage data in
__coverage__
objectc. Continue until target project exits
.nyc_output/ReallyLongRandomHexFileName.json
file.nyc_output/*.json
files back in (?), merging all data into single representation of coverageDid I get this right? If so, how can I control this sequence? For instance, I'd like to:
.nyc_output/ReallyLongRandomHexFileName.json
files (--clean=false
option, I believe, although I'm not sure of the syntax)--silent
option, I believe).nyc_output/ReallyLongRandomHexFileName.json
files (thereport
command, I believe)If I got all this right, then please consider this a request for documentation; basic issues like this probably get in the way of a lot of potential nyc users. (In theory I could write the doc myself and submit a pull request, but I don't have a good feel for where in the doc tree it should be placed.)
The text was updated successfully, but these errors were encountered: