Add a code coverage recipe

[ben-eb]

Just a quick note; I don't have experience of other CI services and hosted code coverage, so if anyone would like to add other services to the bottom of the guide then that'd be useful. 😄

[sindresorhus]

ES6 => ES2015

[ben-eb]

Updated. 👍

[sindresorhus]

I generally prefer separating the coveralls stuff from the local test running. Meaning I don't see the point in having --reporter=lcov here.

[sindresorhus]

So should look like:

"test": "nyc ava"

[sindresorhus]

and in .travis.yml, you can do node_modules/.bin/nyc report --reporter=text-lcov

[sindresorhus]

Should be after_success: https://github.com/sindresorhus/pageres/blob/aa4bf7997a14ab4f37f0150323dd46718268b2d4/.travis.yml#L7

[ben-eb]

Just tried the ES2015 version without the reporters, it needs at least one otherwise it throws, so I'll leave in the text reporter for now.

[sindresorhus]

Just tried the ES2015 version without the reporters, it needs at least one otherwise it throws, so I'll leave in the text reporter for now.

Can you report that as a bug to nyc? It should support it as the default is text reporter:

  -r, --reporter  coverage reporter(s) to use                  [default: "text"]

[sindresorhus]

Can you not hard wrap the text?

[sindresorhus]

--reporter=html

[ben-eb]

nyc report --reporter html works fine. Should I change anyway?

[sindresorhus]

Yes, I meant, for consistency, use = between key and value.

[sindresorhus]

Add it to the recipe list in the readme: https://github.com/sindresorhus/ava#recipes

[sindresorhus]

Awesome! This will be helpful for a lot of users. Thanks @ben-eb :)

[ben-eb]

No problem. 😄

[jamestalmage]

should be ./node_modules/.bin/nyc unless installed globally.

[ben-eb]

Mine isn't. 😄

https://docs.npmjs.com/misc/scripts#path

[jamestalmage]

I know I'm a bit late to the party, but I had just a little bit of follow up.

---

I usually inline the text and lcov reporters:

{
  "test": "nyc --reporter=lcov --reporter=text ava"
}

istanbuljs/nyc#137 is part of the reason why. nyc report can fail if anything happens to the cache between running the tests and generating reports. Safer to just do it all at once.

Since the lcov reporter actually generates html reports in addition to lcov.info. I use the html report locally, and lcov.info in an after_script for Travis/Coveralls:

after_script:
 - 'cat ./coverage/lcov.info | ./node_modules/.bin/coveralls'

I prefer after_script to after_success because it's still helpful to have coverage info when reviewing WIP PR's that might still have a few failing tests (or if the project is plagued by a few finicky tests).

---

The --babel flag never made it into nyc. Instead we adopted a --require flag (very similar to AVA's).

In this case however, I wouldn't use it. Instead I would add it to AVA's config in package.json:

{
  "ava": {
    "require": "babel-core/register"
  }
}

The advantage of configuring for AVA instead of NYC is that you can just run ava from the command line (assuming a global install) - and it will pick up that config. Otherwise you would be required to add --require babel-core/register on the command line every time.

[ben-eb]

We used ./node_modules/.bin/nyc report --reporter=text-lcov | ./node_modules/.bin/coveralls because it outputs to stdout, so there's no need for saving it to a file and cating it back out to stdout again. Rest looks good to me but I can't spend more time on this.

[sindresorhus]

I usually inline the text and lcov reporters:

That adds bloat to your package.json with limited gain. The more boilerplate we add to package.json, the less likely it is people will bother using it. "People" here being me too.

istanbuljs/nyc#137 is part of the reason why. nyc report can fail if anything happens to the cache between running the tests and generating reports.

That should just be fixed in nyc.

I prefer after_script to after_success because it's still helpful to have coverage info when reviewing WIP PR's that might still have a few failing tests (or if the project is plagued by a few finicky tests).

You can still have that locally, but I don't think failing PRs should add noise to the Coveralls history.

In this case however, I wouldn't use it. Instead I would add it to AVA's config in package.json:

👍

[sindresorhus]

@vdemedes Thoughts?

[vadimdemedes]

I like this recipe, have nothing major to add or correct. The only thing I noted is that I usually prefix bash examples with $, but it's not that important.

[vadimdemedes]

@jamestalmage As for me, I also prefer having only nyc && ava in npm test. I generate lcov and pipe it to coveralls right away. The same stuff as in AVA's config. It looks clean and simple.