README

jest-audio-reporter

Play a tune while running jest.

Usage

To use jest-audio-reporter, add it to the reporters section of the Jest configuration:

{
  "jest": {
    "reporters": [
      "default", // using default reporter
      "jest-audio-reporter",
      // Adjust volume 0 (silent) - 1 (normal)
      ["jest-audio-reporter", { volume: 1, onStartVolume: 1, onCompleteVolume: 1 }]
      // disable it
      ["jest-audio-reporter", { disable: true }]
      // to enable debug mode to see why no tune is playing
      ["jest-audio-reporter", { debug: true }]
    ]
  }
}

Configuration

To configure jest-audio-reporter, you need to create a .jest-audio-reporterrc file. For example:

{
  "onStart": "<path(s)-to-audio>",
  "onStartThreshold": 10,
  "onSuitePass": "<path(s)-to-audio>",
  "onSuiteFailure": "<path(s)-to-audio>"
}

Most likely you will put this file under the root of all your projects or in your home folder. Please refer to rc for more information.

Options

onStart: string | string[]: Specify the audio file(s) to play when the test suite starts. When specifying an array, one of the file will be picked at random.
onStartThreshold: number: onStart will not play audio if the tests are estimated to finish less when this threshold. Default is 3 seconds.
onSuitePass: string | string[]: Specify the audio file(s) to play when the test suite passes. When specifying an array, one of the file will be picked at random.
onSuiteFailure: string | string[]: Specify the audio file(s) to play when the test suite failes. When specifying an array, one of the file will be picked at random.

Watch mode

When jest is running in watch mode, the following special behavior applies:

onSuitePass will play only on first run and when the test suite recoveres from failure.

For Windows

jest-audio-reporter uses play-sound internally. For Windows, you will need to install mplayer.

Audio Copyright Disclaimer

In order to avoid potential copyright issue, no audio files are included in the package.

The audio files used for testing in this repository comes from https://dova-s.jp

Usage no npm install needed!