collectCoverageOnlyFrom documentation is not clear

[gaearon]

Why is this an object representing a set of files? What is the format of this object? Why is it not an array? What are types of its keys and values? Does it have to include “files” as the docs say, or can those be folders too? Would specifying it automatically enable collectCoverage or does it only have effect when collectCoverage is enabled?

[cpojer]

Oh yeah, you are right, this isn't great. Would you mind sending a PR with an update?

See https://github.com/facebook/jest/blob/master/package.json#L47 for an example. It's also mentioned here: http://facebook.github.io/jest/blog/2016/09/01/jest-15.html#rewritten-code-coverage-support

[gaearon]

Is OnlyFrom removed completely?

[cpojer]

Oh wait, no, sorry. I mixed it up. collectCoverageFrom is used to generate code coverage from all files, even untested ones.

collectCoverageOnlyFrom literally takes a list of files and only collects coverage for those.

The two options are mutually exclusive.

[gaearon]

Are their inputs arrays of globs in both cases?

[cpojer]

No, collectCoverageFrom is the only option that accepts globs currently (it is completely new). collectCoverageOnlyFrom literally only accepts direct, full paths, to files. It is used internally and an ugly leftover of darker times.

[aaronabramov]

collectCoverageOnlyFrom has the format that looks like this:

{
  "file1.js": true,
  "file2.js": false
}

there was a reason to implement it this way for the internal runner, but for the outside world it probably makes no sense. should we remove it from the docs?

[cpojer]

Probably, yes. collectCoverageFrom should be able to handle this use case.

[cpojer]

@DmitriiAbramov would you mind adding docs for collectCoverageFrom and removing collectCoverageOnlyFrom from the docs? I consider it internal and deprecated.

[aaronabramov]

will do

[github-actions]

This issue 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.