npm.io
3.13.2 • Published 2d ago

@allurereport/summary

Licence
Apache-2.0
Version
3.13.2
Deps
4
Size
10 kB
Vulns
0
Weekly
0

Summary Plugin

Allure Report logo


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

Keywords