@allurereport/plugin-progress 3.0.0-beta.3

package/README.md

@@ -0,0 +1,43 @@
+# Progress 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 indicates the report generation progress in the terminal.
+
+## Install
+
+Use your favorite package manager to install the package:
+
+```shell
+npm add @allurereport/plugin-progress
+yarn add @allurereport/plugin-progress
+pnpm add @allurereport/plugin-progress
+```
+
+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: {
++    progress: {
++      options: {
++      },
++    },
+  },
+});
+```

package/dist/index.d.ts

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

package/dist/index.js

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

package/dist/plugin.d.ts

@@ -0,0 +1,12 @@
+import type { AllureStore, Plugin, PluginContext, Realtime } from "@allurereport/plugin-api";
+import type { WriteStream } from "node:tty";
+export declare class ProgressPlugin implements Plugin {
+    #private;
+    readonly options: {
+        stream?: WriteStream;
+    };
+    constructor(options?: {
+        stream?: WriteStream;
+    });
+    start: (context: PluginContext, store: AllureStore, realtime: Realtime) => Promise<void>;
+}

package/dist/plugin.js

@@ -0,0 +1,53 @@
+var __classPrivateFieldSet = (this && this.__classPrivateFieldSet) || function (receiver, state, value, kind, f) {
+    if (kind === "m") throw new TypeError("Private method is not writable");
+    if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a setter");
+    if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot write private member to an object whose class did not declare it");
+    return (kind === "a" ? f.call(receiver, value) : f ? f.value = value : state.set(receiver, value)), value;
+};
+var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (receiver, state, kind, f) {
+    if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a getter");
+    if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot read private member from an object whose class did not declare it");
+    return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver);
+};
+var _ProgressPlugin_terminal, _ProgressPlugin_render;
+import * as process from "node:process";
+import { green, red, yellow } from "yoctocolors";
+import { Terminal } from "./terminal.js";
+export class ProgressPlugin {
+    constructor(options = {}) {
+        this.options = options;
+        _ProgressPlugin_terminal.set(this, void 0);
+        this.start = async (context, store, realtime) => {
+            realtime.onTestResults(async (trIds) => {
+                await __classPrivateFieldGet(this, _ProgressPlugin_render, "f").call(this, store);
+            });
+        };
+        _ProgressPlugin_render.set(this, async (store) => {
+            if (!__classPrivateFieldGet(this, _ProgressPlugin_terminal, "f")) {
+                return;
+            }
+            __classPrivateFieldGet(this, _ProgressPlugin_terminal, "f").cursorRelativeReset();
+            __classPrivateFieldGet(this, _ProgressPlugin_terminal, "f").clearLine();
+            __classPrivateFieldGet(this, _ProgressPlugin_terminal, "f").clearBottom();
+            const testsStatistic = await store.testsStatistic();
+            if (testsStatistic.failed) {
+                __classPrivateFieldGet(this, _ProgressPlugin_terminal, "f").write(`${red("failed")}: ${testsStatistic.failed}`);
+                __classPrivateFieldGet(this, _ProgressPlugin_terminal, "f").newline();
+            }
+            if (testsStatistic.broken) {
+                __classPrivateFieldGet(this, _ProgressPlugin_terminal, "f").write(`${yellow("broken")}: ${testsStatistic.broken}`);
+                __classPrivateFieldGet(this, _ProgressPlugin_terminal, "f").newline();
+            }
+            if (testsStatistic.passed) {
+                __classPrivateFieldGet(this, _ProgressPlugin_terminal, "f").write(`${green("passed")}: ${testsStatistic.passed}`);
+                __classPrivateFieldGet(this, _ProgressPlugin_terminal, "f").newline();
+            }
+            __classPrivateFieldGet(this, _ProgressPlugin_terminal, "f").write(`total: ${testsStatistic.total}`);
+        });
+        const { stream = process.stdout } = this.options;
+        if (stream) {
+            __classPrivateFieldSet(this, _ProgressPlugin_terminal, new Terminal(stream), "f");
+        }
+    }
+}
+_ProgressPlugin_terminal = new WeakMap(), _ProgressPlugin_render = new WeakMap();

package/dist/terminal.d.ts

@@ -0,0 +1,19 @@
+import type { WriteStream } from "node:tty";
+export declare class Terminal {
+    #private;
+    constructor(outputStream: WriteStream);
+    cursorSave(): void;
+    cursorRestore(): void;
+    cursor(enabled: boolean): void;
+    cursorTo(x: number, y?: number): void;
+    cursorRelative(dx: number, dy: number): void;
+    cursorRelativeReset(): void;
+    clearRight(): void;
+    clearLine(): void;
+    clearBottom(): void;
+    newline(): void;
+    write(s: string, rawWrite?: boolean): void;
+    lineWrapping(enabled: boolean): void;
+    isTTY(): boolean;
+    getWidth(): number;
+}

package/dist/terminal.js

@@ -0,0 +1,117 @@
+var __classPrivateFieldSet = (this && this.__classPrivateFieldSet) || function (receiver, state, value, kind, f) {
+    if (kind === "m") throw new TypeError("Private method is not writable");
+    if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a setter");
+    if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot write private member to an object whose class did not declare it");
+    return (kind === "a" ? f.call(receiver, value) : f ? f.value = value : state.set(receiver, value)), value;
+};
+var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (receiver, state, kind, f) {
+    if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a getter");
+    if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot read private member from an object whose class did not declare it");
+    return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver);
+};
+var _Terminal_stream, _Terminal_wrapLines, _Terminal_dy;
+import { clearLine, clearScreenDown, cursorTo, moveCursor } from "node:readline";
+export class Terminal {
+    constructor(outputStream) {
+        _Terminal_stream.set(this, void 0);
+        _Terminal_wrapLines.set(this, void 0);
+        _Terminal_dy.set(this, void 0);
+        __classPrivateFieldSet(this, _Terminal_stream, outputStream, "f");
+        __classPrivateFieldSet(this, _Terminal_wrapLines, true, "f");
+        __classPrivateFieldSet(this, _Terminal_dy, 0, "f");
+    }
+    cursorSave() {
+        if (!__classPrivateFieldGet(this, _Terminal_stream, "f").isTTY) {
+            return;
+        }
+        __classPrivateFieldGet(this, _Terminal_stream, "f").write("\x1B7");
+    }
+    cursorRestore() {
+        if (!__classPrivateFieldGet(this, _Terminal_stream, "f").isTTY) {
+            return;
+        }
+        __classPrivateFieldGet(this, _Terminal_stream, "f").write("\x1B8");
+    }
+    cursor(enabled) {
+        if (!__classPrivateFieldGet(this, _Terminal_stream, "f").isTTY) {
+            return;
+        }
+        if (enabled) {
+            __classPrivateFieldGet(this, _Terminal_stream, "f").write("\x1B[?25h");
+        }
+        else {
+            __classPrivateFieldGet(this, _Terminal_stream, "f").write("\x1B[?25l");
+        }
+    }
+    cursorTo(x, y) {
+        if (!__classPrivateFieldGet(this, _Terminal_stream, "f").isTTY) {
+            return;
+        }
+        cursorTo(__classPrivateFieldGet(this, _Terminal_stream, "f"), x, y);
+    }
+    cursorRelative(dx, dy) {
+        if (!__classPrivateFieldGet(this, _Terminal_stream, "f").isTTY) {
+            return;
+        }
+        __classPrivateFieldSet(this, _Terminal_dy, __classPrivateFieldGet(this, _Terminal_dy, "f") + dy, "f");
+        moveCursor(__classPrivateFieldGet(this, _Terminal_stream, "f"), dx, dy);
+    }
+    cursorRelativeReset() {
+        if (!__classPrivateFieldGet(this, _Terminal_stream, "f").isTTY) {
+            return;
+        }
+        moveCursor(__classPrivateFieldGet(this, _Terminal_stream, "f"), 0, -__classPrivateFieldGet(this, _Terminal_dy, "f"));
+        cursorTo(__classPrivateFieldGet(this, _Terminal_stream, "f"), 0);
+        __classPrivateFieldSet(this, _Terminal_dy, 0, "f");
+    }
+    clearRight() {
+        if (!__classPrivateFieldGet(this, _Terminal_stream, "f").isTTY) {
+            return;
+        }
+        clearLine(__classPrivateFieldGet(this, _Terminal_stream, "f"), 1);
+    }
+    clearLine() {
+        if (!__classPrivateFieldGet(this, _Terminal_stream, "f").isTTY) {
+            return;
+        }
+        clearLine(__classPrivateFieldGet(this, _Terminal_stream, "f"), 0);
+    }
+    clearBottom() {
+        if (!__classPrivateFieldGet(this, _Terminal_stream, "f").isTTY) {
+            return;
+        }
+        clearScreenDown(__classPrivateFieldGet(this, _Terminal_stream, "f"));
+    }
+    newline() {
+        var _a;
+        __classPrivateFieldGet(this, _Terminal_stream, "f").write("\n");
+        __classPrivateFieldSet(this, _Terminal_dy, (_a = __classPrivateFieldGet(this, _Terminal_dy, "f"), _a++, _a), "f");
+    }
+    write(s, rawWrite = false) {
+        if (__classPrivateFieldGet(this, _Terminal_wrapLines, "f") && !rawWrite) {
+            __classPrivateFieldGet(this, _Terminal_stream, "f").write(s.slice(0, this.getWidth()));
+        }
+        else {
+            __classPrivateFieldGet(this, _Terminal_stream, "f").write(s);
+        }
+    }
+    lineWrapping(enabled) {
+        if (!this.isTTY()) {
+            return;
+        }
+        __classPrivateFieldSet(this, _Terminal_wrapLines, enabled, "f");
+        if (enabled) {
+            __classPrivateFieldGet(this, _Terminal_stream, "f").write("\x1B[?7h");
+        }
+        else {
+            __classPrivateFieldGet(this, _Terminal_stream, "f").write("\x1B[?7l");
+        }
+    }
+    isTTY() {
+        return __classPrivateFieldGet(this, _Terminal_stream, "f").isTTY;
+    }
+    getWidth() {
+        return __classPrivateFieldGet(this, _Terminal_stream, "f").columns || (__classPrivateFieldGet(this, _Terminal_stream, "f").isTTY ? 80 : 200);
+    }
+}
+_Terminal_stream = new WeakMap(), _Terminal_wrapLines = new WeakMap(), _Terminal_dy = new WeakMap();

package/package.json

@@ -0,0 +1,56 @@
+{
+  "name": "@allurereport/plugin-progress",
+  "version": "3.0.0-beta.3",
+  "description": "Allure Plugin to show generation progress in console",
+  "keywords": [
+    "allure",
+    "testing",
+    "report",
+    "plugin",
+    "cli",
+    "stdout"
+  ],
+  "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",
+    "yoctocolors": "^2.1.1"
+  },
+  "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",
+    "@vitest/snapshot": "^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"
+  }
+}