Allure Reporter for Jest

Common errors

• Error: Jest: a reporter 'jest-allure2-reporter' cannot be found.

  cause The reporter string 'jest-allure2-reporter' is not resolvable by Jest, likely because the package is not installed or incorrectly referenced.
  fix Ensure `jest-allure2-reporter` is installed (`npm install --save-dev jest-allure2-reporter`) and correctly listed in `jest.config.js` reporters array.

• ReferenceError: allure is not defined

  cause The `allure` object or `@Step` decorator is not available in the global scope or imported incorrectly, often due to an incorrect `testEnvironment` setting.
  fix Verify `jest.config.js` includes `testEnvironment: 'jest-allure2-reporter/environment-node'` (or `.../environment-jsdom`) and that `allure` or `Step` are imported from `'jest-allure2-reporter/api'`.

• Cannot find name 'allure'. Did you mean 'URL'?

  cause When using TypeScript, the types for the `allure` object might not be correctly picked up by the compiler.
  fix Ensure you have imported `allure` from `'jest-allure2-reporter/api'` in your TypeScript files. Also, verify your `tsconfig.json` correctly includes `node_modules/@types` or relevant type declarations.

• Error: Allure commandline is not installed. Please install it globally `npm install -g allure-commandline`

  cause The `allure generate` or `allure open` commands are not found because the Allure CLI tool is not installed or not in the system's PATH.
  fix Install the Allure command line tool globally: `npm install -g allure-commandline`.

Warnings

• gotcha The Allure command line tool (`allure-commandline`) is a separate dependency and must be installed globally or locally to generate and serve reports after tests complete. This package only generates the raw Allure results.
  Fix: Install globally: `npm install -g allure-commandline` or `yarn global add allure-commandline`.
• breaking Older versions of Jest (below 27.2.5) are not supported. This reporter requires Jest 27.2.5 or higher. Compatibility fixes for Jest 30 were introduced in v2.2.1.
  Fix: Ensure your Jest version meets the peer dependency requirement (`jest@>=27.2.5`). Upgrade `jest` to at least `27.2.5`, preferably the latest stable version compatible with `jest-allure2-reporter`.
• gotcha If using TypeScript decorators like `@Step`, ensure `experimentalDecorators` and `emitDecoratorMetadata` are enabled in your `tsconfig.json`.
  Fix: Add `"experimentalDecorators": true, "emitDecoratorMetadata": true` to your `compilerOptions` in `tsconfig.json`.
• gotcha The `testEnvironment` must be explicitly set to either `jest-allure2-reporter/environment-node` (for Node.js tests) or `jest-allure2-reporter/environment-jsdom` (for browser-like tests). Failing to do so will result in Allure APIs not being available in your tests.
  Fix: Update your `jest.config.js` to include: `testEnvironment: 'jest-allure2-reporter/environment-node'` (or `.../environment-jsdom`).
• breaking Node.js versions older than 16.20.0 are not supported by the package. Running on unsupported Node.js versions may lead to unexpected errors or failures.
  Fix: Upgrade your Node.js environment to version 16.20.0 or higher.

Install

• npm install jest-allure2-reporter npm
• yarn add jest-allure2-reporter yarn
• pnpm add jest-allure2-reporter pnpm

Imports

• jest-allure2-reporter
  wrong:

  import { AllureReporter } from 'jest-allure2-reporter';

  correct:

  // jest.config.js
  module.exports = {
    reporters: [
      'default',
      'jest-allure2-reporter'
    ]
  };

  The reporter is configured as a string in Jest's `reporters` array, not directly imported.
• environment-node
  wrong:

  import { NodeEnvironment } from 'jest-allure2-reporter/environment-node';

  correct:

  // jest.config.js
  module.exports = {
    testEnvironment: 'jest-allure2-reporter/environment-node'
  };

  The test environment is specified as a string path in Jest configuration. Use `environment-jsdom` for browser tests.
• allure
  wrong:

  import allure from 'jest-allure2-reporter';

  correct:

  import { allure } from 'jest-allure2-reporter/api';

  The `allure` object for programmatic API access (e.g., adding steps, attachments, metadata) must be imported from the specific `api` subpath.
• Step
  wrong:

  import { Step } from 'jest-allure2-reporter';

  correct:

  import { Step } from 'jest-allure2-reporter/api';

  The `@Step` decorator, like the `allure` object, is exported from the `api` subpath for use in test files.

Quickstart

This quickstart demonstrates how to configure jest-allure2-reporter in `jest.config.js`, define test steps using the `@Step` decorator, add attachments and metadata with the `allure` API, and generate the final Allure report.

/* jest.config.js */
/** @type {import('@jest/types').Config.InitialOptions} */
module.exports = {
  reporters: [
    'default',
    'jest-allure2-reporter'
  ],
  testEnvironment: 'jest-allure2-reporter/environment-node'
};

/* my-page.ts */
import { allure, Step } from 'jest-allure2-reporter/api';

export class MyPage {
  @Step('Load user data for ID: {{userId}}')
  async loadUserData(userId: string) {
    const userData = { name: 'John Doe', id: userId };
    allure.attachment('User Data', JSON.stringify(userData, null, 2), 'application/json');
    return userData;
  }
}

/* my.test.ts */
import { allure } from 'jest-allure2-reporter/api';
import { MyPage } from './my-page';

describe('User Profile', () => {
  const page = new MyPage();

  it('should load user data correctly', async () => {
    allure.feature('Profile');
    allure.severity('critical');
    const userData = await page.loadUserData('user123');
    expect(userData.name).toBe('John Doe');
  });
});

// To generate and open reports after tests:
// npm install -g allure-commandline
// allure generate allure-results --clean
// allure open