@aspruyt/xfg 2.0.2 → 2.1.0

package/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2026 Anthony
+Copyright (c) 2026 Anthony Spruyt
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

package/PR.md

@@ -1,3 +1,5 @@
+<!-- markdownlint-disable MD041 -->
+
 ## Summary
 
 Automated sync of configuration files to ${xfg:repo.fullName}.

package/dist/git-ops.js

@@ -283,7 +283,7 @@ export function validateBranchName(branchName) {
         throw new Error('Branch name cannot start with "." or "-"');
     }
     // Git disallows: space, ~, ^, :, ?, *, [, \, and consecutive dots (..)
-    if (/[\s~^:?*\[\\]/.test(branchName) || branchName.includes("..")) {
+    if (/[\s~^:?*[\\]/.test(branchName) || branchName.includes("..")) {
         throw new Error("Branch name contains invalid characters");
     }
     if (branchName.endsWith("/") ||

package/dist/github-summary.d.ts

@@ -0,0 +1,25 @@
+export type MergeOutcome = "manual" | "auto" | "force" | "direct";
+export interface FileChanges {
+    added: number;
+    modified: number;
+    deleted: number;
+    unchanged: number;
+}
+export interface RepoResult {
+    repoName: string;
+    status: "succeeded" | "skipped" | "failed";
+    message: string;
+    prUrl?: string;
+    mergeOutcome?: MergeOutcome;
+    fileChanges?: FileChanges;
+}
+export interface SummaryData {
+    total: number;
+    succeeded: number;
+    skipped: number;
+    failed: number;
+    results: RepoResult[];
+}
+export declare function formatSummary(data: SummaryData): string;
+export declare function isGitHubActions(): boolean;
+export declare function writeSummary(data: SummaryData): void;

package/dist/github-summary.js

@@ -0,0 +1,83 @@
+import { appendFileSync } from "node:fs";
+function escapeMarkdown(text) {
+    // Escape backslashes first, then pipes (order matters to prevent double-escaping)
+    return text.replace(/\\/g, "\\\\").replace(/\|/g, "\\|");
+}
+function formatFileChanges(changes) {
+    if (!changes)
+        return "-";
+    return `+${changes.added} ~${changes.modified} -${changes.deleted}`;
+}
+function formatStatus(result) {
+    if (result.status === "skipped")
+        return "⏭️ Skipped";
+    if (result.status === "failed")
+        return "❌ Failed";
+    // Succeeded - format based on merge outcome
+    switch (result.mergeOutcome) {
+        case "manual":
+            return "✅ Open";
+        case "auto":
+            return "✅ Auto-merge";
+        case "force":
+            return "✅ Merged";
+        case "direct":
+            return "✅ Pushed";
+        default:
+            return "✅ Succeeded";
+    }
+}
+function formatResult(result) {
+    if (result.prUrl) {
+        // Extract PR number from URL
+        const prMatch = result.prUrl.match(/\/pull\/(\d+)/);
+        const prNum = prMatch ? prMatch[1] : "PR";
+        return `[PR #${prNum}](${result.prUrl})`;
+    }
+    if (result.mergeOutcome === "direct") {
+        return "Direct to main";
+    }
+    return escapeMarkdown(result.message);
+}
+export function formatSummary(data) {
+    const lines = [];
+    // Header
+    lines.push("## Config Sync Summary");
+    lines.push("");
+    // Stats table
+    lines.push("| Status | Count |");
+    lines.push("|--------|-------|");
+    lines.push(`| ✅ Succeeded | ${data.succeeded} |`);
+    lines.push(`| ⏭️ Skipped | ${data.skipped} |`);
+    lines.push(`| ❌ Failed | ${data.failed} |`);
+    lines.push(`| **Total** | **${data.total}** |`);
+    // Repo details table (only if there are results)
+    if (data.results.length > 0) {
+        lines.push("");
+        lines.push("<details>");
+        lines.push("<summary>Repository Details</summary>");
+        lines.push("");
+        lines.push("| Repository | Status | Changes | Result |");
+        lines.push("|------------|--------|---------|--------|");
+        for (const result of data.results) {
+            const repo = result.repoName;
+            const status = formatStatus(result);
+            const changes = formatFileChanges(result.fileChanges);
+            const resultText = formatResult(result);
+            lines.push(`| ${repo} | ${status} | ${changes} | ${resultText} |`);
+        }
+        lines.push("");
+        lines.push("</details>");
+    }
+    return lines.join("\n");
+}
+export function isGitHubActions() {
+    return !!process.env.GITHUB_STEP_SUMMARY;
+}
+export function writeSummary(data) {
+    const summaryPath = process.env.GITHUB_STEP_SUMMARY;
+    if (!summaryPath)
+        return;
+    const markdown = formatSummary(data);
+    appendFileSync(summaryPath, markdown + "\n");
+}

package/dist/index.js

@@ -13,6 +13,8 @@ import { sanitizeBranchName, validateBranchName } from "./git-ops.js";
 import { logger } from "./logger.js";
 import { generateWorkspaceName } from "./workspace-utils.js";
 import { RepositoryProcessor, } from "./repository-processor.js";
+import { writeSummary } from "./github-summary.js";
+import { buildRepoResult, buildErrorResult } from "./summary-utils.js";
 /**
  * Default factory that creates a real RepositoryProcessor.
  */
@@ -102,6 +104,7 @@ async function main() {
     console.log(`Target files: ${formatFileNames(fileNames)}`);
     console.log(`Branch: ${branchName}\n`);
     const processor = defaultProcessorFactory();
+    const results = [];
     for (let i = 0; i < config.repos.length; i++) {
         const repoConfig = config.repos[i];
         // Apply CLI merge overrides to repo config
@@ -121,8 +124,8 @@ async function main() {
             });
         }
         catch (error) {
-            const message = error instanceof Error ? error.message : String(error);
-            logger.error(current, repoConfig.git, message);
+            logger.error(current, repoConfig.git, String(error));
+            results.push(buildErrorResult(repoConfig.git, error));
             continue;
         }
         const repoName = getRepoDisplayName(repoInfo);
@@ -138,31 +141,35 @@ async function main() {
                 prTemplate: config.prTemplate,
                 noDelete: options.noDelete,
             });
+            const repoResult = buildRepoResult(repoName, repoConfig, result);
+            results.push(repoResult);
             if (result.skipped) {
                 logger.skip(current, repoName, result.message);
             }
             else if (result.success) {
-                let message = result.prUrl ? `PR: ${result.prUrl}` : result.message;
-                if (result.mergeResult) {
-                    if (result.mergeResult.merged) {
-                        message += " (merged)";
-                    }
-                    else if (result.mergeResult.autoMergeEnabled) {
-                        message += " (auto-merge enabled)";
-                    }
-                }
-                logger.success(current, repoName, message);
+                logger.success(current, repoName, repoResult.message);
             }
             else {
                 logger.error(current, repoName, result.message);
             }
         }
         catch (error) {
-            const message = error instanceof Error ? error.message : String(error);
-            logger.error(current, repoName, message);
+            logger.error(current, repoName, String(error));
+            results.push(buildErrorResult(repoName, error));
         }
     }
     logger.summary();
+    // Write GitHub Actions job summary if running in GitHub Actions
+    const succeeded = results.filter((r) => r.status === "succeeded").length;
+    const skipped = results.filter((r) => r.status === "skipped").length;
+    const failed = results.filter((r) => r.status === "failed").length;
+    writeSummary({
+        total: config.repos.length,
+        succeeded,
+        skipped,
+        failed,
+        results,
+    });
     if (logger.hasFailures()) {
         process.exit(1);
     }

package/dist/logger.js

@@ -29,8 +29,7 @@ export class Logger {
     }
     error(current, repoName, error) {
         this.stats.failed++;
-        console.log(chalk.red(`[${current}/${this.stats.total}] ✗`) +
-            ` ${repoName}: ${error}`);
+        console.log(chalk.red(`[${current}/${this.stats.total}] ✗`) + ` ${repoName}: ${error}`);
     }
     /**
      * Display a file diff with status badge.

package/dist/repository-processor.d.ts

@@ -3,6 +3,7 @@ import { RepoInfo } from "./repo-detector.js";
 import { GitOps, GitOpsOptions } from "./git-ops.js";
 import { ILogger } from "./logger.js";
 import { CommandExecutor } from "./command-executor.js";
+import { DiffStats } from "./diff-utils.js";
 export interface ProcessorOptions {
     branchName: string;
     workDir: string;
@@ -34,6 +35,7 @@ export interface ProcessorResult {
         autoMergeEnabled?: boolean;
         message: string;
     };
+    diffStats?: DiffStats;
 }
 export declare class RepositoryProcessor {
     private gitOps;

package/dist/repository-processor.js

@@ -268,6 +268,7 @@ export class RepositoryProcessor {
                     repoName,
                     message: "No changes detected",
                     skipped: true,
+                    diffStats,
                 };
             }
             // Step 7: Commit
@@ -281,6 +282,7 @@ export class RepositoryProcessor {
                     repoName,
                     message: "No changes detected after staging",
                     skipped: true,
+                    diffStats,
                 };
             }
             this.log.info(`Committed: ${commitMessage}`);
@@ -316,6 +318,7 @@ export class RepositoryProcessor {
                     success: true,
                     repoName,
                     message: `Pushed directly to ${baseBranch}`,
+                    diffStats,
                 };
             }
             // Step 9: Create PR (non-direct modes only)
@@ -368,6 +371,7 @@ export class RepositoryProcessor {
                 message: prResult.message,
                 prUrl: prResult.url,
                 mergeResult,
+                diffStats,
             };
         }
         finally {

package/dist/summary-utils.d.ts

@@ -0,0 +1,20 @@
+import { ProcessorResult } from "./repository-processor.js";
+import { RepoConfig } from "./config.js";
+import { MergeOutcome, FileChanges, RepoResult } from "./github-summary.js";
+import { DiffStats } from "./diff-utils.js";
+/**
+ * Determine merge outcome from repo config and processor result
+ */
+export declare function getMergeOutcome(repoConfig: RepoConfig, result: ProcessorResult): MergeOutcome | undefined;
+/**
+ * Convert DiffStats to FileChanges for summary output
+ */
+export declare function toFileChanges(diffStats?: DiffStats): FileChanges | undefined;
+/**
+ * Build a RepoResult from a ProcessorResult for the summary
+ */
+export declare function buildRepoResult(repoName: string, repoConfig: RepoConfig, result: ProcessorResult): RepoResult;
+/**
+ * Build a RepoResult for an error case
+ */
+export declare function buildErrorResult(repoName: string, error: unknown): RepoResult;

package/dist/summary-utils.js

@@ -0,0 +1,78 @@
+/**
+ * Determine merge outcome from repo config and processor result
+ */
+export function getMergeOutcome(repoConfig, result) {
+    if (!result.success || result.skipped)
+        return undefined;
+    const mergeMode = repoConfig.prOptions?.merge ?? "auto";
+    if (mergeMode === "direct")
+        return "direct";
+    if (result.mergeResult?.merged)
+        return "force";
+    if (result.mergeResult?.autoMergeEnabled)
+        return "auto";
+    if (result.prUrl)
+        return "manual";
+    return undefined;
+}
+/**
+ * Convert DiffStats to FileChanges for summary output
+ */
+export function toFileChanges(diffStats) {
+    if (!diffStats)
+        return undefined;
+    return {
+        added: diffStats.newCount,
+        modified: diffStats.modifiedCount,
+        deleted: diffStats.deletedCount,
+        unchanged: diffStats.unchangedCount,
+    };
+}
+/**
+ * Build a RepoResult from a ProcessorResult for the summary
+ */
+export function buildRepoResult(repoName, repoConfig, result) {
+    if (result.skipped) {
+        return {
+            repoName,
+            status: "skipped",
+            message: result.message,
+            fileChanges: toFileChanges(result.diffStats),
+        };
+    }
+    if (result.success) {
+        let message = result.prUrl ? `PR: ${result.prUrl}` : result.message;
+        if (result.mergeResult) {
+            if (result.mergeResult.merged) {
+                message += " (merged)";
+            }
+            else if (result.mergeResult.autoMergeEnabled) {
+                message += " (auto-merge enabled)";
+            }
+        }
+        return {
+            repoName,
+            status: "succeeded",
+            message,
+            prUrl: result.prUrl,
+            mergeOutcome: getMergeOutcome(repoConfig, result),
+            fileChanges: toFileChanges(result.diffStats),
+        };
+    }
+    return {
+        repoName,
+        status: "failed",
+        message: result.message,
+    };
+}
+/**
+ * Build a RepoResult for an error case
+ */
+export function buildErrorResult(repoName, error) {
+    const message = error instanceof Error ? error.message : String(error);
+    return {
+        repoName,
+        status: "failed",
+        message,
+    };
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@aspruyt/xfg",
-  "version": "2.0.2",
+  "version": "2.1.0",
   "description": "CLI tool to sync JSON, JSON5, YAML, or text configuration files across multiple Git repositories via pull requests or direct push",
   "type": "module",
   "main": "dist/index.js",