allure 3.20.1 → 3.22.0

package/dist/utils/ghWorkflow.js

@@ -0,0 +1,75 @@
+import { UsageError } from "clipanion";
+import { normalizeCommandEnvironmentOptions } from "./environment.js";
+const SAFE_TOKEN = /^[A-Za-z0-9._/:@=-]+$/;
+const INVISIBLE_CHARS = /[\p{Cc}\p{Cf}\p{Zl}\p{Zp}]/u;
+const CHECKOUT_ACTION = "actions/checkout@v6";
+const UPLOAD_ARTIFACT_ACTION = "actions/upload-artifact@v7";
+const DOWNLOAD_ARTIFACT_ACTION = "actions/download-artifact@v8";
+const DEFAULT_TEST_COMMAND = ["npm", "test"];
+const ENVIRONMENT = "${{ matrix.environment }}";
+const NOT_CANCELLED = "${{ !cancelled() }}";
+export const shellQuote = (value) => SAFE_TOKEN.test(value) && !value.startsWith("=") ? value : `'${value.replace(/'/g, `'\\''`)}'`;
+const assertPrintable = (label, value) => {
+    if (INVISIBLE_CHARS.test(value)) {
+        throw new UsageError(`${label} must not contain control or invisible characters`);
+    }
+    return value;
+};
+export const normalizeEnvironmentIds = (values) => [
+    ...new Set(values.map((value) => normalizeCommandEnvironmentOptions({ environment: value }).environment)),
+];
+export const configuredEnvironmentIds = (environments) => {
+    const ids = Object.keys(environments ?? {});
+    if (ids.length === 0) {
+        throw new UsageError("The Allure config has no environments (or no allurerc file was found). " +
+            "Declare `environments` in the config or pass environment ids with --env");
+    }
+    return ids;
+};
+export const buildGhWorkflowYaml = ({ environmentIds, testCommand = DEFAULT_TEST_COMMAND, config, }) => {
+    if (environmentIds.length === 0) {
+        throw new UsageError("At least one environment is required");
+    }
+    const testCommandLine = testCommand.map((token) => shellQuote(assertPrintable("The test command", token))).join(" ");
+    const configOption = config === undefined ? "" : ` --config=${shellQuote(assertPrintable("--config", config))}`;
+    const matrix = environmentIds.map((id) => JSON.stringify(id)).join(", ");
+    const results = `allure-results-${ENVIRONMENT}`;
+    return `# Generated by "allure gh-workflow". Paste it under "jobs:" and adjust the TODO steps.
+  test:
+    name: Test (${ENVIRONMENT})
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        environment: [${matrix}]
+    steps:
+      - uses: ${CHECKOUT_ACTION}
+      # TODO: set up your runtime and install dependencies
+      - name: Test
+        run: |
+          npx allure run${configOption} --environment=${ENVIRONMENT} --dump=${results} -- ${testCommandLine}
+      - name: Upload Allure results
+        if: ${NOT_CANCELLED}
+        uses: ${UPLOAD_ARTIFACT_ACTION}
+        with:
+          name: ${results}
+          path: ./${results}.zip
+
+  report:
+    name: Report
+    needs: [test]
+    if: ${NOT_CANCELLED}
+    runs-on: ubuntu-latest
+    steps:
+      - uses: ${CHECKOUT_ACTION}
+      # TODO: set up your runtime and install dependencies
+      - name: Download Allure results
+        uses: ${DOWNLOAD_ARTIFACT_ACTION}
+        with:
+          pattern: allure-results-*
+          path: ./
+      - name: Generate report
+        run: |
+          npx allure generate${configOption} --dump="allure-results-*/*.zip" --output=./allure-report
+`;
+};

package/dist/utils/serverOptions.d.ts

@@ -0,0 +1,5 @@
+import type { FullConfig } from "@allurereport/core";
+export declare const serverOptionsFromConfig: (config: Pick<FullConfig, "port" | "host">) => {
+    port: number | undefined;
+    host: string | undefined;
+};

package/dist/utils/serverOptions.js

@@ -0,0 +1,4 @@
+export const serverOptionsFromConfig = (config) => ({
+    port: config.port ? parseInt(config.port, 10) : undefined,
+    host: config.host,
+});

package/dist/utils/updateNotifier.d.ts

@@ -0,0 +1,6 @@
+export declare const isNewerVersion: (candidate: unknown, current: unknown) => boolean;
+export declare const parseUpdateNotifierArgs: (args: string[]) => {
+    args: string[];
+    disabled: boolean;
+};
+export declare const notifyAboutUpdate: (args: string[], disabled?: boolean) => Promise<void>;

package/dist/utils/updateNotifier.js

@@ -0,0 +1,58 @@
+import { readFileSync } from "node:fs";
+import process from "node:process";
+const parseVersion = (version) => {
+    const match = typeof version === "string" && /^(\d+)\.(\d+)\.(\d+)(?:-([a-z][a-z-]*)\.(\d+))?(?:\+[\w.-]+)?$/.exec(version);
+    if (!match)
+        return undefined;
+    const numbers = [Number(match[1]), Number(match[2]), Number(match[3]), ...(match[5] ? [Number(match[5])] : [])];
+    if (!numbers.every(Number.isSafeInteger))
+        return undefined;
+    return { numbers: [...numbers.slice(0, 3), match[5] ? numbers[3] : Infinity], distTag: match[4] ?? "latest" };
+};
+export const isNewerVersion = (candidate, current) => {
+    const remote = parseVersion(candidate);
+    const local = parseVersion(current);
+    if (!remote || !local || (remote.distTag !== "latest" && remote.distTag !== local.distTag))
+        return false;
+    const index = remote.numbers.findIndex((value, position) => value !== local.numbers[position]);
+    return index !== -1 && remote.numbers[index] > local.numbers[index];
+};
+export const parseUpdateNotifierArgs = (args) => {
+    const separatorIndex = args.indexOf("--");
+    const cliArgs = separatorIndex === -1 ? args : args.slice(0, separatorIndex);
+    return {
+        args: [...cliArgs.filter((arg) => arg !== "--no-update-notifier"), ...args.slice(cliArgs.length)],
+        disabled: cliArgs.includes("--no-update-notifier"),
+    };
+};
+export const notifyAboutUpdate = async (args, disabled = false) => {
+    const env = process.env;
+    const separatorIndex = args.indexOf("--");
+    const cliArgs = separatorIndex === -1 ? args : args.slice(0, separatorIndex);
+    if (disabled ||
+        !process.stderr.isTTY ||
+        !cliArgs.length ||
+        cliArgs[0] === "agent" ||
+        cliArgs.some((arg) => ["--help", "-h", "--version", "-v"].includes(arg)) ||
+        env.NO_UPDATE_NOTIFIER !== undefined ||
+        env.NODE_ENV === "test" ||
+        (env.CI !== undefined && env.CI !== "false" && env.CI !== "0") ||
+        env.npm_config_user_agent !== undefined ||
+        env.npm_execpath !== undefined)
+        return;
+    try {
+        const pkg = JSON.parse(readFileSync(new URL("../../package.json", import.meta.url), "utf8"));
+        const current = parseVersion(pkg.version);
+        if (!current || typeof pkg.name !== "string")
+            return;
+        const response = await fetch(`https://registry.npmjs.org/${encodeURIComponent(pkg.name)}/${encodeURIComponent(current.distTag)}`, { signal: AbortSignal.timeout(1000) });
+        if (!response.ok)
+            return;
+        const data = (await response.json());
+        if (isNewerVersion(data?.version, pkg.version)) {
+            process.stderr.write(`\nUpdate available ${pkg.version} → ${data.version}\nUpdate Allure using your package manager (${pkg.name}@${current.distTag}).\n\n`);
+        }
+    }
+    catch {
+    }
+};

package/dist/utils/verbosity.d.ts

@@ -0,0 +1,7 @@
+export type Verbosity = "verbose" | "quiet" | "normal";
+export declare const isQuiet: () => boolean;
+export declare const extractVerbosityFlags: (args: string[]) => {
+    args: string[];
+    verbosity: Verbosity;
+};
+export declare const applyVerbosity: (verbosity: Verbosity) => void;

package/dist/utils/verbosity.js

@@ -0,0 +1,32 @@
+import { setGlobalLogLevel } from "@allurereport/cli-commons";
+import { UsageError } from "clipanion";
+const LOG_LEVELS = {
+    verbose: "verbose",
+    quiet: "error",
+    normal: undefined,
+};
+const isVerboseFlag = (arg) => arg === "--verbose" || arg === "-v";
+const isQuietFlag = (arg) => arg === "--quiet" || arg === "-q";
+let currentVerbosity = "normal";
+export const isQuiet = () => currentVerbosity === "quiet";
+export const extractVerbosityFlags = (args) => {
+    if (args.length === 1 && args[0] === "-v") {
+        return { args, verbosity: "normal" };
+    }
+    const separator = args.indexOf("--");
+    const own = separator === -1 ? args : args.slice(0, separator);
+    const nested = separator === -1 ? [] : args.slice(separator);
+    const verbose = own.some(isVerboseFlag);
+    const quiet = own.some(isQuietFlag);
+    if (verbose && quiet) {
+        throw new UsageError("--verbose and --quiet cannot be used together");
+    }
+    return {
+        args: [...own.filter((arg) => !isVerboseFlag(arg) && !isQuietFlag(arg)), ...nested],
+        verbosity: verbose ? "verbose" : quiet ? "quiet" : "normal",
+    };
+};
+export const applyVerbosity = (verbosity) => {
+    currentVerbosity = verbosity;
+    setGlobalLogLevel(LOG_LEVELS[verbosity]);
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "allure",
-  "version": "3.20.1",
+  "version": "3.22.0",
   "description": "Allure Commandline Tool",
   "keywords": [
     "allure",
@@ -27,33 +27,36 @@
     "build": "run clean && tsc --project ./tsconfig.json",
     "clean": "rimraf ./dist",
     "start": "node ./cli.js",
-    "test": "vitest run",
-    "lint": "oxlint --import-plugin src test features stories",
-    "lint:fix": "oxlint --import-plugin --fix src test features stories"
+    "test": "rimraf out && vp test run",
+    "test:unit": "yarn test",
+    "lint": "vp lint --import-plugin src test features stories",
+    "lint:fix": "vp lint --import-plugin --fix src test features stories"
   },
   "dependencies": {
-    "@allurereport/charts-api": "3.20.1",
-    "@allurereport/ci": "3.20.1",
-    "@allurereport/cli-commons": "3.20.1",
-    "@allurereport/core": "3.20.1",
-    "@allurereport/core-api": "3.20.1",
-    "@allurereport/directory-watcher": "3.20.1",
-    "@allurereport/plugin-agent": "3.20.1",
-    "@allurereport/plugin-allure2": "3.20.1",
-    "@allurereport/plugin-api": "3.20.1",
-    "@allurereport/plugin-awesome": "3.20.1",
-    "@allurereport/plugin-classic": "3.20.1",
-    "@allurereport/plugin-csv": "3.20.1",
-    "@allurereport/plugin-dashboard": "3.20.1",
-    "@allurereport/plugin-jira": "3.20.1",
-    "@allurereport/plugin-log": "3.20.1",
-    "@allurereport/plugin-progress": "3.20.1",
-    "@allurereport/plugin-server-reload": "3.20.1",
-    "@allurereport/plugin-slack": "3.20.1",
-    "@allurereport/reader-api": "3.20.1",
-    "@allurereport/service": "3.20.1",
-    "@allurereport/static-server": "3.20.1",
-    "adm-zip": "^0.6.0",
+    "@allurereport/charts-api": "3.22.0",
+    "@allurereport/ci": "3.22.0",
+    "@allurereport/cli-commons": "3.22.0",
+    "@allurereport/core": "3.22.0",
+    "@allurereport/core-api": "3.22.0",
+    "@allurereport/directory-watcher": "3.22.0",
+    "@allurereport/plugin-agent": "3.22.0",
+    "@allurereport/plugin-allure2": "3.22.0",
+    "@allurereport/plugin-api": "3.22.0",
+    "@allurereport/plugin-awesome": "3.22.0",
+    "@allurereport/plugin-classic": "3.22.0",
+    "@allurereport/plugin-csv": "3.22.0",
+    "@allurereport/plugin-dashboard": "3.22.0",
+    "@allurereport/plugin-jira": "3.22.0",
+    "@allurereport/plugin-log": "3.22.0",
+    "@allurereport/plugin-metrics": "3.22.0",
+    "@allurereport/plugin-progress": "3.22.0",
+    "@allurereport/plugin-server-reload": "3.22.0",
+    "@allurereport/plugin-slack": "3.22.0",
+    "@allurereport/plugin-xray": "3.22.0",
+    "@allurereport/reader-api": "3.22.0",
+    "@allurereport/service": "3.22.0",
+    "@allurereport/static-server": "3.22.0",
+    "adm-zip": "0.6.1",
     "clipanion": "^4.0.0-rc.4",
     "glob": "^13.0.6",
     "lodash.omit": "^4.18.0",
@@ -62,16 +65,20 @@
     "yoctocolors": "^2.2.0"
   },
   "devDependencies": {
+    "@allurereport/common-config": "3.22.0",
     "@types/adm-zip": "^0",
     "@types/lodash.omit": "^4.5.9",
     "@types/node": "^20",
     "@types/prompts": "^2",
+    "@vitest/coverage-istanbul": "5.0.4",
     "@vitest/runner": "^2",
-    "@vitest/snapshot": "^5.0.1",
+    "@vitest/snapshot": "5.0.4",
     "allure-js-commons": "^3",
     "allure-vitest": "^3",
     "rimraf": "^6",
     "typescript": "^5",
-    "vitest": "^4.1.0"
+    "vite": "@voidzero-dev/vite-plus-core@1.2.0",
+    "vite-plus": "1.2.0",
+    "vitest": "5.0.4"
   }
 }