README.md

Testplan 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 Allure Testplan file which can be used by Allure integrations to define which tests should be executed.

Install

Use your favorite package manager to install the package:

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

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: {
+    testplan: {
+      options: {
+      },
+    },
  },
});

Options

The plugin accepts the following options:

Option	Description	Type	Default
fileName	Testplan filename	string	testplan.json
filter	Function that filters which Test Results should be present in the file	(result: TestResult) => boolean	Only unsuccessful tests appear in the file