@allurereport/plugin-csv 3.0.0-beta.3

package/README.md

@@ -0,0 +1,56 @@
+# CSV 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
+
+This plugin generates the Allure Report in CSV file format.
+
+## Install
+
+Use your favorite package manager to install the package:
+
+```shell
+npm add @allurereport/plugin-csv
+yarn add @allurereport/plugin-csv
+pnpm add @allurereport/plugin-csv
+```
+
+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: {
++    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        |
+

package/dist/csv.d.ts

@@ -0,0 +1,2 @@
+import type { CsvField, CsvOptions } from "./model.js";
+export declare const generateCsv: <T>(rows: T[], fields: CsvField<T>[], sort?: (a: T, b: T) => number, filter?: (a: T) => boolean, options?: CsvOptions) => Promise<string>;

package/dist/csv.js

@@ -0,0 +1,18 @@
+export const generateCsv = async (rows, fields, sort = () => 0, filter = () => true, options = {}) => {
+    const { disableHeaders = false, separator = "," } = options;
+    const content = [...rows]
+        .filter(filter)
+        .sort(sort)
+        .map((tr) => {
+        return fields
+            .map(({ accessor }) => (typeof accessor === "function" ? accessor(tr) : tr[accessor]))
+            .map(forceEscapeCsv)
+            .join(separator);
+    })
+        .join("\n");
+    const header = disableHeaders ? "" : fields.map((f) => f.header).join(separator) + "\n";
+    return header + content;
+};
+const forceEscapeCsv = (value) => {
+    return value ? '"' + `${value}`.replaceAll('"', '""') + '"' : "";
+};

package/dist/index.d.ts

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

package/dist/index.js

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

package/dist/model.d.ts

@@ -0,0 +1,15 @@
+import type { TestResult } from "@allurereport/core-api";
+export type CsvOptions = {
+    separator?: string;
+    disableHeaders?: boolean;
+};
+export type CsvField<T> = {
+    header: string;
+    accessor: keyof T | ((result: T) => string | undefined);
+};
+export type CsvPluginOptions = {
+    fileName?: string;
+    fields?: CsvField<TestResult>[];
+    sort?: (a: TestResult, b: TestResult) => number;
+    filter?: (a: TestResult) => boolean;
+} & CsvOptions;

package/dist/model.js

@@ -0,0 +1 @@
+export {};

package/dist/plugin.d.ts

@@ -0,0 +1,7 @@
+import type { AllureStore, Plugin, PluginContext } from "@allurereport/plugin-api";
+import type { CsvPluginOptions } from "./model.js";
+export declare class CsvPlugin implements Plugin {
+    readonly options: CsvPluginOptions;
+    constructor(options?: CsvPluginOptions);
+    done: (context: PluginContext, store: AllureStore) => Promise<void>;
+}

package/dist/plugin.js

@@ -0,0 +1,41 @@
+import { formatDuration } from "@allurereport/core-api";
+import { generateCsv } from "./csv.js";
+import { formatSteps, labelValue } from "./utils.js";
+const defaultFields = [
+    { header: "Full Name", accessor: "fullName" },
+    {
+        header: "Name",
+        accessor: "name",
+    },
+    {
+        header: "Status",
+        accessor: "status",
+    },
+    {
+        header: "Duration",
+        accessor: (result) => formatDuration(result.duration),
+    },
+    { header: "Error", accessor: "message" },
+    { header: "Stack Trace", accessor: "trace" },
+    { header: "Steps", accessor: formatSteps },
+    { header: "Parent Suite", accessor: labelValue("parentSuite") },
+    { header: "Suite", accessor: labelValue("suite") },
+    { header: "Sub Suite", accessor: labelValue("subSuite") },
+    { header: "Epic", accessor: labelValue("epic") },
+    { header: "Feature", accessor: labelValue("feature") },
+    { header: "Story", accessor: labelValue("story") },
+];
+const defaultSort = (a, b) => a.name.localeCompare(b.name);
+export class CsvPlugin {
+    constructor(options = {}) {
+        this.options = options;
+        this.done = async (context, store) => {
+            const { reportFiles } = context;
+            const testResults = await store.allTestResults();
+            const { fields = defaultFields, sort = defaultSort, filter, fileName = "report.csv" } = this.options;
+            const content = await generateCsv(testResults, fields, sort, filter, this.options);
+            const result = Buffer.from(content, "utf-8");
+            await reportFiles.addFile(fileName, result);
+        };
+    }
+}

package/dist/utils.d.ts

@@ -0,0 +1,3 @@
+import type { TestResult } from "@allurereport/core-api";
+export declare const formatSteps: (tr: TestResult) => string | undefined;
+export declare const labelValue: (name: string) => ((result: TestResult) => string | undefined);

package/dist/utils.js

@@ -0,0 +1,30 @@
+import { formatDuration } from "@allurereport/core-api";
+export const formatSteps = (tr) => {
+    if (tr.steps.length === 0) {
+        return undefined;
+    }
+    return tr.steps
+        .map(formatStep)
+        .filter((s) => s)
+        .join("\n");
+};
+const formatStep = (step, indent = 0) => {
+    if (step.type !== "step") {
+        return undefined;
+    }
+    const prefix = " ".repeat(indent);
+    const res = [
+        prefix + step.name + " " + step.status + ` (${formatDuration(step.duration)})`,
+        ...step.steps.map((s) => formatStep(s, indent + 2)).filter((s) => s),
+    ];
+    return res.join("\n");
+};
+export const labelValue = (name) => {
+    return (result) => result.labels
+        .filter((l) => l.name === name)
+        .map((l) => l.value)
+        .filter((v) => v)
+        .map((v) => v)
+        .sort()
+        .join(",");
+};

package/package.json

@@ -0,0 +1,53 @@
+{
+  "name": "@allurereport/plugin-csv",
+  "version": "3.0.0-beta.3",
+  "description": "Allure CSV report",
+  "keywords": [
+    "allure",
+    "testing",
+    "report",
+    "plugin",
+    "csv"
+  ],
+  "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"
+  }
+}