# karma-nyan-reporter

> Karma reporter with Nyan Cat style logging.

Latest version **0.2.5** (published 2017-01-05) · The MIT License (MIT) license · 0 weekly downloads

## Install

```sh
npm install karma-nyan-reporter
pnpm add karma-nyan-reporter
yarn add karma-nyan-reporter
bun add karma-nyan-reporter
```

## Health

**Score 23/100 (F)** — status: abandoned.

Positive: has types package; no vulnerabilities; high quality score.

Warnings: low downloads; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.2.5 |
| Published | 2017-01-05 |
| First published | 2014-06-02 |
| Weekly downloads | 0 |
| License | The MIT License (MIT) |
| TypeScript types | separate (@types/karma-nyan-reporter) |
| Module format | CommonJS |
| Dependencies | 1 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 169 |
| Author | Daniel Arlitt |
| Maintainers | dgarlitt |
| Keywords | karma-plugin, karma-reporter, nyan, cat |

## Links

- npm: https://www.npmjs.com/package/karma-nyan-reporter
- Repository: https://github.com/dgarlitt/karma-nyan-reporter
- Homepage: https://github.com/dgarlitt/karma-nyan-reporter#readme
- Issues: https://github.com/dgarlitt/karma-nyan-reporter/issues
- npm.io page: https://npm.io/package/karma-nyan-reporter

## Dependencies (1)

- [cli-color](https://npm.io/package/cli-color.md) ^0.3.2

## Alternatives

- [update-check](https://npm.io/package/update-check.md) — 4.0M weekly downloads
- [react-native-onesignal](https://npm.io/package/react-native-onesignal.md) — 134.5K weekly downloads
- [react-redux-toastr](https://npm.io/package/react-redux-toastr.md) — 33.7K weekly downloads
- [@nocobase/plugin-notification-manager](https://npm.io/package/@nocobase/plugin-notification-manager.md) — 2.0K weekly downloads
- [react-simple-toasts](https://npm.io/package/react-simple-toasts.md) — 1.9K weekly downloads

## Recent versions

- 0.2.5 (latest) — 2017-01-05
- 0.0.3 (0.0.3) — 2014-06-03
- 0.0.2 (@0.0.2) — 2014-06-03
- 0.0.1 (karma-nyan-reporter@0.0.1) — 2014-06-02
- 0.2.4 — 2016-03-17
- 0.2.3 — 2015-12-10
- 0.2.2 — 2015-08-08
- 0.2.1 — 2015-07-20
- 0.2.0 — 2015-07-11
- 0.1.0 — 2015-06-28
- 0.0.60 — 2015-03-12
- 0.0.51 — 2015-02-27
- 0.0.50 — 2014-11-13
- 0.0.49 — 2014-10-24
- 0.0.48 — 2014-10-15
- … 8 more at https://npm.io/package/karma-nyan-reporter/versions

## README

[![npm version](https://badge.fury.io/js/karma-nyan-reporter.svg)](http://badge.fury.io/js/karma-nyan-reporter)
[![Build Status](https://travis-ci.org/dgarlitt/karma-nyan-reporter.svg)](https://travis-ci.org/dgarlitt/karma-nyan-reporter)
[![Coverage Status](https://coveralls.io/repos/dgarlitt/karma-nyan-reporter/badge.svg?branch=master)](https://coveralls.io/r/dgarlitt/karma-nyan-reporter?branch=master)
[![Code Climate](https://codeclimate.com/github/dgarlitt/karma-nyan-reporter/badges/gpa.svg)](https://codeclimate.com/github/dgarlitt/karma-nyan-reporter)
<!-- [![Dependency Status](https://david-dm.org/dgarlitt/karma-nyan-reporter.svg)](https://david-dm.org/dgarlitt/karma-nyan-reporter) -->

karma-nyan-reporter
===================

Nyan Cat style reporter originally cobbled together from the [Mocha](http://visionmedia.github.io/mocha/) version

![Karma Nyan Cat Reporter for Karma](https://raw.githubusercontent.com/dgarlitt/image-repo/master/karma-nyan-reporter/v0.2.2/karma-nyan-reporter.gif "Karma Nyan Cat Reporter for Karma")

Installation
========

Installation is simple using npm, just run the following command:

```sh
npm install --save-dev karma-nyan-reporter
```

Since this follows Karma's plugin naming convention, that's all there is to it!

Now, run your tests and enjoy:

```sh
karma start path/to/karma.conf.js --reporters nyan
```

Error and Logging Output
=========

Here is a screenshot of the error and logging output. The errors are displayed hierarchically based on the test suite and nesting level. ```console.log()``` messages are output at the bottom (in blue) below the test summary and grouped by browser.

![Karma Nyan Cat Reporter Error Output](https://raw.githubusercontent.com/dgarlitt/image-repo/master/karma-nyan-reporter/v0.2.2/karma-nyan-reporter-error-output.png "Karma Nyan Cat Reporter Error Output")

Options
=========

If you want to suppress the stack trace at the end of the test run you can use the suppressErrorReport option.

```js
// karma.conf.js
module.exports = function(config) {
  config.set({
    // normal config stuffs

    reporters: ['nyan'],

    // reporter options
    nyanReporter: {
      // suppress the error report at the end of the test run
      suppressErrorReport: true, // default is false

      // suppress the red background on errors in the error
      // report at the end of the test run
      suppressErrorHighlighting: true, // default is false

      // increase the number of rainbow lines displayed
      // enforced min = 4, enforced max = terminal height - 1
      numberOfRainbowLines: 100, // default is 4

      // only render the graphic after all tests have finished.
      // This is ideal for using this reporter in a continuous
      // integration environment.
      renderOnRunCompleteOnly: true // default is false
    }
  });
};
```

In this release
-----------
 - Fix for [issue #23](https://github.com/dgarlitt/karma-nyan-reporter/issues/23) - Total tests count is different from other reporters

---
_Source: https://npm.io/package/karma-nyan-reporter · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._