@allurereport/git 3.13.0

package/dist/collectGitFacts.d.ts

@@ -0,0 +1,7 @@
+import type { GitFacts } from "@allurereport/core-api";
+export declare const DEFAULT_ANCESTOR_LIMIT = 100;
+export type CollectGitFactsOptions = {
+    cwd?: string;
+    ancestorLimit?: number;
+};
+export declare const collectGitFacts: (options?: CollectGitFactsOptions) => GitFacts | undefined;

package/dist/collectGitFacts.js

@@ -0,0 +1,57 @@
+import { runGit } from "./runGit.js";
+export const DEFAULT_ANCESTOR_LIMIT = 100;
+const stripRemotePrefix = (upstreamRef) => {
+    const slashIndex = upstreamRef.indexOf("/");
+    return slashIndex >= 0 ? upstreamRef.slice(slashIndex + 1) : upstreamRef;
+};
+const resolveBranch = (cwd) => {
+    const branchRaw = runGit(["rev-parse", "--abbrev-ref", "HEAD"], cwd);
+    if (!branchRaw || branchRaw === "HEAD") {
+        return undefined;
+    }
+    const upstreamBranch = runGit(["rev-parse", "--abbrev-ref", "@{u}"], cwd);
+    if (upstreamBranch) {
+        return stripRemotePrefix(upstreamBranch);
+    }
+    return branchRaw;
+};
+const collectLocalState = (cwd) => {
+    const statusPorcelain = runGit(["status", "--porcelain"], cwd) ?? "";
+    const branchRaw = runGit(["rev-parse", "--abbrev-ref", "HEAD"], cwd);
+    const detachedHead = branchRaw === "HEAD";
+    const headCommit = runGit(["rev-parse", "--verify", "HEAD"], cwd);
+    const upstreamCommit = runGit(["rev-parse", "--verify", "@{u}"], cwd);
+    const upstreamBranch = runGit(["rev-parse", "--abbrev-ref", "@{u}"], cwd);
+    return {
+        uncommittedChanges: statusPorcelain.length > 0,
+        unpublishedCommit: !upstreamCommit || headCommit !== upstreamCommit,
+        unpublishedBranch: !upstreamBranch,
+        detachedHead,
+    };
+};
+export const collectGitFacts = (options = {}) => {
+    const { cwd, ancestorLimit = DEFAULT_ANCESTOR_LIMIT } = options;
+    if (runGit(["rev-parse", "--is-inside-work-tree"], cwd) !== "true") {
+        return undefined;
+    }
+    const commit = runGit(["rev-parse", "HEAD"], cwd);
+    if (!commit) {
+        return undefined;
+    }
+    const branch = resolveBranch(cwd);
+    const revList = runGit(["rev-list", "--first-parent", commit, `--max-count=${ancestorLimit + 1}`], cwd);
+    if (!revList) {
+        return undefined;
+    }
+    const firstParentAncestors = revList
+        .split("\n")
+        .map((line) => line.trim())
+        .filter(Boolean)
+        .slice(1);
+    return {
+        commit,
+        branch,
+        firstParentAncestors,
+        localState: collectLocalState(cwd),
+    };
+};

package/dist/index.d.ts

@@ -0,0 +1,2 @@
+export { collectGitFacts, DEFAULT_ANCESTOR_LIMIT, type CollectGitFactsOptions } from "./collectGitFacts.js";
+export { isGitAvailable } from "./isGitAvailable.js";

package/dist/index.js

@@ -0,0 +1,2 @@
+export { collectGitFacts, DEFAULT_ANCESTOR_LIMIT } from "./collectGitFacts.js";
+export { isGitAvailable } from "./isGitAvailable.js";

package/dist/isGitAvailable.d.ts

@@ -0,0 +1 @@
+export declare const isGitAvailable: () => boolean;

package/dist/isGitAvailable.js

@@ -0,0 +1,5 @@
+import { spawnSync } from "node:child_process";
+export const isGitAvailable = () => {
+    const result = spawnSync("git", ["--version"], { encoding: "utf-8" });
+    return !result.error && result.status === 0;
+};

package/dist/runGit.d.ts

@@ -0,0 +1 @@
+export declare const runGit: (args: string[], cwd?: string) => string | undefined;

package/dist/runGit.js

@@ -0,0 +1,29 @@
+import { spawnSync } from "node:child_process";
+const isGitDebugEnabled = () => {
+    const value = process.env.ALLURE_DEBUG?.trim().toLowerCase();
+    return value === "1" || value === "true";
+};
+const hasUnsafeGitArgs = (args) => {
+    return args.some((arg) => arg === "--upload-pack" || arg.startsWith("--upload-pack="));
+};
+export const runGit = (args, cwd) => {
+    if (hasUnsafeGitArgs(args)) {
+        if (isGitDebugEnabled()) {
+            process.stderr.write(`[allurereport/git] blocked unsafe git arguments: ${args.join(" ")}\n`);
+        }
+        return undefined;
+    }
+    const result = spawnSync("git", args, {
+        cwd,
+        encoding: "utf-8",
+    });
+    if (result.error || result.status !== 0) {
+        if (isGitDebugEnabled()) {
+            const stderr = result.stderr?.trim();
+            const status = result.status ?? "n/a";
+            process.stderr.write(`[allurereport/git] git ${args.join(" ")} failed (status=${status})${stderr ? `: ${stderr}` : ""}\n`);
+        }
+        return undefined;
+    }
+    return result.stdout.trim();
+};

package/package.json

@@ -0,0 +1,43 @@
+{
+  "name": "@allurereport/git",
+  "version": "3.13.0",
+  "description": "Git metadata collection for Allure Git Flow",
+  "keywords": [
+    "allure",
+    "git",
+    "report",
+    "testing"
+  ],
+  "license": "Apache-2.0",
+  "author": "Qameta Software",
+  "repository": "https://github.com/allure-framework/allure3",
+  "files": [
+    "./dist"
+  ],
+  "type": "module",
+  "main": "./dist/index.js",
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": "./dist/index.js"
+  },
+  "scripts": {
+    "build": "run clean && tsc --project ./tsconfig.json",
+    "clean": "rimraf ./dist",
+    "test": "rimraf ./out && vitest run",
+    "lint": "oxlint --import-plugin src test",
+    "lint:fix": "oxlint --import-plugin --fix src test"
+  },
+  "dependencies": {
+    "@allurereport/core-api": "3.13.0"
+  },
+  "devDependencies": {
+    "@types/node": "^20",
+    "@vitest/runner": "^2",
+    "@vitest/snapshot": "^2",
+    "allure-vitest": "^3",
+    "rimraf": "^6",
+    "typescript": "^5",
+    "vitest": "^4"
+  }
+}