# jest-allure-reporter

> A Jest Allure Reporter, which takes the test-results from jest and creates an allure-report from it.

Latest version **1.2.3** (published 2018-04-16) · MIT license · 0 weekly downloads

## Install

```sh
npm install jest-allure-reporter
pnpm add jest-allure-reporter
yarn add jest-allure-reporter
bun add jest-allure-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.2.3 |
| Published | 2018-04-16 |
| First published | 2018-02-20 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 13 |
| Unpacked size | 24.7 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 9 |
| Author | Pascal Esemann |
| Maintainers | gusarin |
| Keywords | test, testautomation, testreport, unittest, UI-test, uitest, reporting, jest, allure |

## Links

- npm: https://www.npmjs.com/package/jest-allure-reporter
- Repository: https://github.com/gusarin/jest-allure-reporter
- Issues: https://github.com/gusarin/jest-allure-reporter
- npm.io page: https://npm.io/package/jest-allure-reporter

## Dependencies (13)

- [jest](https://npm.io/package/jest.md) ^22.4.3
- [hjson](https://npm.io/package/hjson.md) ^3.1.1
- [fs-extra](https://npm.io/package/fs-extra.md) ^5.0.0
- [rootpath](https://npm.io/package/rootpath.md) ^0.1.2
- [save-file](https://npm.io/package/save-file.md) ^1.2.0
- [strip-ansi](https://npm.io/package/strip-ansi.md) ^4.0.0
- [@types/jest](https://npm.io/package/@types/jest.md) ^22.2.3
- [@types/node](https://npm.io/package/@types/node.md) ^9.6.5
- [@types/hjson](https://npm.io/package/@types/hjson.md) ^2.4.0
- [string-template](https://npm.io/package/string-template.md) ^1.0.0
- [@types/strip-ansi](https://npm.io/package/@types/strip-ansi.md) ^3.0.0
- [allure-commandline](https://npm.io/package/allure-commandline.md) ^2.5.0
- [@types/string-template](https://npm.io/package/@types/string-template.md) ^1.0.2

## 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
- [vest](https://npm.io/package/vest.md) — 50.1K weekly downloads
- [@ethereum-waffle/mock-contract](https://npm.io/package/@ethereum-waffle/mock-contract.md) — 40.0K weekly downloads

## Recent versions

- 1.2.3 (latest) — 2018-04-16
- 1.2.2 — 2018-03-26
- 1.2.1 — 2018-03-07
- 1.2.0 — 2018-03-06
- 1.1.6 — 2018-03-05
- 1.1.5 — 2018-03-05
- 1.1.3 — 2018-02-27
- 1.1.1 — 2018-02-27
- 1.1.0 — 2018-02-21
- 1.0.3 — 2018-02-21
- 1.0.2 — 2018-02-21
- 1.0.1 — 2018-02-20
- 1.0.0 — 2018-02-20

## README

# jest-allure-reporter

This Project brings an jest-reporter for getting an allure-Report from the jest test results.
> A Jest Allure Reporter, which takes the test-results from jest and creates an allure-report from it.

## What's jest?
[Jest](https://facebook.github.io/jest/) is a javascript testing framework, for testing javascript code, including ui-tests. 

## What's allure?
[Allure](http://allure.qatools.ru/) is a tool for creating an helpfull report of testresults.

## What's the jest-allure-reporter?
The jest-allure-reporter connects the jest-tests with the allure-report as both tools doesn't support each other directly. The jest-allure-reporter takes the test-results from jest and creates an allure-report automatically.

## Installation/ Configuration
Installation is relatively simple.
In your jest-project add the following to the dependencies section of the package.json:
```json
"dependencies": {
    "jest-allure-reporter": "^1.2.1"
}
```
Additionally configure the jest-allure-reporter as the test-reporter used by jest by adding the following to your jest.config.ts:
```typescript
testResultsProcessor: "jest-allure-reporter"
```
After editing of the two files install by running ``` npm update ``` on the commandline:
```
npm update
```

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