@aspruyt/xfg 1.10.9 → 2.0.0

package/README.md

@@ -52,6 +52,7 @@ xfg --config ./config.yaml
 
 ```yaml
 # sync-config.yaml
+id: my-org-prettier-config
 files:
   .prettierrc.json:
     content:

package/dist/config-normalizer.js

@@ -147,6 +147,7 @@ export function normalizeConfig(raw) {
         }
     }
     return {
+        id: raw.id,
         repos: expandedRepos,
         prTemplate: raw.prTemplate,
         githubHosts: raw.githubHosts,

package/dist/config-validator.js

@@ -21,11 +21,24 @@ function isStructuredFileExtension(fileName) {
     const ext = extname(fileName).toLowerCase();
     return (ext === ".json" || ext === ".json5" || ext === ".yaml" || ext === ".yml");
 }
+// Pattern for valid config ID: alphanumeric, hyphens, underscores
+const CONFIG_ID_PATTERN = /^[a-zA-Z0-9_-]+$/;
+const CONFIG_ID_MAX_LENGTH = 64;
 /**
  * Validates raw config structure before normalization.
  * @throws Error if validation fails
  */
 export function validateRawConfig(config) {
+    // Validate required id field
+    if (!config.id || typeof config.id !== "string") {
+        throw new Error("Config requires an 'id' field. This unique identifier is used to namespace managed files in .xfg.json");
+    }
+    if (!CONFIG_ID_PATTERN.test(config.id)) {
+        throw new Error(`Config 'id' contains invalid characters: '${config.id}'. Use only alphanumeric characters, hyphens, and underscores.`);
+    }
+    if (config.id.length > CONFIG_ID_MAX_LENGTH) {
+        throw new Error(`Config 'id' exceeds maximum length of ${CONFIG_ID_MAX_LENGTH} characters`);
+    }
     if (!config.files || typeof config.files !== "object") {
         throw new Error("Config missing required field: files (must be an object)");
     }

package/dist/config.d.ts

@@ -37,6 +37,7 @@ export interface RawRepoConfig {
     prOptions?: PRMergeOptions;
 }
 export interface RawConfig {
+    id: string;
     files: Record<string, RawFileConfig>;
     repos: RawRepoConfig[];
     prOptions?: PRMergeOptions;
@@ -61,6 +62,7 @@ export interface RepoConfig {
     prOptions?: PRMergeOptions;
 }
 export interface Config {
+    id: string;
     repos: RepoConfig[];
     prTemplate?: string;
     githubHosts?: string[];

package/dist/index.js

@@ -132,6 +132,7 @@ async function main() {
             const result = await processor.process(repoConfig, repoInfo, {
                 branchName,
                 workDir,
+                configId: config.id,
                 dryRun: options.dryRun,
                 retries: options.retries,
                 prTemplate: config.prTemplate,

package/dist/manifest.d.ts

@@ -1,7 +1,7 @@
 export declare const MANIFEST_FILENAME = ".xfg.json";
 export interface XfgManifest {
-    version: 1;
-    managedFiles: string[];
+    version: 2;
+    configs: Record<string, string[]>;
 }
 /**
  * Creates an empty manifest with the current version.
@@ -9,10 +9,14 @@ export interface XfgManifest {
 export declare function createEmptyManifest(): XfgManifest;
 /**
  * Loads the xfg manifest from a repository's working directory.
- * Returns null if the manifest file doesn't exist.
+ * Returns null if the manifest file doesn't exist or is v1 format.
+ *
+ * V1 manifests are treated as non-existent because they lack the config ID
+ * namespace required for multi-config support. The next run will create
+ * a fresh v2 manifest.
  *
  * @param workDir - The repository working directory
- * @returns The manifest or null if not found
+ * @returns The manifest or null if not found or incompatible
  */
 export declare function loadManifest(workDir: string): XfgManifest | null;
 /**
@@ -23,24 +27,28 @@ export declare function loadManifest(workDir: string): XfgManifest | null;
  */
 export declare function saveManifest(workDir: string, manifest: XfgManifest): void;
 /**
- * Gets the list of managed files from a manifest.
- * Returns an empty array if the manifest is null.
+ * Gets the list of managed files for a specific config from a manifest.
+ * Returns an empty array if the manifest is null or the config isn't found.
  *
  * @param manifest - The manifest or null
- * @returns Array of managed file names
+ * @param configId - The config ID to get files for
+ * @returns Array of managed file names for the given config
  */
-export declare function getManagedFiles(manifest: XfgManifest | null): string[];
+export declare function getManagedFiles(manifest: XfgManifest | null, configId: string): string[];
 /**
- * Updates the manifest with the current set of files that have deleteOrphaned enabled.
+ * Updates the manifest with the current set of files that have deleteOrphaned enabled
+ * for a specific config. Only modifies that config's namespace - other configs are untouched.
+ *
  * Files with deleteOrphaned: true are added to managedFiles.
  * Files with deleteOrphaned: false (explicit) are removed from managedFiles.
- * Files not in the config but in managedFiles are candidates for deletion.
+ * Files not in the config but in managedFiles for this configId are candidates for deletion.
  *
  * @param manifest - The existing manifest (or null for new repos)
+ * @param configId - The config ID to update
  * @param filesWithDeleteOrphaned - Map of fileName to deleteOrphaned value (true/false/undefined)
  * @returns Updated manifest and list of files to delete
  */
-export declare function updateManifest(manifest: XfgManifest | null, filesWithDeleteOrphaned: Map<string, boolean | undefined>): {
+export declare function updateManifest(manifest: XfgManifest | null, configId: string, filesWithDeleteOrphaned: Map<string, boolean | undefined>): {
     manifest: XfgManifest;
     filesToDelete: string[];
 };

package/dist/manifest.js

@@ -1,21 +1,44 @@
 import { readFileSync, writeFileSync, existsSync } from "node:fs";
 import { join } from "node:path";
 export const MANIFEST_FILENAME = ".xfg.json";
+/**
+ * Type guard to check if a manifest is v1 format.
+ */
+function isV1Manifest(manifest) {
+    return (typeof manifest === "object" &&
+        manifest !== null &&
+        manifest.version === 1 &&
+        Array.isArray(manifest.managedFiles));
+}
+/**
+ * Type guard to check if a manifest is v2 format.
+ */
+function isV2Manifest(manifest) {
+    return (typeof manifest === "object" &&
+        manifest !== null &&
+        manifest.version === 2 &&
+        typeof manifest.configs === "object" &&
+        manifest.configs !== null);
+}
 /**
  * Creates an empty manifest with the current version.
  */
 export function createEmptyManifest() {
     return {
-        version: 1,
-        managedFiles: [],
+        version: 2,
+        configs: {},
     };
 }
 /**
  * Loads the xfg manifest from a repository's working directory.
- * Returns null if the manifest file doesn't exist.
+ * Returns null if the manifest file doesn't exist or is v1 format.
+ *
+ * V1 manifests are treated as non-existent because they lack the config ID
+ * namespace required for multi-config support. The next run will create
+ * a fresh v2 manifest.
  *
  * @param workDir - The repository working directory
- * @returns The manifest or null if not found
+ * @returns The manifest or null if not found or incompatible
  */
 export function loadManifest(workDir) {
     const manifestPath = join(workDir, MANIFEST_FILENAME);
@@ -25,17 +48,16 @@ export function loadManifest(workDir) {
     try {
         const content = readFileSync(manifestPath, "utf-8");
         const parsed = JSON.parse(content);
-        // Validate the manifest structure
-        if (typeof parsed !== "object" || parsed === null) {
-            return null;
+        // V2 manifest - return as-is
+        if (isV2Manifest(parsed)) {
+            return parsed;
         }
-        if (parsed.version !== 1) {
+        // V1 manifest - treat as no manifest (will be overwritten with v2)
+        if (isV1Manifest(parsed)) {
             return null;
         }
-        if (!Array.isArray(parsed.managedFiles)) {
-            return null;
-        }
-        return parsed;
+        // Unknown format - treat as no manifest
+        return null;
     }
     catch {
         return null;
@@ -53,30 +75,35 @@ export function saveManifest(workDir, manifest) {
     writeFileSync(manifestPath, content, "utf-8");
 }
 /**
- * Gets the list of managed files from a manifest.
- * Returns an empty array if the manifest is null.
+ * Gets the list of managed files for a specific config from a manifest.
+ * Returns an empty array if the manifest is null or the config isn't found.
  *
  * @param manifest - The manifest or null
- * @returns Array of managed file names
+ * @param configId - The config ID to get files for
+ * @returns Array of managed file names for the given config
  */
-export function getManagedFiles(manifest) {
+export function getManagedFiles(manifest, configId) {
     if (!manifest) {
         return [];
     }
-    return [...manifest.managedFiles];
+    return [...(manifest.configs[configId] ?? [])];
 }
 /**
- * Updates the manifest with the current set of files that have deleteOrphaned enabled.
+ * Updates the manifest with the current set of files that have deleteOrphaned enabled
+ * for a specific config. Only modifies that config's namespace - other configs are untouched.
+ *
  * Files with deleteOrphaned: true are added to managedFiles.
  * Files with deleteOrphaned: false (explicit) are removed from managedFiles.
- * Files not in the config but in managedFiles are candidates for deletion.
+ * Files not in the config but in managedFiles for this configId are candidates for deletion.
  *
  * @param manifest - The existing manifest (or null for new repos)
+ * @param configId - The config ID to update
  * @param filesWithDeleteOrphaned - Map of fileName to deleteOrphaned value (true/false/undefined)
  * @returns Updated manifest and list of files to delete
  */
-export function updateManifest(manifest, filesWithDeleteOrphaned) {
-    const existingManaged = new Set(getManagedFiles(manifest));
+export function updateManifest(manifest, configId, filesWithDeleteOrphaned) {
+    // Get existing managed files for this config only
+    const existingManaged = new Set(getManagedFiles(manifest, configId));
     const newManaged = new Set();
     const filesToDelete = [];
     // Process current config files
@@ -88,17 +115,30 @@ export function updateManifest(manifest, filesWithDeleteOrphaned) {
         // If deleteOrphaned is false or undefined, don't add to managed set
         // (explicitly setting false removes from tracking)
     }
-    // Find orphaned files: in old manifest but not in current config
+    // Find orphaned files: in old manifest for this config but not in current config
     for (const fileName of existingManaged) {
         if (!filesWithDeleteOrphaned.has(fileName)) {
             // File was managed before but is no longer in config - delete it
             filesToDelete.push(fileName);
         }
     }
+    // Build updated manifest, preserving other configs
+    const updatedConfigs = {
+        ...(manifest?.configs ?? {}),
+    };
+    // Update this config's managed files
+    const sortedManaged = Array.from(newManaged).sort();
+    if (sortedManaged.length > 0) {
+        updatedConfigs[configId] = sortedManaged;
+    }
+    else {
+        // Remove config entry if no managed files
+        delete updatedConfigs[configId];
+    }
     return {
         manifest: {
-            version: 1,
-            managedFiles: Array.from(newManaged).sort(),
+            version: 2,
+            configs: updatedConfigs,
         },
         filesToDelete,
     };

package/dist/repository-processor.d.ts

@@ -6,6 +6,8 @@ import { CommandExecutor } from "./command-executor.js";
 export interface ProcessorOptions {
     branchName: string;
     workDir: string;
+    /** Config ID for manifest namespacing */
+    configId: string;
     dryRun?: boolean;
     /** Number of retries for network operations (default: 3) */
     retries?: number;

package/dist/repository-processor.js

@@ -174,7 +174,7 @@ export class RepositoryProcessor {
                 filesWithDeleteOrphaned.set(file.fileName, file.deleteOrphaned);
             }
             // Update manifest and get list of files to delete
-            const { manifest: newManifest, filesToDelete } = updateManifest(existingManifest, filesWithDeleteOrphaned);
+            const { manifest: newManifest, filesToDelete } = updateManifest(existingManifest, options.configId, filesWithDeleteOrphaned);
             // Delete orphaned files (unless --no-delete flag is set)
             if (filesToDelete.length > 0 && !options.noDelete) {
                 for (const fileName of filesToDelete) {
@@ -197,18 +197,18 @@ export class RepositoryProcessor {
                 this.log.info(`Skipping deletion of ${filesToDelete.length} orphaned file(s) (--no-delete flag)`);
             }
             // Save updated manifest (tracks files with deleteOrphaned: true)
-            // Only save if there are managed files or if we had a previous manifest
-            if (newManifest.managedFiles.length > 0 || existingManifest !== null) {
+            // Only save if there are managed files for any config, or if we had a previous manifest
+            const hasAnyManagedFiles = Object.keys(newManifest.configs).length > 0;
+            if (hasAnyManagedFiles || existingManifest !== null) {
                 if (!dryRun) {
                     saveManifest(workDir, newManifest);
                 }
                 // Track manifest file as changed if it would be different
-                const existingManifestFiles = existingManifest?.managedFiles ?? [];
-                const newManifestFiles = newManifest.managedFiles;
-                const manifestChanged = JSON.stringify(existingManifestFiles) !==
-                    JSON.stringify(newManifestFiles);
+                const existingConfigs = existingManifest?.configs ?? {};
+                const manifestChanged = JSON.stringify(existingConfigs) !==
+                    JSON.stringify(newManifest.configs);
                 if (manifestChanged) {
-                    const manifestExisted = existingManifest !== null;
+                    const manifestExisted = existsSync(join(workDir, MANIFEST_FILENAME));
                     changedFiles.push({
                         fileName: MANIFEST_FILENAME,
                         action: manifestExisted ? "update" : "create",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@aspruyt/xfg",
-  "version": "1.10.9",
+  "version": "2.0.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",