docs: instrument docs update #1063
Conversation
Add documentation for `--complete-copy`, and describe how to instrument source JIT on an express server.
|
@JaKXz that can be done, where do you want the link to go? |
|
In the readme for now as a heading link, like the coveralls and codecov links |
There was a problem hiding this comment.
Thanks @AndrewFinlay! I have some suggestions... hopefully got everything...
docs/instrument.md
Outdated
|
|
||
| The `--delete` option will remove existing output. | ||
|
|
||
| The `--complete-copy` option will copy all files from the `input` directory to the `output` directory. |
There was a problem hiding this comment.
Will it override the instrumented output? I think more specificity would be good here.
There was a problem hiding this comment.
That seems obvious to me, I don't see why you'd run nyc instrument to simply copy files and not instrument them. But it can change if it needs to.
There was a problem hiding this comment.
That's what I mean, I don't really understand from the wording... I assume the output will be input.js and input-instrumented.js but I don't know if that's actually right
docs/instrument.md
Outdated
|
|
||
| ## Streaming instrumentation | ||
|
|
||
| This form of the command will stream instrumented source directly to `stdout`, that can then be piped to another process. |
There was a problem hiding this comment.
This sentence should just start with nyc instrument will stream...
There was a problem hiding this comment.
@AndrewFinlay do you have a moment to address this so we can merge? If not I can make the change.
There was a problem hiding this comment.
I've been working on @JaKXz 's queries about how instrument handles absolute and relative paths in Windows, but life, family and Easter come first. I think this is the only remaining piece of work for this PR, and my gut feeling says that if Windows can't accept both relative and absolute paths that may be a bug anyway. So I'll get my Windows test env up and if I find anything that needs to change I'll pop it in a new PR,
Oh and thanks to all of you @JaKXz, @coreyfarrell & @bcoe for your help in getting these instrument changes over the line. It's been fun.
|
@JaKXz @AndrewFinlay, just bumping this up; what do we need to do to get this over the finish line? |
|
@bcoe done! |
Add documentation for
--complete-copy, and describe how to instrument source JIT on an express server.This should go some way to addressing #839, which looks like it's already implemented but not documented.