@aspruyt/xfg 3.9.1 → 3.9.3

package/dist/cli/settings-command.js

@@ -9,7 +9,8 @@ import { logger } from "../shared/logger.js";
 import { generateWorkspaceName } from "../shared/workspace-utils.js";
 import { buildErrorResult } from "../output/summary-utils.js";
 import { getManagedRulesets } from "../sync/manifest.js";
-import { formatSettingsReportCLI, writeSettingsReportSummary, } from "../output/settings-report.js";
+import { formatSettingsReportCLI } from "../output/settings-report.js";
+import { writeUnifiedSummary } from "../output/unified-summary.js";
 import { buildSettingsReport, } from "./settings-report-builder.js";
 import { defaultProcessorFactory, defaultRulesetProcessorFactory, defaultRepoSettingsProcessorFactory, } from "./types.js";
 import { RepoLifecycleManager, runLifecycleCheck, } from "../lifecycle/index.js";
@@ -318,7 +319,7 @@ export async function runSettings(options, processorFactory = defaultRulesetProc
     for (const line of lines) {
         console.log(line);
     }
-    writeSettingsReportSummary(report, options.dryRun ?? false);
+    writeUnifiedSummary({ settings: report, dryRun: options.dryRun ?? false });
     const hasErrors = report.repos.some((r) => r.error);
     if (hasErrors) {
         process.exit(1);

package/dist/cli/sync-command.js

@@ -246,7 +246,11 @@ export async function runSync(options, processorFactory = defaultProcessorFactor
         console.log(line);
     }
     // Write unified summary to GITHUB_STEP_SUMMARY
-    writeUnifiedSummary(lifecycleReport, report, options.dryRun ?? false);
+    writeUnifiedSummary({
+        lifecycle: lifecycleReport,
+        sync: report,
+        dryRun: options.dryRun ?? false,
+    });
     // Exit with error if any failures
     const hasErrors = reportResults.some((r) => r.error);
     if (hasErrors) {

package/dist/output/index.d.ts

@@ -1,4 +1,5 @@
 export { formatSyncReportCLI, formatSyncReportMarkdown, writeSyncReportSummary, type SyncReport, type RepoFileChanges, type FileChange, } from "./sync-report.js";
-export { formatSettingsReportCLI, formatSettingsReportMarkdown, writeSettingsReportSummary, type SettingsReport, type RepoChanges, type RulesetChange, type SettingChange, } from "./settings-report.js";
+export { formatSettingsReportCLI, formatSettingsReportMarkdown, writeSettingsReportSummary, formatValuePlain, formatRulesetConfigPlain, type SettingsReport, type RepoChanges, type RulesetChange, type SettingChange, } from "./settings-report.js";
+export { formatUnifiedSummaryMarkdown, writeUnifiedSummary, type UnifiedSummaryInput, } from "./unified-summary.js";
 export { formatSummary, isGitHubActions, writeSummary, type MergeOutcome, type FileChanges, type RulesetPlanDetail, type RepoSettingsPlanDetail, type RepoResult, type SummaryData, } from "./github-summary.js";
 export { getMergeOutcome, toFileChanges, buildRepoResult, buildErrorResult, } from "./summary-utils.js";

package/dist/output/index.js

@@ -1,7 +1,9 @@
 // Sync report (repo-grouped file changes)
 export { formatSyncReportCLI, formatSyncReportMarkdown, writeSyncReportSummary, } from "./sync-report.js";
 // Settings report (repo-grouped settings changes)
-export { formatSettingsReportCLI, formatSettingsReportMarkdown, writeSettingsReportSummary, } from "./settings-report.js";
+export { formatSettingsReportCLI, formatSettingsReportMarkdown, writeSettingsReportSummary, formatValuePlain, formatRulesetConfigPlain, } from "./settings-report.js";
+// Unified summary (lifecycle + sync + settings in one diff block)
+export { formatUnifiedSummaryMarkdown, writeUnifiedSummary, } from "./unified-summary.js";
 // GitHub Actions summary
 export { formatSummary, isGitHubActions, writeSummary, } from "./github-summary.js";
 // Summary utilities

package/dist/output/settings-report.d.ts

@@ -33,5 +33,7 @@ export interface RulesetChange {
     config?: Ruleset;
 }
 export declare function formatSettingsReportCLI(report: SettingsReport): string[];
+export declare function formatValuePlain(val: unknown): string;
+export declare function formatRulesetConfigPlain(config: Ruleset): string[];
 export declare function formatSettingsReportMarkdown(report: SettingsReport, dryRun: boolean): string;
 export declare function writeSettingsReportSummary(report: SettingsReport, dryRun: boolean): void;

package/dist/output/settings-report.js

@@ -153,7 +153,7 @@ export function formatSettingsReportCLI(report) {
 // =============================================================================
 // Markdown Formatter
 // =============================================================================
-function formatValuePlain(val) {
+export function formatValuePlain(val) {
     if (val === null)
         return "null";
     if (val === undefined)
@@ -164,7 +164,7 @@ function formatValuePlain(val) {
         return val ? "true" : "false";
     return String(val);
 }
-function formatRulesetConfigPlain(config) {
+export function formatRulesetConfigPlain(config) {
     const lines = [];
     function renderObject(obj, depth) {
         for (const [k, v] of Object.entries(obj)) {
@@ -216,8 +216,8 @@ function formatRulesetConfigPlain(config) {
 export function formatSettingsReportMarkdown(report, dryRun) {
     const lines = [];
     // Title
-    const titleSuffix = dryRun ? " (Dry Run)" : "";
-    lines.push(`## Repository Settings Summary${titleSuffix}`);
+    const title = dryRun ? "## xfg Plan" : "## xfg Apply";
+    lines.push(title);
     lines.push("");
     // Dry-run warning
     if (dryRun) {

package/dist/output/sync-report.js

@@ -49,8 +49,8 @@ export function formatSyncReportCLI(report) {
 export function formatSyncReportMarkdown(report, dryRun) {
     const lines = [];
     // Title
-    const titleSuffix = dryRun ? " (Dry Run)" : "";
-    lines.push(`## Config Sync Summary${titleSuffix}`);
+    const title = dryRun ? "## xfg Plan" : "## xfg Apply";
+    lines.push(title);
     lines.push("");
     // Dry-run warning
     if (dryRun) {

package/dist/output/unified-summary.d.ts

@@ -1,4 +1,11 @@
 import type { LifecycleReport } from "./lifecycle-report.js";
 import type { SyncReport } from "./sync-report.js";
-export declare function formatUnifiedSummaryMarkdown(lifecycle: LifecycleReport, sync: SyncReport, dryRun: boolean): string;
-export declare function writeUnifiedSummary(lifecycle: LifecycleReport, sync: SyncReport, dryRun: boolean): void;
+import type { SettingsReport } from "./settings-report.js";
+export interface UnifiedSummaryInput {
+    lifecycle?: LifecycleReport;
+    sync?: SyncReport;
+    settings?: SettingsReport;
+    dryRun: boolean;
+}
+export declare function formatUnifiedSummaryMarkdown(input: UnifiedSummaryInput): string;
+export declare function writeUnifiedSummary(input: UnifiedSummaryInput): void;

package/dist/output/unified-summary.js

@@ -1,127 +1,227 @@
 // src/output/unified-summary.ts
 import { appendFileSync } from "node:fs";
 import { hasLifecycleChanges } from "./lifecycle-report.js";
+import { formatValuePlain, formatRulesetConfigPlain, } from "./settings-report.js";
 // =============================================================================
 // Helpers
 // =============================================================================
-function formatCombinedSummary(lifecycleTotals, syncTotals) {
+function formatCombinedSummary(input) {
     const parts = [];
+    const dry = input.dryRun;
     // Lifecycle totals
-    const repoTotal = lifecycleTotals.created + lifecycleTotals.forked + lifecycleTotals.migrated;
-    if (repoTotal > 0) {
-        const repoParts = [];
-        if (lifecycleTotals.created > 0)
-            repoParts.push(`${lifecycleTotals.created} to create`);
-        if (lifecycleTotals.forked > 0)
-            repoParts.push(`${lifecycleTotals.forked} to fork`);
-        if (lifecycleTotals.migrated > 0)
-            repoParts.push(`${lifecycleTotals.migrated} to migrate`);
-        const repoWord = repoTotal === 1 ? "repo" : "repos";
-        parts.push(`${repoTotal} ${repoWord} (${repoParts.join(", ")})`);
+    if (input.lifecycle) {
+        const t = input.lifecycle.totals;
+        const repoTotal = t.created + t.forked + t.migrated;
+        if (repoTotal > 0) {
+            const repoParts = [];
+            if (t.created > 0)
+                repoParts.push(`${t.created} ${dry ? "to create" : "created"}`);
+            if (t.forked > 0)
+                repoParts.push(`${t.forked} ${dry ? "to fork" : "forked"}`);
+            if (t.migrated > 0)
+                repoParts.push(`${t.migrated} ${dry ? "to migrate" : "migrated"}`);
+            const repoWord = repoTotal === 1 ? "repo" : "repos";
+            parts.push(`${repoTotal} ${repoWord} (${repoParts.join(", ")})`);
+        }
     }
     // Sync totals
-    const fileTotal = syncTotals.files.create + syncTotals.files.update + syncTotals.files.delete;
-    if (fileTotal > 0) {
-        const fileParts = [];
-        if (syncTotals.files.create > 0)
-            fileParts.push(`${syncTotals.files.create} to create`);
-        if (syncTotals.files.update > 0)
-            fileParts.push(`${syncTotals.files.update} to update`);
-        if (syncTotals.files.delete > 0)
-            fileParts.push(`${syncTotals.files.delete} to delete`);
-        const fileWord = fileTotal === 1 ? "file" : "files";
-        parts.push(`${fileTotal} ${fileWord} (${fileParts.join(", ")})`);
+    if (input.sync) {
+        const t = input.sync.totals;
+        const fileTotal = t.files.create + t.files.update + t.files.delete;
+        if (fileTotal > 0) {
+            const fileParts = [];
+            if (t.files.create > 0)
+                fileParts.push(`${t.files.create} ${dry ? "to create" : "created"}`);
+            if (t.files.update > 0)
+                fileParts.push(`${t.files.update} ${dry ? "to update" : "updated"}`);
+            if (t.files.delete > 0)
+                fileParts.push(`${t.files.delete} ${dry ? "to delete" : "deleted"}`);
+            const fileWord = fileTotal === 1 ? "file" : "files";
+            parts.push(`${fileTotal} ${fileWord} (${fileParts.join(", ")})`);
+        }
+    }
+    // Settings totals
+    if (input.settings) {
+        const t = input.settings.totals;
+        const settingsTotal = t.settings.add + t.settings.change;
+        if (settingsTotal > 0) {
+            const settingWord = settingsTotal === 1 ? "setting" : "settings";
+            const actions = [];
+            if (t.settings.add > 0)
+                actions.push(`${t.settings.add} ${dry ? "to add" : "added"}`);
+            if (t.settings.change > 0)
+                actions.push(`${t.settings.change} ${dry ? "to change" : "changed"}`);
+            parts.push(`${settingsTotal} ${settingWord} (${actions.join(", ")})`);
+        }
+        const rulesetsTotal = t.rulesets.create + t.rulesets.update + t.rulesets.delete;
+        if (rulesetsTotal > 0) {
+            const rulesetWord = rulesetsTotal === 1 ? "ruleset" : "rulesets";
+            const actions = [];
+            if (t.rulesets.create > 0)
+                actions.push(`${t.rulesets.create} ${dry ? "to create" : "created"}`);
+            if (t.rulesets.update > 0)
+                actions.push(`${t.rulesets.update} ${dry ? "to update" : "updated"}`);
+            if (t.rulesets.delete > 0)
+                actions.push(`${t.rulesets.delete} ${dry ? "to delete" : "deleted"}`);
+            parts.push(`${rulesetsTotal} ${rulesetWord} (${actions.join(", ")})`);
+        }
     }
     if (parts.length === 0) {
         return "No changes";
     }
-    return `Plan: ${parts.join(", ")}`;
+    const prefix = dry ? "Plan" : "Applied";
+    return `${prefix}: ${parts.join(", ")}`;
+}
+function hasAnyChanges(input) {
+    if (input.lifecycle && hasLifecycleChanges(input.lifecycle))
+        return true;
+    if (input.sync?.repos.some((r) => r.files.length > 0 || r.error))
+        return true;
+    if (input.settings?.repos.some((r) => r.settings.length > 0 || r.rulesets.length > 0 || r.error))
+        return true;
+    return false;
+}
+// =============================================================================
+// Diff line builders
+// =============================================================================
+function renderLifecycleLines(lcAction, diffLines) {
+    if (lcAction.action === "existed")
+        return;
+    switch (lcAction.action) {
+        case "created":
+            diffLines.push(`+ CREATE`);
+            break;
+        case "forked":
+            diffLines.push(`+ FORK ${lcAction.upstream ?? "upstream"} -> ${lcAction.repoName}`);
+            break;
+        case "migrated":
+            diffLines.push(`+ MIGRATE ${lcAction.source ?? "source"} -> ${lcAction.repoName}`);
+            break;
+    }
+    if (lcAction.settings) {
+        if (lcAction.settings.visibility) {
+            diffLines.push(`+   visibility: ${lcAction.settings.visibility}`);
+        }
+        if (lcAction.settings.description) {
+            diffLines.push(`+   description: "${lcAction.settings.description}"`);
+        }
+    }
+}
+function renderSyncLines(syncRepo, diffLines) {
+    for (const file of syncRepo.files) {
+        if (file.action === "create") {
+            diffLines.push(`+ ${file.path}`);
+        }
+        else if (file.action === "update") {
+            diffLines.push(`! ${file.path}`);
+        }
+        else if (file.action === "delete") {
+            diffLines.push(`- ${file.path}`);
+        }
+    }
+    if (syncRepo.error) {
+        diffLines.push(`- Error: ${syncRepo.error}`);
+    }
+}
+function renderSettingsLines(settingsRepo, diffLines) {
+    for (const setting of settingsRepo.settings) {
+        if (setting.oldValue === undefined && setting.newValue === undefined) {
+            continue;
+        }
+        if (setting.action === "add") {
+            diffLines.push(`+ ${setting.name}: ${formatValuePlain(setting.newValue)}`);
+        }
+        else {
+            diffLines.push(`! ${setting.name}: ${formatValuePlain(setting.oldValue)} → ${formatValuePlain(setting.newValue)}`);
+        }
+    }
+    for (const ruleset of settingsRepo.rulesets) {
+        if (ruleset.action === "create") {
+            diffLines.push(`+ ruleset "${ruleset.name}"`);
+            if (ruleset.config) {
+                diffLines.push(...formatRulesetConfigPlain(ruleset.config));
+            }
+        }
+        else if (ruleset.action === "update") {
+            diffLines.push(`! ruleset "${ruleset.name}"`);
+            if (ruleset.propertyDiffs && ruleset.propertyDiffs.length > 0) {
+                for (const diff of ruleset.propertyDiffs) {
+                    const path = diff.path.join(".");
+                    if (diff.action === "add") {
+                        diffLines.push(`+   ${path}: ${formatValuePlain(diff.newValue)}`);
+                    }
+                    else if (diff.action === "change") {
+                        diffLines.push(`!   ${path}: ${formatValuePlain(diff.oldValue)} → ${formatValuePlain(diff.newValue)}`);
+                    }
+                    else if (diff.action === "remove") {
+                        diffLines.push(`-   ${path}`);
+                    }
+                }
+            }
+        }
+        else if (ruleset.action === "delete") {
+            diffLines.push(`- ruleset "${ruleset.name}"`);
+        }
+    }
+    if (settingsRepo.error) {
+        diffLines.push(`- Error: ${settingsRepo.error}`);
+    }
 }
 // =============================================================================
 // Markdown Formatter
 // =============================================================================
-export function formatUnifiedSummaryMarkdown(lifecycle, sync, dryRun) {
-    const hasLifecycle = hasLifecycleChanges(lifecycle);
-    const hasSync = sync.repos.some((r) => r.files.length > 0 || r.error);
-    if (!hasLifecycle && !hasSync) {
+export function formatUnifiedSummaryMarkdown(input) {
+    if (!hasAnyChanges(input)) {
         return "";
     }
     const lines = [];
-    // Title
-    const titleSuffix = dryRun ? " (Dry Run)" : "";
-    lines.push(`## xfg Sync Summary${titleSuffix}`);
+    // Title: "xfg Plan" for dry-run, "xfg Apply" otherwise
+    const title = input.dryRun ? "## xfg Plan" : "## xfg Apply";
+    lines.push(title);
     lines.push("");
     // Dry-run warning
-    if (dryRun) {
+    if (input.dryRun) {
         lines.push("> [!WARNING]");
         lines.push("> This was a dry run — no changes were applied");
         lines.push("");
     }
-    // Build lookup maps by repoName
-    const lifecycleByRepo = new Map(lifecycle.actions.map((a) => [a.repoName, a]));
-    const syncByRepo = new Map(sync.repos.map((r) => [r.repoName, r]));
-    // Collect all repo names in order (lifecycle first, then sync-only)
+    // Build lookup maps
+    const lifecycleByRepo = new Map((input.lifecycle?.actions ?? []).map((a) => [a.repoName, a]));
+    const syncByRepo = new Map((input.sync?.repos ?? []).map((r) => [r.repoName, r]));
+    const settingsByRepo = new Map((input.settings?.repos ?? []).map((r) => [r.repoName, r]));
+    // Collect all repo names in order
     const allRepos = [];
-    for (const action of lifecycle.actions) {
-        if (!allRepos.includes(action.repoName)) {
-            allRepos.push(action.repoName);
-        }
-    }
-    for (const repo of sync.repos) {
-        if (!allRepos.includes(repo.repoName)) {
-            allRepos.push(repo.repoName);
-        }
-    }
+    const addRepo = (name) => {
+        if (!allRepos.includes(name))
+            allRepos.push(name);
+    };
+    for (const a of input.lifecycle?.actions ?? [])
+        addRepo(a.repoName);
+    for (const r of input.sync?.repos ?? [])
+        addRepo(r.repoName);
+    for (const r of input.settings?.repos ?? [])
+        addRepo(r.repoName);
     // Diff block
     const diffLines = [];
     for (const repoName of allRepos) {
         const lcAction = lifecycleByRepo.get(repoName);
         const syncRepo = syncByRepo.get(repoName);
+        const settingsRepo = settingsByRepo.get(repoName);
         const hasLcChange = lcAction && lcAction.action !== "existed";
         const hasSyncChanges = syncRepo && (syncRepo.files.length > 0 || syncRepo.error);
-        if (!hasLcChange && !hasSyncChanges)
+        const hasSettingsChanges = settingsRepo &&
+            (settingsRepo.settings.length > 0 ||
+                settingsRepo.rulesets.length > 0 ||
+                settingsRepo.error);
+        if (!hasLcChange && !hasSyncChanges && !hasSettingsChanges)
             continue;
-        // Repo header
         diffLines.push(`@@ ${repoName} @@`);
-        // Lifecycle action
-        if (lcAction && lcAction.action !== "existed") {
-            switch (lcAction.action) {
-                case "created":
-                    diffLines.push(`+ CREATE`);
-                    break;
-                case "forked":
-                    diffLines.push(`+ FORK ${lcAction.upstream ?? "upstream"} -> ${repoName}`);
-                    break;
-                case "migrated":
-                    diffLines.push(`+ MIGRATE ${lcAction.source ?? "source"} -> ${repoName}`);
-                    break;
-            }
-            if (lcAction.settings) {
-                if (lcAction.settings.visibility) {
-                    diffLines.push(`+   visibility: ${lcAction.settings.visibility}`);
-                }
-                if (lcAction.settings.description) {
-                    diffLines.push(`+   description: "${lcAction.settings.description}"`);
-                }
-            }
-        }
-        // File changes
-        if (syncRepo) {
-            for (const file of syncRepo.files) {
-                if (file.action === "create") {
-                    diffLines.push(`+ ${file.path}`);
-                }
-                else if (file.action === "update") {
-                    diffLines.push(`! ${file.path}`);
-                }
-                else if (file.action === "delete") {
-                    diffLines.push(`- ${file.path}`);
-                }
-            }
-            if (syncRepo.error) {
-                diffLines.push(`- Error: ${syncRepo.error}`);
-            }
-        }
+        if (lcAction)
+            renderLifecycleLines(lcAction, diffLines);
+        if (syncRepo)
+            renderSyncLines(syncRepo, diffLines);
+        if (settingsRepo)
+            renderSettingsLines(settingsRepo, diffLines);
     }
     if (diffLines.length > 0) {
         lines.push("```diff");
@@ -130,17 +230,17 @@ export function formatUnifiedSummaryMarkdown(lifecycle, sync, dryRun) {
         lines.push("");
     }
     // Combined summary
-    lines.push(`**${formatCombinedSummary(lifecycle.totals, sync.totals)}**`);
+    lines.push(`**${formatCombinedSummary(input)}**`);
     return lines.join("\n");
 }
 // =============================================================================
 // File Writer
 // =============================================================================
-export function writeUnifiedSummary(lifecycle, sync, dryRun) {
+export function writeUnifiedSummary(input) {
     const summaryPath = process.env.GITHUB_STEP_SUMMARY;
     if (!summaryPath)
         return;
-    const markdown = formatUnifiedSummaryMarkdown(lifecycle, sync, dryRun);
+    const markdown = formatUnifiedSummaryMarkdown(input);
     if (!markdown)
         return;
     appendFileSync(summaryPath, "\n" + markdown + "\n");

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@aspruyt/xfg",
-  "version": "3.9.1",
+  "version": "3.9.3",
   "description": "CLI tool for repository-as-code: sync files and manage settings across GitHub, Azure DevOps, and GitLab",
   "type": "module",
   "main": "dist/index.js",