# jest-reporter

> Jest Reporter with customisable sounds and messages

Latest version **1.0.1** (published 2017-11-22) · MIT license · 0 weekly downloads

## Install

```sh
npm install jest-reporter
pnpm add jest-reporter
yarn add jest-reporter
bun add jest-reporter
```

## Health

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

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.1 |
| Published | 2017-11-22 |
| First published | 2017-07-16 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 2 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 2 |
| Author | Tomasz Rembacz |
| Maintainers | mm85 |
| Keywords | jest, reporter, sounds, ascii, text, test |

## Links

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

## Dependencies (2)

- [path](https://npm.io/package/path.md) ^0.12.7
- [play-sound](https://npm.io/package/play-sound.md) ^1.1.1

## Alternatives

- [duck](https://npm.io/package/duck.md) — 4.2M weekly downloads
- [ava](https://npm.io/package/ava.md) — 560.2K weekly downloads
- [storybook-addon-module-mock](https://npm.io/package/storybook-addon-module-mock.md) — 71.7K weekly downloads
- [@ethereum-waffle/mock-contract](https://npm.io/package/@ethereum-waffle/mock-contract.md) — 40.0K weekly downloads
- [aws-elasticsearch-connector](https://npm.io/package/aws-elasticsearch-connector.md) — 37.4K weekly downloads

## Recent versions

- 1.0.1 (latest) — 2017-11-22
- 1.0.0 — 2017-07-16

## README

# Custom Jest Reporter (jest-reporter)
Jest Reporter with customisable sounds and messages.

[![Build Status](https://travis-ci.org/trembacz/jest-reporter.svg?branch=master)](https://travis-ci.org/trembacz/jest-reporter)
[![Dependencies](https://david-dm.org/trembacz/jest-reporter/status.svg)](https://david-dm.org/trembacz/jest-reporter?view=list) 
[![devDependencies](https://david-dm.org/trembacz/jest-reporter/dev-status.svg)](https://david-dm.org/trembacz/jest-reporter?type=dev&view=list)

## Installing

```npm install --save-dev jest-reporter```

or

```yarn add -D jest-reporter```

## Getting Started

To use this reporter you will need to have an Jest test environment set up.
In your ```package.json``` add new reporter:

```json
"jest": {
  "bail": false,
  "reporters": [
    "default",
    [
      "<rootDir>/node_modules/jest-reporter", {
        "passSound": "sounds/customPass.wav",
        "failSound": "sounds/customFail.wav",
        "passText": "txt/customPass.txt",
        "failText": "txt/customFail.txt",
        "skipFailSound": false,
        "skipFailText": false,
        "skipPassSound": false,
        "skipPassText": false
      }
    ]
  ]
}
```

## Options

| Option              | Value         | Description                                                          |
| ------------------- |:-------------:| -------------------------------------------------------------------- |
| ```passSound```     | ```string```  | Path to sound file e.g "sounds/pass.wav"                             |
| ```failSound```     | ```string```  | Path to sound file e.g "sounds/fail.wav"                             |
| ```passText```      | ```string```  | Path to text file e.g "txt/pass.txt"                                 |
| ```failText```      | ```string```  | Path to text file e.g "txt/fail.txt"                                 |
| ```skipFailSound``` | ```boolean``` | Set to ```true``` if you want to disable sound effect on failed test |
| ```skipFailText```  | ```boolean``` | Set to ```true``` if you want to disable text message on failed test |
| ```skipPassSound``` | ```boolean``` | Set to ```true``` if you want to disable sound effect on passed test |
| ```skipPassText```  | ```boolean``` | Set to ```true``` if you want to disable text message on passed test |

**If you not specify sound or text files, default ones will be used.**

## Run

```npm run jest``` 
or 
```yarn jest```

## Demo
You can even add **ASCII** images in txt files ;)

##
![](http://i.imgur.com/k2xi9sC.jpg) 
##
![](http://i.imgur.com/DfHS05v.jpg)

## Windows users
**You need "mplayer" installed on your system**

**Tip:** Copy ```mplayer.exe``` into folder with ```package.json```

## LICENSE
[MIT](LICENSE)

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