Introduction
This website version refers to the unreleased version of jest-allure2-reporter, partially available as 2.0.0-beta.3 release.
Please use GitHub docs for the latest stable version, 1.x.x.
Thanks for choosing Jest Allure 2 Reporter!
Whether you're a developer, QA professional, or someone involved in unit, integration, or end-to-end testing, this tool will make your testing process more efficient, organized, and insightful.
What is jest-allure2-reporter?
jest-allure2-reporter is a reporting toolkit for Jest, a widely popular testing framework in the JavaScript ecosystem.
The produced reports look like directories with multiple JSON files.
They can be viewed using the allure command-line tool, a flexible, feature-rich reporting tool that provides clear and concise test result representation.
It provides several entry points:
jest-allure2-reporter- The reporter itself, which is responsible for collecting test results and generating a report.
jest-allure2-reporter/api- DSL to add additional metadata to your test definitions:
$Link,$Owner. allureruntime API to use inside your tests:allure.step,allure.attachment.Environment packages, to enable the annotations, media attachments and provide additional test data:
jest-allure2-reporter/environment-node- For Node.js tests.
jest-allure2-reporter/environment-jsdom- For browser tests.
jest-allure2-reporter/environment-decorator- For advanced use cases where you need to extend an already customized test environment.
Why one more Allure reporter for Jest?
Jest's evolution from Jasmine to its own Circus test runner in version 27.0.0 brought new opportunities for enhanced testing, but it also created a void: existing Allure reporters1, designed for Jasmine, fell short of leveraging Jest's new features and refined test lifecycle.
While community-made reporters sought to bridge this gap234, they had their own shortcomings — issues with irregular maintenance, limited reach, and significant feature gaps were prevalent. Most critically, they took a non-idiomatic approach by acting as extensions to Jest's testEnvironment, which led to a critical shortcomings: e.g., inability to report early test issues like SyntaxError or test environment setup failures.
Takeaways
- This reporter is a powerful tool tailor-made for the modern Jest ecosystem, not "yet another Allure reporter".
- Easy to understand, straightforward to adopt, and flexible to work with – it's the Jest Allure reporter you've been waiting for.
- It is progressive by design — you can start using it like a standard reporter, but the more you invest in it, the more you get out of it.
Ready to explore what this reporter can do for you? Begin your journey here.