@allurereport/plugin-awesome

Awesome Plugin

• Learn more about Allure Report at https://allurereport.org
• Documentation – discover official documentation for Allure Report
• Questions and Support – get help from the team and community
• Official announcements – be in touch with the latest updates
• General Discussion – engage in casual conversations, share insights and ideas with the community

---

Overview

The plugin generates brand new Allure Report with modern design and new features.

Install

Use your favorite package manager to install the package:

npm add @allurereport/plugin-awesome
yarn add @allurereport/plugin-awesome
pnpm add @allurereport/plugin-awesome

Then, add the plugin to the Allure configuration file:

import { defineConfig } from "allure";

export default defineConfig({
  name: "Allure Report",
  output: "./allure-report",
  historyPath: "./history.jsonl",
  plugins: {
+    awesome: {
+      options: {
+        reportName: "HelloWorld",
+      },
+    },
  },
});

Options

The plugin accepts the following options:

Option	Description	Type	Default
reportName	Name of the report	string	Allure Report
singleFile	Writes the report as a single index.html file	boolean	false
logo	Path to the logo image	string	null
theme	Default color theme of the report	light | dark | auto	auto OS theme
reportLanguage	Default language of the report	string	OS language
ci	CI data which will be rendered in the report	{ type: "github" | "jenkins", url: string, name: string }	undefined
groupBy	Grouping tests by labels or combining labels. By default, tests are grouped using the titlePath provided by the test framework.	string	[](Grouping by titlepath)
appendTitlePath	Special marker for groupBy. Forces a final grouping by titlePath after all label-based groups.	boolean	false
stepTreeExpansion	Default expansion policy for step trees in test details.	"collapsed" | "expand_failed_only" | "expanded"	"expand_failed_only"
defaultSortBy	Default sort order for the test tree. Accepted values: order,asc, order,desc, duration,asc, duration,desc, name,asc, name,desc, status,asc, status,desc. User's manual selection is preserved in localStorage and takes priority over this value.	string	order,asc

Default sort order

Use defaultSortBy to change the initial sort order of the test tree:

import { defineConfig } from "allure";

export default defineConfig({
  plugins: {
    awesome: {
      options: {
        defaultSortBy: "name,asc",
      },
    },
  },
});

The user's last selected sort order is always preserved in localStorage, so once a user changes the sort manually, their preference takes priority over the configured default.

Step tree expansion

Use stepTreeExpansion to control how steps are expanded in test details:

• collapsed - all steps are collapsed by default
• expand_failed_only - only failed or broken context is expanded by default
• expanded - all steps are expanded by default

import { defineConfig } from "allure";

export default defineConfig({
  plugins: {
    awesome: {
      options: {
        stepTreeExpansion: "expand_failed_only",
      },
    },
  },
});