@aspruyt/xfg 3.1.5 → 3.2.0

package/dist/config-normalizer.js

@@ -60,14 +60,30 @@ export function mergeSettings(root, perRepo) {
     // Merge rulesets by name - each ruleset is deep merged
     const rootRulesets = root?.rulesets ?? {};
     const repoRulesets = perRepo?.rulesets ?? {};
+    // Check if repo opts out of all inherited rulesets
+    const inheritRulesets = repoRulesets?.inherit !== false;
     const allRulesetNames = new Set([
-        ...Object.keys(rootRulesets),
-        ...Object.keys(repoRulesets),
+        ...Object.keys(rootRulesets).filter((name) => name !== "inherit"),
+        ...Object.keys(repoRulesets).filter((name) => name !== "inherit"),
     ]);
     if (allRulesetNames.size > 0) {
         result.rulesets = {};
         for (const name of allRulesetNames) {
-            result.rulesets[name] = mergeRuleset(rootRulesets[name], repoRulesets[name]);
+            const rootRuleset = rootRulesets[name];
+            const repoRuleset = repoRulesets[name];
+            // Skip if repo explicitly opts out of this ruleset
+            if (repoRuleset === false) {
+                continue;
+            }
+            // Skip root rulesets if inherit: false (unless repo has override)
+            if (!inheritRulesets && !repoRuleset && rootRuleset) {
+                continue;
+            }
+            result.rulesets[name] = mergeRuleset(rootRuleset, repoRuleset);
+        }
+        // Clean up empty rulesets object
+        if (Object.keys(result.rulesets).length === 0) {
+            delete result.rulesets;
         }
     }
     // deleteOrphaned: per-repo overrides root
@@ -89,13 +105,23 @@ export function normalizeConfig(raw) {
         const gitUrls = Array.isArray(rawRepo.git) ? rawRepo.git : [rawRepo.git];
         for (const gitUrl of gitUrls) {
             const files = [];
+            // Check if repo opts out of all inherited files
+            const inheritFiles = rawRepo.files?.inherit !==
+                false;
             // Step 2: Process each file definition
             for (const fileName of fileNames) {
+                // Skip reserved key
+                if (fileName === "inherit")
+                    continue;
                 const repoOverride = rawRepo.files?.[fileName];
                 // Skip excluded files (set to false)
                 if (repoOverride === false) {
                     continue;
                 }
+                // Skip if inherit: false and no repo-specific override
+                if (!inheritFiles && !repoOverride) {
+                    continue;
+                }
                 const fileConfig = raw.files[fileName];
                 const fileStrategy = fileConfig.mergeStrategy ?? "replace";
                 // Step 3: Compute merged content for this file
@@ -190,12 +216,34 @@ export function normalizeConfig(raw) {
             });
         }
     }
+    // Normalize root settings (filter out inherit key if present)
+    let normalizedRootSettings;
+    if (raw.settings) {
+        normalizedRootSettings = {};
+        if (raw.settings.rulesets) {
+            const filteredRulesets = {};
+            for (const [name, ruleset] of Object.entries(raw.settings.rulesets)) {
+                if (name === "inherit" || ruleset === false)
+                    continue;
+                filteredRulesets[name] = ruleset;
+            }
+            if (Object.keys(filteredRulesets).length > 0) {
+                normalizedRootSettings.rulesets = filteredRulesets;
+            }
+        }
+        if (raw.settings.deleteOrphaned !== undefined) {
+            normalizedRootSettings.deleteOrphaned = raw.settings.deleteOrphaned;
+        }
+        if (Object.keys(normalizedRootSettings).length === 0) {
+            normalizedRootSettings = undefined;
+        }
+    }
     return {
         id: raw.id,
         repos: expandedRepos,
         prTemplate: raw.prTemplate,
         githubHosts: raw.githubHosts,
         deleteOrphaned: raw.deleteOrphaned,
-        settings: raw.settings,
+        settings: normalizedRootSettings,
     };
 }

package/dist/config-validator.d.ts

@@ -7,7 +7,7 @@ export declare function validateRawConfig(config: RawConfig): void;
 /**
  * Validates settings object containing rulesets.
  */
-export declare function validateSettings(settings: unknown, context: string): void;
+export declare function validateSettings(settings: unknown, context: string, rootRulesetNames?: string[]): void;
 /**
  * Validates that config is suitable for the sync command.
  * @throws Error if files section is missing or empty

package/dist/config-validator.js

@@ -49,6 +49,10 @@ export function validateRawConfig(config) {
             "Use 'files' to sync configuration files, or 'settings' to manage repository settings.");
     }
     const fileNames = hasFiles ? Object.keys(config.files) : [];
+    // Check for reserved key 'inherit' at root files level
+    if (hasFiles && "inherit" in config.files) {
+        throw new Error("'inherit' is a reserved key and cannot be used as a filename");
+    }
     // Validate each file definition
     for (const fileName of fileNames) {
         validateFileName(fileName);
@@ -127,6 +131,10 @@ export function validateRawConfig(config) {
     // Validate root settings
     if (config.settings !== undefined) {
         validateSettings(config.settings, "Root");
+        // Check for reserved key 'inherit' at root rulesets level
+        if (config.settings.rulesets && "inherit" in config.settings.rulesets) {
+            throw new Error("'inherit' is a reserved key and cannot be used as a ruleset name");
+        }
     }
     // Validate githubHosts if provided
     if (config.githubHosts !== undefined) {
@@ -161,6 +169,14 @@ export function validateRawConfig(config) {
                 throw new Error(`Repo at index ${i}: files must be an object`);
             }
             for (const fileName of Object.keys(repo.files)) {
+                // Skip reserved key 'inherit'
+                if (fileName === "inherit") {
+                    const inheritValue = repo.files.inherit;
+                    if (typeof inheritValue !== "boolean") {
+                        throw new Error(`Repo at index ${i}: files.inherit must be a boolean`);
+                    }
+                    continue;
+                }
                 // Ensure the file is defined at root level
                 if (!config.files || !config.files[fileName]) {
                     throw new Error(`Repo at index ${i} references undefined file '${fileName}'. File must be defined in root 'files' object.`);
@@ -233,7 +249,10 @@ export function validateRawConfig(config) {
         }
         // Validate per-repo settings
         if (repo.settings !== undefined) {
-            validateSettings(repo.settings, `Repo ${getGitDisplayName(repo.git)}`);
+            const rootRulesetNames = config.settings?.rulesets
+                ? Object.keys(config.settings.rulesets).filter((k) => k !== "inherit")
+                : [];
+            validateSettings(repo.settings, `Repo ${getGitDisplayName(repo.git)}`, rootRulesetNames);
         }
     }
 }
@@ -465,7 +484,7 @@ function validateRuleset(ruleset, name, context) {
 /**
  * Validates settings object containing rulesets.
  */
-export function validateSettings(settings, context) {
+export function validateSettings(settings, context, rootRulesetNames) {
     if (typeof settings !== "object" ||
         settings === null ||
         Array.isArray(settings)) {
@@ -480,6 +499,16 @@ export function validateSettings(settings, context) {
         }
         const rulesets = s.rulesets;
         for (const [name, ruleset] of Object.entries(rulesets)) {
+            // Skip reserved key
+            if (name === "inherit")
+                continue;
+            // Check for opt-out of non-existent root ruleset
+            if (ruleset === false) {
+                if (rootRulesetNames && !rootRulesetNames.includes(name)) {
+                    throw new Error(`${context}: Cannot opt out of '${name}' - not defined in root settings.rulesets`);
+                }
+                continue; // Skip further validation for false entries
+            }
             validateRuleset(ruleset, name, context);
         }
     }

package/dist/config.d.ts

@@ -239,12 +239,16 @@ export interface RawRepoFileOverride {
     deleteOrphaned?: boolean;
 }
 export interface RawRepoSettings {
-    rulesets?: Record<string, Ruleset>;
+    rulesets?: Record<string, Ruleset | false> & {
+        inherit?: boolean;
+    };
     deleteOrphaned?: boolean;
 }
 export interface RawRepoConfig {
     git: string | string[];
-    files?: Record<string, RawRepoFileOverride | false>;
+    files?: Record<string, RawRepoFileOverride | false> & {
+        inherit?: boolean;
+    };
     prOptions?: PRMergeOptions;
     settings?: RawRepoSettings;
 }

package/package.json

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