@aspruyt/xfg 3.7.7 → 3.8.0

package/dist/sync/types.d.ts

@@ -228,6 +228,13 @@ export interface ProcessorOptions {
     prTemplate?: string;
     noDelete?: boolean;
 }
+/**
+ * Detail of a single file change for reporting
+ */
+export interface FileChangeDetail {
+    path: string;
+    action: "create" | "update" | "delete";
+}
 /**
  * Result of repository processing
  */
@@ -243,6 +250,7 @@ export interface ProcessorResult {
         message: string;
     };
     diffStats?: DiffStats;
+    fileChanges?: FileChangeDetail[];
 }
 /**
  * Interface for repository processing operations
@@ -292,5 +300,5 @@ export interface IPRMergeHandler {
      * Create PR and optionally merge based on repo config.
      * Returns ProcessorResult with PR URL and merge status.
      */
-    createAndMerge(repoInfo: RepoInfo, repoConfig: RepoConfig, options: PRHandlerOptions, changedFiles: FileAction[], repoName: string, diffStats?: DiffStats): Promise<ProcessorResult>;
+    createAndMerge(repoInfo: RepoInfo, repoConfig: RepoConfig, options: PRHandlerOptions, changedFiles: FileAction[], repoName: string, diffStats?: DiffStats, fileChanges?: FileChangeDetail[]): Promise<ProcessorResult>;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@aspruyt/xfg",
-  "version": "3.7.7",
+  "version": "3.8.0",
   "description": "CLI tool for repository-as-code",
   "type": "module",
   "main": "dist/index.js",

package/dist/output/plan-formatter.d.ts

@@ -1,39 +0,0 @@
-export type ResourceType = "file" | "ruleset" | "setting";
-export type ResourceAction = "create" | "update" | "delete" | "unchanged" | "skipped";
-export interface Resource {
-    type: ResourceType;
-    repo: string;
-    name: string;
-    action: ResourceAction;
-    details?: ResourceDetails;
-    skipReason?: string;
-}
-export interface ResourceDetails {
-    diff?: string[];
-    properties?: PropertyChange[];
-}
-export interface PropertyChange {
-    path: string;
-    action: "add" | "change" | "remove";
-    oldValue?: unknown;
-    newValue?: unknown;
-}
-export declare function formatResourceId(resource: Resource): string;
-export declare function formatResourceLine(resource: Resource): string;
-export interface PlanCounts {
-    create: number;
-    update: number;
-    delete: number;
-    skipped?: number;
-}
-export declare function formatPlanSummary(counts: PlanCounts): string;
-export interface Plan {
-    resources: Resource[];
-    errors?: RepoError[];
-}
-export interface RepoError {
-    repo: string;
-    message: string;
-}
-export declare function formatPlan(plan: Plan): string[];
-export declare function printPlan(plan: Plan): void;

package/dist/output/plan-formatter.js

@@ -1,84 +0,0 @@
-import chalk from "chalk";
-export function formatResourceId(resource) {
-    return `${resource.type} "${resource.repo}/${resource.name}"`;
-}
-export function formatResourceLine(resource) {
-    const id = formatResourceId(resource);
-    switch (resource.action) {
-        case "create":
-            return chalk.green(`+ ${id}`);
-        case "update":
-            return chalk.yellow(`~ ${id}`);
-        case "delete":
-            return chalk.red(`- ${id}`);
-        case "skipped":
-            return chalk.gray(`⊘ ${id}`);
-        case "unchanged":
-            return chalk.gray(`  ${id}`);
-    }
-}
-export function formatPlanSummary(counts) {
-    const parts = [];
-    if (counts.create > 0) {
-        parts.push(chalk.green(`${counts.create} to create`));
-    }
-    if (counts.update > 0) {
-        parts.push(chalk.yellow(`${counts.update} to change`));
-    }
-    if (counts.delete > 0) {
-        parts.push(chalk.red(`${counts.delete} to destroy`));
-    }
-    if (parts.length === 0 && (!counts.skipped || counts.skipped === 0)) {
-        return "No changes. Your repositories match the configuration.";
-    }
-    let summary = parts.length > 0 ? `Plan: ${parts.join(", ")}` : "Plan:";
-    if (counts.skipped && counts.skipped > 0) {
-        summary += chalk.gray(` (${counts.skipped} skipped)`);
-    }
-    return summary;
-}
-export function formatPlan(plan) {
-    const lines = [];
-    // Filter to only changed resources
-    const changedResources = plan.resources.filter((r) => r.action !== "unchanged");
-    // Format each resource
-    for (const resource of changedResources) {
-        lines.push(formatResourceLine(resource));
-        // Add details if present (indented)
-        if (resource.details?.diff) {
-            for (const diffLine of resource.details.diff) {
-                lines.push(`    ${diffLine}`);
-            }
-        }
-    }
-    // Add errors
-    if (plan.errors && plan.errors.length > 0) {
-        for (const error of plan.errors) {
-            lines.push(chalk.red(`✗ ${error.repo}`));
-            lines.push(chalk.red(`    Error: ${error.message}`));
-        }
-    }
-    // Add blank line before summary
-    if (lines.length > 0) {
-        lines.push("");
-    }
-    // Count actions
-    const counts = {
-        create: plan.resources.filter((r) => r.action === "create").length,
-        update: plan.resources.filter((r) => r.action === "update").length,
-        delete: plan.resources.filter((r) => r.action === "delete").length,
-        skipped: plan.resources.filter((r) => r.action === "skipped").length,
-    };
-    lines.push(formatPlanSummary(counts));
-    // Add error count if any
-    if (plan.errors && plan.errors.length > 0) {
-        lines.push(chalk.red(`${plan.errors.length} ${plan.errors.length === 1 ? "repository" : "repositories"} failed.`));
-    }
-    return lines;
-}
-export function printPlan(plan) {
-    const lines = formatPlan(plan);
-    for (const line of lines) {
-        console.log(line);
-    }
-}

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

@@ -1,8 +0,0 @@
-import type { Plan, Resource, PlanCounts, RepoError } from "./plan-formatter.js";
-export type { Plan, Resource, PlanCounts, RepoError };
-export interface PlanMarkdownOptions {
-    title: string;
-    dryRun: boolean;
-}
-export declare function formatPlanMarkdown(plan: Plan, options: PlanMarkdownOptions): string;
-export declare function writePlanSummary(plan: Plan, options: PlanMarkdownOptions): void;

package/dist/output/plan-summary.js

@@ -1,110 +0,0 @@
-import { appendFileSync } from "node:fs";
-function getActionSymbol(action) {
-    switch (action) {
-        case "create":
-            return "+";
-        case "update":
-            return "~";
-        case "delete":
-            return "-";
-        case "skipped":
-            return "⊘";
-        default:
-            return "";
-    }
-}
-function formatResourceIdPlain(resource) {
-    return `${resource.type} "${resource.repo}/${resource.name}"`;
-}
-function countActions(resources) {
-    return {
-        create: resources.filter((r) => r.action === "create").length,
-        update: resources.filter((r) => r.action === "update").length,
-        delete: resources.filter((r) => r.action === "delete").length,
-        skipped: resources.filter((r) => r.action === "skipped").length,
-    };
-}
-function formatPlanSummaryPlain(counts) {
-    const parts = [];
-    if (counts.create > 0)
-        parts.push(`${counts.create} to create`);
-    if (counts.update > 0)
-        parts.push(`${counts.update} to change`);
-    if (counts.delete > 0)
-        parts.push(`${counts.delete} to destroy`);
-    if (parts.length === 0) {
-        return "No changes";
-    }
-    return parts.join(", ");
-}
-export function formatPlanMarkdown(plan, options) {
-    const lines = [];
-    const counts = countActions(plan.resources);
-    const changedResources = plan.resources.filter((r) => r.action !== "unchanged");
-    // Title
-    const titleSuffix = options.dryRun ? " (Dry Run)" : "";
-    lines.push(`## ${options.title}${titleSuffix}`);
-    lines.push("");
-    // Dry-run warning
-    if (options.dryRun) {
-        lines.push("> [!WARNING]");
-        lines.push("> This was a dry run — no changes were applied");
-        lines.push("");
-    }
-    // Plan summary as heading
-    const summaryText = formatPlanSummaryPlain(counts);
-    lines.push(`### Plan: ${summaryText}`);
-    lines.push("");
-    // Resource table (if any changes)
-    if (changedResources.length > 0) {
-        lines.push("<details open>");
-        lines.push("<summary><strong>Resources</strong></summary>");
-        lines.push("");
-        lines.push("| Resource | Action |");
-        lines.push("|----------|--------|");
-        for (const resource of changedResources) {
-            const symbol = getActionSymbol(resource.action);
-            const id = formatResourceIdPlain(resource);
-            lines.push(`| \`${symbol} ${id}\` | ${resource.action} |`);
-        }
-        lines.push("");
-        lines.push("</details>");
-    }
-    // Add diff details for resources that have them
-    const resourcesWithDiffs = changedResources.filter((r) => r.details?.diff && r.details.diff.length > 0);
-    for (const resource of resourcesWithDiffs) {
-        lines.push("");
-        lines.push("<details>");
-        lines.push(`<summary><strong>Diff: ${formatResourceIdPlain(resource)}</strong></summary>`);
-        lines.push("");
-        lines.push("```diff");
-        for (const diffLine of resource.details.diff) {
-            lines.push(diffLine);
-        }
-        lines.push("```");
-        lines.push("");
-        lines.push("</details>");
-    }
-    // Error section
-    if (plan.errors && plan.errors.length > 0) {
-        lines.push("");
-        lines.push("<details open>");
-        lines.push("<summary><strong>Errors</strong></summary>");
-        lines.push("");
-        lines.push("| Repository | Error |");
-        lines.push("|------------|-------|");
-        for (const error of plan.errors) {
-            lines.push(`| ${error.repo} | ${error.message} |`);
-        }
-        lines.push("");
-        lines.push("</details>");
-    }
-    return lines.join("\n");
-}
-export function writePlanSummary(plan, options) {
-    const summaryPath = process.env.GITHUB_STEP_SUMMARY;
-    if (!summaryPath)
-        return;
-    const markdown = formatPlanMarkdown(plan, options);
-    appendFileSync(summaryPath, "\n" + markdown + "\n");
-}

package/dist/settings/resource-converters.d.ts

@@ -1,28 +0,0 @@
-import type { Resource } from "../output/plan-formatter.js";
-import type { RulesetProcessorResult } from "./rulesets/processor.js";
-import type { ProcessorResult } from "../sync/index.js";
-import type { RepoConfig } from "../config/index.js";
-/**
- * Convert RulesetProcessorResult planOutput entries to Resource objects.
- * Includes the detailed plan lines in the first resource's details for display.
- */
-export declare function rulesetResultToResources(repoName: string, result: RulesetProcessorResult): Resource[];
-/**
- * Convert sync ProcessorResult diffStats to Resource objects.
- * Since we don't have per-file details, we represent each file from config
- * with the aggregate action based on diffStats.
- */
-export declare function syncResultToResources(repoName: string, repoConfig: Pick<RepoConfig, "files">, result: ProcessorResult): Resource[];
-/**
- * Convert repo settings processor planOutput entries to Resource objects.
- * Includes the detailed plan lines in the first resource's details for display.
- */
-export declare function repoSettingsResultToResources(repoName: string, result: {
-    planOutput?: {
-        entries?: Array<{
-            property: string;
-            action: string;
-        }>;
-        lines?: string[];
-    };
-}): Resource[];

package/dist/settings/resource-converters.js

@@ -1,107 +0,0 @@
-/**
- * Convert RulesetProcessorResult planOutput entries to Resource objects.
- * Includes the detailed plan lines in the first resource's details for display.
- */
-export function rulesetResultToResources(repoName, result) {
-    const resources = [];
-    const planLines = result.planOutput?.lines ?? [];
-    if (result.planOutput?.entries) {
-        for (let i = 0; i < result.planOutput.entries.length; i++) {
-            const entry = result.planOutput.entries[i];
-            let action;
-            switch (entry.action) {
-                case "create":
-                    action = "create";
-                    break;
-                case "update":
-                    action = "update";
-                    break;
-                case "delete":
-                    action = "delete";
-                    break;
-                default:
-                    action = "unchanged";
-            }
-            // Attach all plan lines to first resource for GitHub summary display
-            const details = i === 0 && planLines.length > 0 ? { diff: planLines } : undefined;
-            resources.push({
-                type: "ruleset",
-                repo: repoName,
-                name: entry.name,
-                action,
-                details,
-            });
-        }
-    }
-    return resources;
-}
-/**
- * Convert sync ProcessorResult diffStats to Resource objects.
- * Since we don't have per-file details, we represent each file from config
- * with the aggregate action based on diffStats.
- */
-export function syncResultToResources(repoName, repoConfig, result) {
-    const resources = [];
-    if (result.skipped) {
-        // Mark all files as unchanged when skipped
-        for (const file of repoConfig.files) {
-            resources.push({
-                type: "file",
-                repo: repoName,
-                name: file.fileName,
-                action: "unchanged",
-            });
-        }
-        return resources;
-    }
-    if (!result.diffStats) {
-        return resources;
-    }
-    // With aggregate stats, we can show repo-level summary
-    // For now, create one resource per file in config with best-effort action
-    // Note: This is approximate since we don't have per-file tracking
-    const { newCount, modifiedCount, deletedCount } = result.diffStats;
-    for (const file of repoConfig.files) {
-        // Determine action based on aggregate stats - this is a simplification
-        let action = "unchanged";
-        if (newCount > 0) {
-            action = "create";
-        }
-        else if (modifiedCount > 0) {
-            action = "update";
-        }
-        else if (deletedCount > 0) {
-            action = "delete";
-        }
-        resources.push({
-            type: "file",
-            repo: repoName,
-            name: file.fileName,
-            action,
-        });
-    }
-    return resources;
-}
-/**
- * Convert repo settings processor planOutput entries to Resource objects.
- * Includes the detailed plan lines in the first resource's details for display.
- */
-export function repoSettingsResultToResources(repoName, result) {
-    const resources = [];
-    const planLines = result.planOutput?.lines ?? [];
-    if (result.planOutput?.entries) {
-        for (let i = 0; i < result.planOutput.entries.length; i++) {
-            const entry = result.planOutput.entries[i];
-            // Attach all plan lines to first resource for GitHub summary display
-            const details = i === 0 && planLines.length > 0 ? { diff: planLines } : undefined;
-            resources.push({
-                type: "setting",
-                repo: repoName,
-                name: entry.property,
-                action: entry.action === "add" ? "create" : "update",
-                details,
-            });
-        }
-    }
-    return resources;
-}