slack-jest-reporter v0.2.0

slack-jest-reporter

A customizable slack bot reporter for jest

Installation

With yarn:

$ yarn add slack-jest-reporter

With NPM:

$ npm install slack-jest-reporter

Jest configuration

Edit your jest.config.js|ts|mjs|cjs|json file, and add the reporter to your reporters array. If you don't have the reports key, add it.

RECOMMENDED: Place "default" as the first array value to keep the default CLI reporting of jest

An example for json file:

{
  ...
  "reporters": [
    "default",
    [
      "slack-jest-reporter",
      {
        "slackBotToken": "XXX",
        "slackChannelId": "XXX",
        "texts": {
          "runStart": "🚀 Tests starting",
          "runProgress": "⏳ Tests running {progress}%",
          "runCompletePassed": "🟢 Tests passed",
          "runCompleteFailed": "❌ Tests failed",
          "testCaseResultPassed": "✅ {testName} (⏳{duration}ms)",
          "testCaseResultFailed": "🆘 {testName} (⏳{duration}ms)"
        }
      }
    ]
  ]
}

If you are using code for your configuration (.js|ts|mjs|cjs extensions), you can pass functions for the texts keys, that will get the tests results where applicable, so you can better customize your message. If you pass a string, it will be used, if you pass a function, the returned string will be used.

{
  reporters: [
    'default',
    [
      'slack-jest-reporter',
      {
        slackBotToken: 'XXX',
        slackChannelId: 'XXX',
        texts: {
          runStart: '🚀 Tests starting',
          runProgress: ({ total, passed, failed, progress }) => `⏳ Tests running ${progress}% (Passed: ${passed} | Failed ${failed} | Total: ${total})`,
          runCompletePassed: (results) => "🟢 Tests passed",
          runCompleteFailed: (results) => "❌ Tests failed",
          testCaseResultPassed: (testCaseResult) => `✅ ${testCaseResult.fullName} (⏳${testCaseResult.duration}ms)`,
          testCaseResultFailed: '🆘 {testName} (⏳{duration}ms)'
        }
      }
    ]
  ]
}

Configuration options

Texts

The reporter allows for full customization of the messages that will be posted by the slack bot. The following table contains all the possible keys available for customization.