karma-runner / karma-runner/karma-coverage

Document _onWriteReport config option

Open
#310 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
JavaScript
Stars
771
Forks
242
PR merge metrics
No merged PRs in 30d

Description

Currently the only mention of the `_onWriteReport` config option is in the [source code](https://github.com/karma-runner/karma-coverage/blob/master/lib/reporter.js#L62). This is an extremely valuable option (in my case, which is get code coverage reports for HTML files which are compiled to JS first).

The suggest change is to update the `readme.md` file with an example of how you can specify a function for `_onWriteReport` and the arguments that are passed to it.

While making that change, would it be possible to fix #240 at the same time? If not, that's ok.

Contributor guide

Open the contributing guide

Research direction

Start with lib/reporter.js at the documented _onWriteReport option to verify the function arguments and behavior. Update readme.md with an example showing how to configure the function and the arguments it receives; treat the requested #240 fix as optional unless its scope is clear.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript
Domain
documentation
Issue type
Documentation
Difficulty
1/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
48/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.