Wrong documentation for coverage with codecov.io

[dotnetCarpenter]

I just learned that you can not write "posttest": "tap --coverage-report=lcov | codecov" as the docs suggest.

You have to write "posttest": "tap --coverage-report=lcov > coverage.json && codecov"

[dotnetCarpenter]

Ping @stevepeak

[isaacs]

That's a docs bug. I'll fix it soonish unless someone else beats me to a pr :)

[dotnetCarpenter]

@isaacs hang on.
I might have a PR for codecov that enable piped input.

Right now the docs says
tap --coverage-report=lcov | codecov which should be tap --coverage-report=text-lcov | codecov if piping is supported by codecov-node.

What would work now is: tap --coverage-report=lcov && codecov - codecov will find the coverage/lcov.info file and upload it.

[isaacs]

@dotnetCarpenter Gotcha. i'll update the docs now to what works. It's easy enough to change again later if there's a better way :)

[isaacs]

71b8728

[stevepeak]

Hey @isaacs and @dotnetCarpenter we are adding partial line coverage support this week.

https://cl.ly/3I0S172c4736

This requires the coverage.json file only to be uploaded. Can we arrange this?

[dotnetCarpenter]

@stevepeak I assume you mean the coverage.json that istanbul cover produce. But I don't know what is the difference between lcov and coverage.json, besides the data format. Do you mean that you only accept JSON or that the data quality differs between coverage.json and lcov?

I'm asking this because I got code that takes what-ever is piped to codecov-node and append it to the upload variable. E.g. upload += '# path=piped\n' + args.options.pipe.join('') + '\n<<<<<< EOF\n';

[stevepeak]

the difference between lcov and coverage.json, besides the data format

The json document provides column aware coverage data which enables us to provide higher detailed coverage overlay and more accuracy in detecting partial line coverage (as seen in screenshot above). The lcov is simple line:cov data and is not column aware.

Do you mean that you only accept JSON or that the data quality differs between coverage.json and lcov?

Yes. I'm looking into ways of ignoring the lcov data entirely as it could override the column aware data. This is still yet to be determined, but we only need the json file in the near future.

[dotnetCarpenter]

Hmmm.. Not sure how tap sends arguments to nyc. But if the reporter is json and the file is - then I think we can pipe JSON to codecov.

Something like: tap test/* --coverage-report=json --file=- but it doesn't work.

[stevepeak]

It's ok to produce the lcov and json reports. We just prefer the json reports for uploading.

Still working on a way to ignore lcov when json is found.