README.md

CSV 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

This plugin generates the Allure Report in CSV file format.

Install

Use your favorite package manager to install the package:

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

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: {
+    csv: {
+      options: {
+        fileName: "my-report.csv",
+      },
+    },
  },
});

Options

The plugin accepts the following options:

Option	Description	Type	Default
fileName	Name of the report file	string	allure-report.csv
fields	Fields to include in the report	{ header: string; accessor: keyof T | ((result: T) => string | undefined) }[]	All fields
sort	Sorting function	(a: T, b: T) => number	Default order
filter	Filtering function	(a: T) => boolean	No filtering