allure 3.0.0-beta.16 → 3.0.0-beta.17

package/dist/commands/projects/delete.js

@@ -1,74 +1,68 @@
 import { readConfig } from "@allurereport/core";
 import { AllureServiceClient, KnownError } from "@allurereport/service";
+import { Command, Option } from "clipanion";
+import * as console from "node:console";
+import { exit } from "node:process";
 import prompts from "prompts";
 import { green, red } from "yoctocolors";
-import { createCommand } from "../../utils/commands.js";
 import { logError } from "../../utils/logs.js";
-export const ProjectsDeleteCommandAction = async (projectName, options) => {
-    const { force = false } = options ?? {};
-    const { config: configPath, cwd } = options ?? {};
-    const config = await readConfig(cwd, configPath);
-    if (!config?.allureService?.url) {
-        console.error(red("No Allure Service URL is provided. Please provide it in the `allureService.url` field in the `allure.config.js` file"));
-        process.exit(1);
-        return;
-    }
-    const serviceClient = new AllureServiceClient(config.allureService);
-    if (!projectName) {
-        console.error(red("No project name is provided"));
-        process.exit(1);
-        return;
-    }
-    if (!force) {
-        const res = await prompts({
-            type: "confirm",
-            name: "value",
-            message: `Are you sure you want to delete project "${projectName}"?`,
+export class ProjectsDeleteCommand extends Command {
+    constructor() {
+        super(...arguments);
+        this.projectName = Option.String({ required: true, name: "Project name" });
+        this.force = Option.Boolean("--force", {
+            description: "Delete project with no confirmation",
         });
-        if (!res.value) {
-            process.exit(0);
-            return;
-        }
-    }
-    try {
-        await serviceClient.deleteProject({
-            name: projectName,
+        this.config = Option.String("--config,-c", {
+            description: "The path Allure config file",
+        });
+        this.cwd = Option.String("--cwd", {
+            description: "The working directory for the command to run (default: current working directory)",
         });
-        console.info(green("Project has been deleted"));
     }
-    catch (error) {
-        if (error instanceof KnownError) {
-            console.error(red(error.message));
-            process.exit(1);
+    async execute() {
+        const config = await readConfig(this.cwd, this.config);
+        if (!config?.allureService?.url) {
+            console.error(red("No Allure Service URL is provided. Please provide it in the `allureService.url` field in the `allure.config.js` file"));
+            exit(1);
             return;
         }
-        await logError("Failed to delete project due to unexpected error", error);
-        process.exit(1);
+        const serviceClient = new AllureServiceClient(config.allureService);
+        if (!this.force) {
+            const res = await prompts({
+                type: "confirm",
+                name: "value",
+                message: `Are you sure you want to delete project "${this.projectName}"?`,
+            });
+            if (!res.value) {
+                exit(0);
+                return;
+            }
+        }
+        try {
+            await serviceClient.deleteProject({
+                name: this.projectName,
+            });
+            console.info(green("Project has been deleted"));
+        }
+        catch (error) {
+            if (error instanceof KnownError) {
+                console.error(red(error.message));
+                exit(1);
+                return;
+            }
+            await logError("Failed to delete project due to unexpected error", error);
+            exit(1);
+        }
     }
-};
-export const ProjectsDeleteCommand = createCommand({
-    name: "project-delete <name>",
-    description: "",
-    options: [
-        [
-            "--force",
-            {
-                description: "Delete project with no confirmation",
-                default: false,
-            },
-        ],
-        [
-            "--config, -c <file>",
-            {
-                description: "The path Allure config file",
-            },
-        ],
-        [
-            "--cwd <cwd>",
-            {
-                description: "The working directory for the command to run (default: current working directory)",
-            },
-        ],
+}
+ProjectsDeleteCommand.paths = [["projects", "delete"]];
+ProjectsDeleteCommand.usage = Command.Usage({
+    category: "Allure Service Projects",
+    description: "Deletes a project",
+    details: "This command deletes a project from the Allure Service.",
+    examples: [
+        ["project-delete my-project", "Delete the project named 'my-project' (with confirmation)"],
+        ["project-delete my-project --force", "Delete the project named 'my-project' without confirmation"],
     ],
-    action: ProjectsDeleteCommandAction,
 });

package/dist/commands/projects/list.d.ts

@@ -1,7 +1,8 @@
-type CommandOptions = {
-    config?: string;
-    cwd?: string;
-};
-export declare const ProjectsListCommandAction: (options?: CommandOptions) => Promise<void>;
-export declare const ProjectsListCommand: (cli: import("cac").CAC) => void;
-export {};
+import { Command } from "clipanion";
+export declare class ProjectsListCommand extends Command {
+    static paths: string[][];
+    static usage: import("clipanion").Usage;
+    config: string | undefined;
+    cwd: string | undefined;
+    execute(): Promise<void>;
+}

package/dist/commands/projects/list.js

@@ -1,75 +1,75 @@
 import { readConfig } from "@allurereport/core";
 import { AllureServiceClient, KnownError } from "@allurereport/service";
+import { Command, Option } from "clipanion";
+import * as console from "node:console";
+import { exit } from "node:process";
 import prompts from "prompts";
 import { green, red, yellow } from "yoctocolors";
-import { createCommand } from "../../utils/commands.js";
 import { logError } from "../../utils/logs.js";
-export const ProjectsListCommandAction = async (options) => {
-    const { config: configPath, cwd } = options ?? {};
-    const config = await readConfig(cwd, configPath);
-    if (!config?.allureService?.url) {
-        console.error(red("No Allure Service URL is provided. Please provide it in the `allureService.url` field in the `allure.config.js` file"));
-        process.exit(1);
-        return;
+export class ProjectsListCommand extends Command {
+    constructor() {
+        super(...arguments);
+        this.config = Option.String("--config,-c", {
+            description: "The path Allure config file",
+        });
+        this.cwd = Option.String("--cwd", {
+            description: "The working directory for the command to run (default: current working directory)",
+        });
     }
-    const serviceClient = new AllureServiceClient(config.allureService);
-    try {
-        const projects = await serviceClient.projects();
-        if (projects.length === 0) {
-            console.info(yellow("No projects found. Create a new one with `allure project-create` command"));
+    async execute() {
+        const config = await readConfig(this.cwd, this.config);
+        if (!config?.allureService?.url) {
+            console.error(red("No Allure Service URL is provided. Please provide it in the `allureService.url` field in the `allure.config.js` file"));
+            exit(1);
             return;
         }
-        const res = await prompts({
-            type: "select",
-            name: "project",
-            message: "Select a project",
-            choices: projects.map((project) => ({
-                title: project.name,
-                value: project.name,
-            })),
-        });
-        if (!res?.project) {
-            console.error(red("No project selected"));
-            process.exit(1);
-            return;
+        const serviceClient = new AllureServiceClient(config.allureService);
+        try {
+            const projects = await serviceClient.projects();
+            if (projects.length === 0) {
+                console.info(yellow("No projects found. Create a new one with `allure project-create` command"));
+                return;
+            }
+            const res = await prompts({
+                type: "select",
+                name: "project",
+                message: "Select a project",
+                choices: projects.map((project) => ({
+                    title: project.name,
+                    value: project.name,
+                })),
+            });
+            if (!res?.project) {
+                console.error(red("No project selected"));
+                exit(1);
+                return;
+            }
+            const lines = [
+                "Insert following code into your Allure Config file, to enable Allure Service features for the project:",
+                "",
+                green("{"),
+                green("  allureService: {"),
+                green(`    project: "${res.project}"`),
+                green("  }"),
+                green("}"),
+            ];
+            console.info(lines.join("\n"));
         }
-        const lines = [
-            "Insert following code into your Allure Config file, to enable Allure Service features for the project:",
-            "",
-            green("{"),
-            green("  allureService: {"),
-            green(`    project: "${res.project}"`),
-            green("  }"),
-            green("}"),
-        ];
-        console.info(lines.join("\n"));
-    }
-    catch (error) {
-        if (error instanceof KnownError) {
-            console.error(red(error.message));
-            process.exit(1);
-            return;
+        catch (error) {
+            if (error instanceof KnownError) {
+                console.error(red(error.message));
+                exit(1);
+                return;
+            }
+            await logError("Failed to get projects due to unexpected error", error);
+            exit(1);
         }
-        await logError("Failed to get projects due to unexpected error", error);
-        process.exit(1);
     }
-};
-export const ProjectsListCommand = createCommand({
-    name: "projects",
+}
+ProjectsListCommand.paths = [["projects", "list"]];
+ProjectsListCommand.usage = Command.Usage({
+    category: "Allure Service Projects",
     description: "Shows list of all available projects for current user",
-    options: [
-        [
-            "--config, -c <file>",
-            {
-                description: "The path Allure config file",
-            },
-        ],
-        [
-            "--cwd <cwd>",
-            {
-                description: "The working directory for the command to run (default: current working directory)",
-            },
-        ],
-    ],
-    action: ProjectsListCommandAction,
+    details: "This command lists all available projects for the current user and allows selecting one to get configuration information.",
+    examples: [["projects", "List all available projects"]],
 });

package/dist/commands/qualityGate.d.ts

@@ -1,7 +1,9 @@
-type QualityGateCommandOptions = {
-    config?: string;
-    cwd?: string;
-};
-export declare const QualityGateCommandAction: (resultsDir: string, options: QualityGateCommandOptions) => Promise<void>;
-export declare const QualityGateCommand: (cli: import("cac").CAC) => void;
-export {};
+import { Command } from "clipanion";
+export declare class QualityGateCommand extends Command {
+    static paths: string[][];
+    static usage: import("clipanion").Usage;
+    resultsDir: string;
+    config: string | undefined;
+    cwd: string | undefined;
+    execute(): Promise<void>;
+}

package/dist/commands/qualityGate.js

@@ -1,52 +1,56 @@
 import { AllureReport, readConfig } from "@allurereport/core";
-import console from "node:console";
-import process from "node:process";
+import { Command, Option } from "clipanion";
+import * as console from "node:console";
+import { exit } from "node:process";
 import { bold, red } from "yoctocolors";
-import { createCommand } from "../utils/commands.js";
-export const QualityGateCommandAction = async (resultsDir, options) => {
-    const { cwd, config: configPath } = options;
-    const fullConfig = await readConfig(cwd, configPath);
-    const allureReport = new AllureReport(fullConfig);
-    await allureReport.start();
-    await allureReport.readDirectory(resultsDir);
-    await allureReport.done();
-    await allureReport.validate();
-    if (allureReport.exitCode === 0) {
-        return;
+export class QualityGateCommand extends Command {
+    constructor() {
+        super(...arguments);
+        this.resultsDir = Option.String({ required: true, name: "The directory with Allure results" });
+        this.config = Option.String("--config,-c", {
+            description: "The path Allure config file",
+        });
+        this.cwd = Option.String("--cwd", {
+            description: "The working directory for the command to run (default: current working directory)",
+        });
     }
-    const failedResults = allureReport.validationResults.filter((result) => !result.success);
-    console.error(red(`Quality gate has failed with ${bold(failedResults.length.toString())} errors:\n`));
-    for (const result of failedResults) {
-        let scope = "";
-        switch (result.meta?.type) {
-            case "label":
-                scope = `(label[${result.meta.name}="${result.meta.value}"])`;
-                break;
-            case "parameter":
-                scope = `(parameter[${result.meta.name}="${result.meta.value}"])`;
-                break;
+    async execute() {
+        const fullConfig = await readConfig(this.cwd, this.config);
+        const allureReport = new AllureReport(fullConfig);
+        await allureReport.start();
+        await allureReport.readDirectory(this.resultsDir);
+        await allureReport.done();
+        await allureReport.validate();
+        if (allureReport.exitCode === 0) {
+            return;
         }
-        console.error(red(`⨯ ${bold(`${result.rule}${scope}`)}: expected ${result.expected}, actual ${result.actual}`));
+        const failedResults = allureReport.validationResults.filter((result) => !result.success);
+        console.error(red(`Quality gate has failed with ${bold(failedResults.length.toString())} errors:\n`));
+        for (const result of failedResults) {
+            let scope = "";
+            switch (result.meta?.type) {
+                case "label":
+                    scope = `(label[${result.meta.name}="${result.meta.value}"])`;
+                    break;
+                case "parameter":
+                    scope = `(parameter[${result.meta.name}="${result.meta.value}"])`;
+                    break;
+            }
+            console.error(red(`⨯ ${bold(`${result.rule}${scope}`)}: expected ${result.expected}, actual ${result.actual}`));
+        }
+        console.error(red("\nThe process has been exited with code 1"));
+        exit(allureReport.exitCode);
     }
-    console.error(red("\nThe process has been exited with code 1"));
-    process.exit(allureReport.exitCode);
-};
-export const QualityGateCommand = createCommand({
-    name: "quality-gate <resultsDir>",
+}
+QualityGateCommand.paths = [["quality-gate"]];
+QualityGateCommand.usage = Command.Usage({
     description: "Returns status code 1 if there any test failure above specified success rate",
-    options: [
-        [
-            "--config, -c <file>",
-            {
-                description: "The path Allure config file",
-            },
-        ],
+    details: "This command validates the test results against quality gates defined in the configuration.",
+    examples: [
+        ["quality-gate ./allure-results", "Validate the test results in the ./allure-results directory"],
         [
-            "--cwd <cwd>",
-            {
-                description: "The working directory for the command to run (Default: current working directory)",
-            },
+            "quality-gate ./allure-results --config custom-config.js",
+            "Validate the test results using a custom configuration file",
         ],
     ],
-    action: QualityGateCommandAction,
 });

package/dist/commands/run.d.ts

@@ -1,10 +1,13 @@
-export type RunCommandOptions = {
-    config?: string;
-    cwd?: string;
-    output?: string;
-    reportName?: string;
-    rerun?: number;
-    silent?: boolean;
-} & Record<"--", string[]>;
-export declare const RunCommandAction: (options: RunCommandOptions) => Promise<void>;
-export declare const RunCommand: (cli: import("cac").CAC) => void;
+import { Command } from "clipanion";
+export declare class RunCommand extends Command {
+    static paths: string[][];
+    static usage: import("clipanion").Usage;
+    config: string | undefined;
+    cwd: string | undefined;
+    output: string | undefined;
+    reportName: string | undefined;
+    rerun: string | undefined;
+    silent: boolean | undefined;
+    commandToRun: string[];
+    execute(): Promise<void>;
+}