https://github.com/wix-incubator/jest-allure2-reporter

🦉📊 Idiomatic Jest reporter for Allure Framework
https://github.com/wix-incubator/jest-allure2-reporter

allure allure-framework allure-report allure2 jest jest-environment-emit jest-metadata jest-reporter reporter

Last synced: 25 days ago
JSON representation

🦉📊 Idiomatic Jest reporter for Allure Framework

• Host: GitHub
• URL: https://github.com/wix-incubator/jest-allure2-reporter
• Owner: wix-incubator
• License: mit
• Created: 2022-10-12T15:18:26.000Z (about 2 years ago)
• Default Branch: beta
• Last Pushed: 2024-10-30T18:45:17.000Z (about 2 months ago)
• Last Synced: 2024-10-30T19:32:59.361Z (about 2 months ago)
• Topics: allure, allure-framework, allure-report, allure2, jest, jest-environment-emit, jest-metadata, jest-reporter, reporter
• Language: TypeScript
• Homepage: https://wix-incubator.github.io/jest-allure2-reporter/
• Size: 11 MB
• Stars: 9
• Watchers: 41
• Forks: 0
• Open Issues: 6
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
[![Stand With Ukraine](https://raw.githubusercontent.com/vshymanskyy/StandWithUkraine/main/banner-direct-single.svg)](https://stand-with-ukraine.pp.ua)





# jest-allure2-reporter

Idiomatic Jest reporter for Allure Framework

[![npm version](https://badge.fury.io/js/jest-allure2-reporter.svg)](https://badge.fury.io/js/jest-allure2-reporter)

[![CI](https://github.com/wix-incubator/jest-allure2-reporter/actions/workflows/ci.yml/badge.svg)](https://github.com/wix-incubator/jest-allure2-reporter/actions/workflows/ci.yml)

[![semantic-release: angular](https://img.shields.io/badge/semantic--release-angular-e10079?logo=semantic-release)](https://github.com/semantic-release/semantic-release)

[![Commitizen friendly](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg)](http://commitizen.github.io/cz-cli/)



## 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:

```bash

npm install --save-dev jest-allure2-reporter@beta

```

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

```diff

/** @type {import('@jest/types').Config.InitialOptions} */

module.exports = {

   // ...

   reporters: [

     'default',

+    'jest-allure2-reporter',

   ],

   // For the most of the features you'll need the custom environment:

+  testEnvironment: 'jest-allure2-reporter/environment-node',

};

```

## Usage

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

```bash

npm test

```

and then view the results:

```bash

ALLURE_NO_ANALYTICS=1 allure serve

```

![Example screenshot](docs/img/example.png)

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

```bash

ALLURE_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].

[`jest`]: https://jestjs.io

[our documentation website]: https://wix-incubator.github.io/jest-allure2-reporter/

[Allure docs]: https://docs.qameta.io/allure/#_get_started

[Contributing]: https://wix-incubator.github.io/jest-allure2-reporter/about/contributing

[MIT License]: LICENSE