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

docs: nyc instrument and --exclude-node-modules #1039

Merged
merged 7 commits into from Apr 9, 2019

Conversation

AndrewFinlay
Copy link
Contributor

Lists basic usage, with a key limitation that the input dir must equal or be a sub-dir of cwd.

I'll probably make a few changes tomorrow, so suggestions are welcome.

Copy link
Member

@coreyfarrell coreyfarrell left a comment

Choose a reason for hiding this comment

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

Can you note that when input is a directory all files/folders in it are copied (except .git/).

README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
@AndrewFinlay AndrewFinlay changed the title WIP: docs: draft for nyc instrument docs: nyc instrument and --exclude-node-modules Apr 4, 2019
@coveralls
Copy link

Coverage Status

Coverage remained the same at 96.349% when pulling 8a5c99e on AndrewFinlay:docs-instrument into 31817de on istanbuljs:master.

5 similar comments
@coveralls
Copy link

Coverage Status

Coverage remained the same at 96.349% when pulling 8a5c99e on AndrewFinlay:docs-instrument into 31817de on istanbuljs:master.

@coveralls
Copy link

Coverage Status

Coverage remained the same at 96.349% when pulling 8a5c99e on AndrewFinlay:docs-instrument into 31817de on istanbuljs:master.

@coveralls
Copy link

Coverage Status

Coverage remained the same at 96.349% when pulling 8a5c99e on AndrewFinlay:docs-instrument into 31817de on istanbuljs:master.

@coveralls
Copy link

Coverage Status

Coverage remained the same at 96.349% when pulling 8a5c99e on AndrewFinlay:docs-instrument into 31817de on istanbuljs:master.

@coveralls
Copy link

Coverage Status

Coverage remained the same at 96.349% when pulling 8a5c99e on AndrewFinlay:docs-instrument into 31817de on istanbuljs:master.

README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
@coreyfarrell coreyfarrell requested review from JaKXz and bcoe April 5, 2019 13:02
Copy link
Member

@bcoe bcoe left a comment

Choose a reason for hiding this comment

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

This is looking really good to me 👍 thanks for putting in this work @AndrewFinlay.

One comment, I think we might be at a point (similar to where we hit with yargs a while ago) that we want to refactor the documentation into a few markdown files, see:

https://github.com/yargs/yargs/blob/master/docs/api.md

Not a blocker for this work though, just a thought for the future 👍

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants