allure 3.0.0-beta.11 → 3.0.0-beta.12

package/dist/commands/dashboard.d.ts

@@ -0,0 +1,11 @@
+type DashboardCommandOptions = {
+    output?: string;
+    reportName?: string;
+    reportLanguage?: string;
+    logo?: string;
+    singleFile?: boolean;
+    theme?: "light" | "dark";
+};
+export declare const DashboardCommandAction: (resultsDir: string, options: DashboardCommandOptions) => Promise<void>;
+export declare const DashboardCommand: (cli: import("cac").CAC) => void;
+export {};

package/dist/commands/dashboard.js

@@ -0,0 +1,68 @@
+import { AllureReport, resolveConfig } from "@allurereport/core";
+import * as console from "node:console";
+import { createCommand } from "../utils/commands.js";
+export const DashboardCommandAction = async (resultsDir, options) => {
+    const before = new Date().getTime();
+    const { output, reportName: name, ...rest } = options;
+    const config = await resolveConfig({
+        output,
+        name,
+        plugins: {
+            "@allurereport/plugin-dashboard": {
+                options: rest,
+            },
+        },
+    });
+    const allureReport = new AllureReport(config);
+    await allureReport.start();
+    await allureReport.readDirectory(resultsDir);
+    await allureReport.done();
+    const after = new Date().getTime();
+    console.log(`the report successfully generated (${after - before}ms)`);
+};
+export const DashboardCommand = createCommand({
+    name: "dashboard <resultsDir>",
+    description: "Generates Allure Dashboard report based on provided Allure Results",
+    options: [
+        [
+            "--output, -o <file>",
+            {
+                description: "The output directory name. Absolute paths are accepted as well",
+                default: "allure-report",
+            },
+        ],
+        [
+            "--report-name, --name <string>",
+            {
+                description: "The report name",
+                default: "Allure Report",
+            },
+        ],
+        [
+            "--single-file",
+            {
+                description: "Generate single file report",
+                default: false,
+            },
+        ],
+        [
+            "--logo <string>",
+            {
+                description: "Path to the report logo which will be displayed in the header",
+            },
+        ],
+        [
+            "--theme <string>",
+            {
+                description: "Default theme of the report (default: OS theme)",
+            },
+        ],
+        [
+            "--report-language, --lang <string>",
+            {
+                description: "Default language of the report (default: OS language)",
+            },
+        ],
+    ],
+    action: DashboardCommandAction,
+});

package/dist/commands/index.d.ts

@@ -14,3 +14,4 @@ export * from "./open.js";
 export * from "./qualityGate.js";
 export * from "./log.js";
 export * from "./generate.js";
+export * from "./dashboard.js";

package/dist/commands/index.js

@@ -14,3 +14,4 @@ export * from "./open.js";
 export * from "./qualityGate.js";
 export * from "./log.js";
 export * from "./generate.js";
+export * from "./dashboard.js";

package/dist/index.js

@@ -2,7 +2,7 @@ import { cac } from "cac";
 import console from "node:console";
 import { readFileSync } from "node:fs";
 import { cwd } from "node:process";
-import { AwesomeCommand, ClassicCommand, ClassicLegacyCommand, CsvCommand, GenerateCommand, HistoryCommand, KnownIssueCommand, LogCommand, OpenCommand, QualityGateCommand, RunCommand, SlackCommand, TestPlanCommand, WatchCommand, } from "./commands/index.js";
+import { AwesomeCommand, ClassicCommand, ClassicLegacyCommand, CsvCommand, DashboardCommand, GenerateCommand, HistoryCommand, KnownIssueCommand, LogCommand, OpenCommand, QualityGateCommand, RunCommand, SlackCommand, TestPlanCommand, WatchCommand, } from "./commands/index.js";
 const pkg = JSON.parse(readFileSync(new URL("../package.json", import.meta.url), "utf8"));
 const cli = cac(pkg.name).usage(pkg.description).help().version(pkg.version);
 const commands = [
@@ -10,6 +10,7 @@ const commands = [
     ClassicLegacyCommand,
     AwesomeCommand,
     CsvCommand,
+    DashboardCommand,
     GenerateCommand,
     HistoryCommand,
     KnownIssueCommand,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "allure",
-  "version": "3.0.0-beta.11",
+  "version": "3.0.0-beta.12",
   "description": "Allure Commandline Tool",
   "keywords": [
     "allure",
@@ -30,18 +30,19 @@
     "test": "vitest run"
   },
   "dependencies": {
-    "@allurereport/core": "3.0.0-beta.11",
-    "@allurereport/core-api": "3.0.0-beta.11",
-    "@allurereport/directory-watcher": "3.0.0-beta.11",
-    "@allurereport/plugin-allure2": "3.0.0-beta.11",
-    "@allurereport/plugin-api": "3.0.0-beta.11",
-    "@allurereport/plugin-awesome": "3.0.0-beta.11",
-    "@allurereport/plugin-classic": "3.0.0-beta.11",
-    "@allurereport/plugin-progress": "3.0.0-beta.11",
-    "@allurereport/plugin-server-reload": "3.0.0-beta.11",
-    "@allurereport/plugin-slack": "3.0.0-beta.11",
-    "@allurereport/reader-api": "3.0.0-beta.11",
-    "@allurereport/static-server": "3.0.0-beta.11",
+    "@allurereport/core": "3.0.0-beta.12",
+    "@allurereport/core-api": "3.0.0-beta.12",
+    "@allurereport/directory-watcher": "3.0.0-beta.12",
+    "@allurereport/plugin-allure2": "3.0.0-beta.12",
+    "@allurereport/plugin-api": "3.0.0-beta.12",
+    "@allurereport/plugin-awesome": "3.0.0-beta.12",
+    "@allurereport/plugin-classic": "3.0.0-beta.12",
+    "@allurereport/plugin-dashboard": "3.0.0-beta.12",
+    "@allurereport/plugin-progress": "3.0.0-beta.12",
+    "@allurereport/plugin-server-reload": "3.0.0-beta.12",
+    "@allurereport/plugin-slack": "3.0.0-beta.12",
+    "@allurereport/reader-api": "3.0.0-beta.12",
+    "@allurereport/static-server": "3.0.0-beta.12",
     "cac": "^6.7.14",
     "lodash.omit": "^4.5.0",
     "yoctocolors": "^2.1.1"