# karma-helpful-reporter
> Karma reporter with helpful style logging.
Latest version **0.3.4** (published 2017-08-16) · MIT license · 0 weekly downloads
## Install
```sh
npm install karma-helpful-reporter
pnpm add karma-helpful-reporter
yarn add karma-helpful-reporter
bun add karma-helpful-reporter
```
## Health
**Score 15/100 (F)** — status: abandoned.
Positive: no vulnerabilities.
Warnings: low downloads; no types; no esm support; pre 1.0.
Negative: abandoned; low maintenance score.
## Facts
| | |
|---|---|
| Version | 0.3.4 |
| Published | 2017-08-16 |
| First published | 2017-07-29 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 7 |
| Author | Boris Yakubchik |
| Maintainers | yboris |
| Keywords | karma-plugin, karma-reporter |
## Links
- npm: https://www.npmjs.com/package/karma-helpful-reporter
- Repository: https://github.com/whyboris/karma-helpful-reporter
- Homepage: https://github.com/whyboris/karma-helpful-reporter#readme
- Issues: https://github.com/whyboris/karma-helpful-reporter/issues
- npm.io page: https://npm.io/package/karma-helpful-reporter
## Dependencies (1)
- [cli-color](https://npm.io/package/cli-color.md) 1.2.0
## Recent versions
- 0.3.4 (latest) — 2017-08-16
- 0.3.3 — 2017-07-31
- 0.3.2 — 2017-07-30
- 0.3.1 — 2017-07-30
- 0.3.0 — 2017-07-29
## README
[](http://badge.fury.io/js/karma-helpful-reporter)
[](https://travis-ci.org/whyboris/karma-helpful-reporter)
[](https://coveralls.io/github/whyboris/karma-helpful-reporter?branch=karma-helpful-reporter)
[](https://codeclimate.com/github/whyboris/karma-helpful-reporter)
[](https://david-dm.org/whyboris/karma-helpful-reporter)
karma-helpful-reporter
===
Karma Helpful Reporter gives you a customizable report after you run your Karma tests.
The errors from failed tests are displayed hierarchically based on the test suite and nesting level. `console.log()` messages are output at the bottom below the test summary and grouped by browser.
Setup & Options
===
Install with npm:
```sh
npm install --save-dev karma-helpful-reporter
```
Inside your `karma.conf.js`
- add `require('karma-helpful-reporter')` to the `plugins` array
- add `'helpful'` to the `reporters` array
Optionally, add the `helpfulReporter` object with as many properties from the below set as you'd like.
- The listed properties' values are the default ones
```js
// karma.conf.js
module.exports = function(config) {
config.set({
plugins: [ require('karma-helpful-reporter') ],
reporters: [ 'helpful' ],
// Optional reporter settings
helpfulReporter: {
animationStyle: 'braille',
clearScreenBeforeEveryRun: false,
hideBrowser: false,
maxLogLines: 42,
removeLinesContaining: [],
removeTail: false,
renderOnRunCompleteOnly: false,
suppressErrorReport: false,
underlineFileType: '',
colorBrowser: 205,
colorConsoleLogs: 45,
colorFail: 9,
colorFirstLine: 211,
colorLoggedErrors: 250,
colorPass: 10,
colorSkip: 11,
colorTestName: 199,
colorUnderline: 254,
}
});
};
```
Property | Default | Description
--- | --- | ---
animationStyle | 'braille' | Set in-progress animation to _'braille'_, _'braille2'_, or emoji _'clock'_.
clearScreenBeforeEveryRun | false | Clear screen before every run
hideBrowser | true | Hide browser name from the report
maxLogLines | 42 | Limit the maximum number of lines in report
removeLinesContaining | [] | Remove all lines from the final report containing any of these strings, e.g. _['@angular', 'zone.js']_
removeTail | false | Remove from the final report anything that follows '<-', e.g. _blah blah <- test.ts 4250:39_ becomes _blah blah_
renderOnRunCompleteOnly | false | Do not animate while tests are running
suppressErrorReport | false | Suppress the error report at the end of the test run
underlineFileType | '' | Underline filename of some file type; all files in the error report that have this particular extention will be underlined, e.g. _'spec.ts'_; set the color with the _colorUnderline_ property
colorBrowser | 224 | 
colorConsoleLogs | 45 | 
colorFail | 210 | 
colorFirstLine | 217 | 
colorLoggedErrors | 250 | 
colorPass | 154 | 
colorSkip | 117 | 
colorTestName | 210 |
colorUnderline | 255 | 
Set custom colors by using permitted [cli-color](https://github.com/medikoo/cli-color) numbers.
Notes
===
This project was copied from [karma-nyan-reporter](https://github.com/dgarlitt/karma-nyan-reporter/) in July 2017 with intent to build on and improve its functionality. Code cleanup and refactoring will happen during August 2017.
---
_Source: https://npm.io/package/karma-helpful-reporter · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._