docs: Add collectCoverage to Reference

[blzaugg]

Summary

Having been confused myself, as well as noting the same confusion in forums. Many people cannot figure out how to turn off coverage reports, if the option has been set via Configuration.

Note, a similar confusion/change apply to other boolean options as well, but that's not covered in this PR.

Test plan

n/a

[jeysal]

There's already a reference entry for --coverage with a reference to the collectCoverage alias, I think we should add the info there?

[blzaugg]

Is collectCoverage an alias of coverage or the other way around? In source it uses options.collectCoverage.

[codecov-io]

Codecov Report

❗ No coverage uploaded for pull request base (master@fa0eb6d). Click here to learn what that means.
The diff coverage is n/a.

@@           Coverage Diff            @@
##             master   #8996   +/-   ##
========================================
  Coverage          ?   63.9%           
========================================
  Files             ?     277           
  Lines             ?   11652           
  Branches          ?    2860           
========================================
  Hits              ?    7446           
  Misses            ?    3576           
  Partials          ?     630

---

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update fa0eb6d...817195a. Read the comment docs.

[blzaugg]

I guess the args are coverage.

case 'coverage':
  options.collectCoverage = argv[key];

https://github.com/facebook/jest/blob/master/packages/jest-config/src/setFromArgv.ts#L21-L22

[jeysal]

Yeah in the code it may be collectCoverage, but to users --coverage is definitely more comfortable to use and we should keep calling that the "default" I think

[blzaugg]

Updated

[jeysal]

Thanks!

[github-actions]

This pull request has been automatically locked since there has not been any recent activity after it was closed. Please open a new issue for related bugs.
Please note this issue tracker is not a help forum. We recommend using StackOverflow or our discord channel for questions.