# @allurereport/plugin-awesome

> Allure Awesome Plugin – brand new HTML report with modern design and new features

Latest version **3.20.0** (published 2026-10-02) · Apache-2.0 license · 0 weekly downloads

## Install

```sh
npm install @allurereport/plugin-awesome
pnpm add @allurereport/plugin-awesome
yarn add @allurereport/plugin-awesome
bun add @allurereport/plugin-awesome
```

## Health

**Score 70/100 (B)** — status: active.

Positive: has types; esm support; no vulnerabilities; recently updated; high maintenance score; high quality score.

Warnings: low downloads.

## Facts

| | |
|---|---|
| Version | 3.20.0 |
| Published | 2026-10-02 |
| First published | 2024-12-12 |
| Weekly downloads | 0 |
| License | Apache-2.0 |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 7 |
| Unpacked size | 2.7 MB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 412 |
| Author | Qameta Software |
| Maintainers | qameta-bot, baev |
| Keywords | allure, html, plugin, report, testing |

## Links

- npm: https://www.npmjs.com/package/@allurereport/plugin-awesome
- Repository: https://github.com/allure-framework/allure3
- npm.io page: https://npm.io/package/@allurereport/plugin-awesome

## Dependencies (7)

- [d3-shape](https://npm.io/package/d3-shape.md) ^3.2.0
- [handlebars](https://npm.io/package/handlebars.md) ^4.7.9
- [markdown-it](https://npm.io/package/markdown-it.md) ^14.2.0
- [@allurereport/core-api](https://npm.io/package/@allurereport/core-api.md) 3.20.0
- [@allurereport/charts-api](https://npm.io/package/@allurereport/charts-api.md) 3.20.0
- [@allurereport/plugin-api](https://npm.io/package/@allurereport/plugin-api.md) 3.20.0
- [@allurereport/web-commons](https://npm.io/package/@allurereport/web-commons.md) 3.20.0

## Alternatives

- [@tsparticles/shape-image](https://npm.io/package/@tsparticles/shape-image.md) — 303.7K weekly downloads
- [@tsparticles/shape-line](https://npm.io/package/@tsparticles/shape-line.md) — 233.7K weekly downloads
- [stringify-attributes](https://npm.io/package/stringify-attributes.md) — 58.6K weekly downloads
- [mobile-drag-drop](https://npm.io/package/mobile-drag-drop.md) — 46.3K weekly downloads
- [@comunica/actor-rdf-parse-html](https://npm.io/package/@comunica/actor-rdf-parse-html.md) — 29.2K weekly downloads

## Recent versions

- 3.20.0 (latest) — 2026-10-02
- 3.19.1 — 2026-09-29
- 3.19.0 — 2026-09-28
- 3.18.0 — 2026-09-18
- 3.17.0 — 2026-09-09
- 3.16.1 — 2026-09-07
- 3.16.0 — 2026-08-25
- 3.15.0 — 2026-08-13
- 3.14.3 — 2026-07-13
- 3.14.2 — 2026-07-08
- 3.14.1 — 2026-07-03
- 3.14.0 — 2026-06-30
- 3.13.2 — 2026-06-26
- 3.13.1 — 2026-06-24
- 3.13.0 — 2026-06-23
- … 44 more at https://npm.io/package/@allurereport/plugin-awesome/versions

## README

# Awesome Plugin

[<img src="https://allurereport.org/public/img/allure-report.svg" height="85px" alt="Allure Report logo" align="right" />](https://allurereport.org "Allure Report")

- Learn more about Allure Report at https://allurereport.org
- 📚 [Documentation](https://allurereport.org/docs/) – discover official documentation for Allure Report
- ❓ [Questions and Support](https://github.com/orgs/allure-framework/discussions/categories/questions-support) – get help from the team and community
- 📢 [Official announcements](https://github.com/orgs/allure-framework/discussions/categories/announcements) – be in touch with the latest updates
- 💬 [General Discussion ](https://github.com/orgs/allure-framework/discussions/categories/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:

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

Then, add the plugin to the Allure configuration file:

```diff
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:

```ts
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

```ts
import { defineConfig } from "allure";

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

---
_Source: https://npm.io/package/@allurereport/plugin-awesome · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
