@allurereport/plugin-testplan 3.0.0-beta.3

package/README.md

@@ -0,0 +1,52 @@
+# Testplan 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 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:
+
+```shell
+npm add @allurereport/plugin-testplan
+yarn add @allurereport/plugin-testplan
+pnpm add @allurereport/plugin-testplan
+```
+
+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: {
++    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 |

package/dist/index.d.ts

@@ -0,0 +1,2 @@
+import { TestPlanPlugin } from "./plugin.js";
+export default TestPlanPlugin;

package/dist/index.js

@@ -0,0 +1,2 @@
+import { TestPlanPlugin } from "./plugin.js";
+export default TestPlanPlugin;

package/dist/plugin.d.ts

@@ -0,0 +1,12 @@
+import { type TestResult } from "@allurereport/core-api";
+import type { AllureStore, Plugin, PluginContext } from "@allurereport/plugin-api";
+interface TestPlanPluginOptions {
+    fileName?: string;
+    filter?: (a: TestResult) => boolean;
+}
+export declare class TestPlanPlugin implements Plugin {
+    readonly options: TestPlanPluginOptions;
+    constructor(options?: TestPlanPluginOptions);
+    done: (context: PluginContext, store: AllureStore) => Promise<void>;
+}
+export {};

package/dist/plugin.js

@@ -0,0 +1,20 @@
+import { createTestPlan, filterUnsuccessful } from "@allurereport/core-api";
+import console from "node:console";
+export class TestPlanPlugin {
+    constructor(options = {}) {
+        this.options = options;
+        this.done = async (context, store) => {
+            const { reportFiles } = context;
+            const testResults = await store.allTestResults();
+            const { filter = filterUnsuccessful, fileName = "testplan.json" } = this.options;
+            const included = testResults.filter(filter);
+            if (included.length === 0) {
+                console.log("no tests included to test plan, skipping the generation");
+                return;
+            }
+            const testPlan = createTestPlan(included);
+            const result = Buffer.from(JSON.stringify(testPlan), "utf-8");
+            await reportFiles.addFile(fileName, result);
+        };
+    }
+}

package/package.json

@@ -0,0 +1,52 @@
+{
+  "name": "@allurereport/plugin-testplan",
+  "version": "3.0.0-beta.3",
+  "description": "Allure Plugin to generate testplan.json",
+  "keywords": [
+    "allure",
+    "testing",
+    "report",
+    "plugin"
+  ],
+  "repository": "https://github.com/allure-framework/allure3",
+  "license": "Apache-2.0",
+  "author": "Qameta Software",
+  "type": "module",
+  "exports": {
+    ".": "./dist/index.js"
+  },
+  "main": "./dist/index.js",
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "files": [
+    "./dist"
+  ],
+  "scripts": {
+    "build": "run clean && tsc --project ./tsconfig.json",
+    "clean": "rimraf ./dist",
+    "test": "rimraf ./out && vitest run"
+  },
+  "dependencies": {
+    "@allurereport/core-api": "3.0.0-beta.3",
+    "@allurereport/plugin-api": "3.0.0-beta.3"
+  },
+  "devDependencies": {
+    "@stylistic/eslint-plugin": "^2.6.1",
+    "@types/eslint": "^8.56.11",
+    "@types/node": "^20.17.9",
+    "@typescript-eslint/eslint-plugin": "^8.0.0",
+    "@typescript-eslint/parser": "^8.0.0",
+    "@vitest/runner": "^2.1.8",
+    "allure-vitest": "^3.0.7",
+    "eslint": "^8.57.0",
+    "eslint-config-prettier": "^9.1.0",
+    "eslint-plugin-import": "^2.29.1",
+    "eslint-plugin-jsdoc": "^50.0.0",
+    "eslint-plugin-n": "^17.10.1",
+    "eslint-plugin-no-null": "^1.0.2",
+    "eslint-plugin-prefer-arrow": "^1.2.3",
+    "rimraf": "^6.0.1",
+    "typescript": "^5.6.3",
+    "vitest": "^2.1.8"
+  }
+}