Installation

This is an express guide to get you started quickly. Please visit our documentation website for more information.

Your project should have jest installed. The minimum supported version is 27.x.

Run in your project:

1npm install --save-dev jest-allure2-reporter

Edit your Jest config, e.g. jest.config.js:

1/** @type {import('@jest/types').Config.InitialOptions} */
2module.exports = {
3   // ...
4   reporters: [
5     'default',
6+    'jest-allure2-reporter',
7   ],
8   // For the most of the features you'll need the custom environment:
9+  testEnvironment: 'jest-allure2-reporter/environment-node',
10};

Usage

Run your tests with jest as usual, e.g.:

1npm test

and then view the results:

1ALLURE_NO_ANALYTICS=1 allure serve

If you need to generate a static report, e.g., on CI, run instead:

1ALLURE_NO_ANALYTICS=1 allure generate

Make sure you have allure CLI installed beforehand. For more information about it, refer to the official Allure docs.

Contributing

See the Contributing guide on the website.

License

Licensed under MIT License.