rulesync 8.0.0 → 8.2.0

package/README.md

@@ -28,7 +28,7 @@ npm install -g rulesync
 brew install rulesync
 ```
 
-### Single Binary (Experimental)
+### Single Binary
 
 ```bash
 curl -fsSL https://github.com/dyoshikawa/rulesync/releases/latest/download/install.sh | bash

package/dist/{chunk-GB6XLCGB.js → chunk-K4IN6URH.js}

@@ -33,12 +33,13 @@ var FeaturesSchema = z.array(FeatureSchema);
 var FeatureOptionsSchema = z.record(z.string(), z.unknown());
 var FeatureValueSchema = z.union([z.boolean(), FeatureOptionsSchema]);
 var PerFeatureConfigSchema = z.record(z.string(), FeatureValueSchema);
+var PerTargetFeaturesValueSchema = z.union([
+  z.array(z.enum(ALL_FEATURES_WITH_WILDCARD)),
+  PerFeatureConfigSchema
+]);
 var RulesyncFeaturesSchema = z.union([
   z.array(z.enum(ALL_FEATURES_WITH_WILDCARD)),
-  z.record(
-    z.string(),
-    z.union([z.array(z.enum(ALL_FEATURES_WITH_WILDCARD)), PerFeatureConfigSchema])
-  )
+  z.record(z.string(), PerTargetFeaturesValueSchema)
 ]);
 var isFeatureValueEnabled = (value) => {
   if (value === true) return true;
@@ -81,6 +82,14 @@ var ALL_TOOL_TARGETS_WITH_WILDCARD = [...ALL_TOOL_TARGETS, "*"];
 var ToolTargetSchema = z2.enum(ALL_TOOL_TARGETS);
 var ToolTargetsSchema = z2.array(ToolTargetSchema);
 var RulesyncTargetsSchema = z2.array(z2.enum(ALL_TOOL_TARGETS_WITH_WILDCARD));
+var RulesyncConfigTargetsObjectSchema = z2.record(z2.string(), PerTargetFeaturesValueSchema);
+var RulesyncConfigTargetsSchema = z2.union([
+  RulesyncTargetsSchema,
+  RulesyncConfigTargetsObjectSchema
+]);
+var isRulesyncConfigTargetsObject = (value) => {
+  return !Array.isArray(value);
+};
 
 // src/config/config-resolver.ts
 import { dirname as dirname2, join as join3, resolve as resolve2 } from "path";
@@ -338,7 +347,7 @@ var SourceEntrySchema = z3.object({
 });
 var ConfigParamsSchema = z3.object({
   baseDirs: z3.array(z3.string()),
-  targets: RulesyncTargetsSchema,
+  targets: RulesyncConfigTargetsSchema,
   features: RulesyncFeaturesSchema,
   verbose: z3.boolean(),
   delete: z3.boolean(),
@@ -348,6 +357,7 @@ var ConfigParamsSchema = z3.object({
   simulateCommands: optional(z3.boolean()),
   simulateSubagents: optional(z3.boolean()),
   simulateSkills: optional(z3.boolean()),
+  gitignoreTargetsOnly: optional(z3.boolean()),
   dryRun: optional(z3.boolean()),
   check: optional(z3.boolean()),
   // Declarative skill sources
@@ -364,10 +374,42 @@ var CONFLICTING_TARGET_PAIRS = [
   ["claudecode", "claudecode-legacy"]
 ];
 var LEGACY_TARGETS = ["augmentcode-legacy", "claudecode-legacy"];
+var assertTargetsFeaturesExclusive = ({
+  targets,
+  features
+}) => {
+  const targetsIsObject = targets !== void 0 && !Array.isArray(targets);
+  const featuresIsObject = features !== void 0 && !Array.isArray(features);
+  if (targetsIsObject && features !== void 0) {
+    throw new Error(
+      "Invalid config: when 'targets' is in object form, 'features' must be omitted. Declare per-target features inside the 'targets' object instead."
+    );
+  }
+  if (featuresIsObject && targets !== void 0) {
+    throw new Error(
+      "Invalid config: when 'features' is in object form, 'targets' must be omitted. Migrate to the 'targets' object form, e.g. `targets: { claudecode: [...] }`."
+    );
+  }
+};
+var assertTargetsOrFeaturesProvided = ({
+  targets,
+  features
+}) => {
+  if (targets === void 0 && features === void 0) {
+    throw new Error("Invalid config: at least one of 'targets' or 'features' must be provided.");
+  }
+};
 var Config = class _Config {
   baseDirs;
   targets;
   features;
+  /**
+   * Cached list of validated `ToolTarget` keys for the object form of
+   * `targets`. Populated in the constructor after `validateObjectFormTargetKeys`
+   * so `getTargets()` does not rebuild the `ALL_TOOL_TARGETS` set on every call.
+   * Undefined when `this.targets` is in array form.
+   */
+  objectFormTargetKeys;
   verbose;
   delete;
   global;
@@ -375,6 +417,7 @@ var Config = class _Config {
   simulateCommands;
   simulateSubagents;
   simulateSkills;
+  gitignoreTargetsOnly;
   dryRun;
   check;
   sources;
@@ -389,17 +432,24 @@ var Config = class _Config {
     simulateCommands,
     simulateSubagents,
     simulateSkills,
+    gitignoreTargetsOnly,
     dryRun,
     check,
     sources
   }) {
-    this.validateConflictingTargets(targets);
+    assertTargetsFeaturesExclusive({ targets, features });
+    assertTargetsOrFeaturesProvided({ targets, features });
+    const resolvedTargets = targets ?? [];
+    const resolvedFeatures = features ?? [];
+    this.validateObjectFormTargetKeys(resolvedTargets);
+    this.validateConflictingTargets(resolvedTargets);
     if (dryRun && check) {
       throw new Error("--dry-run and --check cannot be used together");
     }
     this.baseDirs = baseDirs;
-    this.targets = targets;
-    this.features = features;
+    this.targets = resolvedTargets;
+    this.features = resolvedFeatures;
+    this.objectFormTargetKeys = isRulesyncConfigTargetsObject(resolvedTargets) ? _Config.filterValidToolTargets(Object.keys(resolvedTargets)) : void 0;
     this.verbose = verbose;
     this.delete = isDelete;
     this.global = global ?? false;
@@ -407,15 +457,42 @@ var Config = class _Config {
     this.simulateCommands = simulateCommands ?? false;
     this.simulateSubagents = simulateSubagents ?? false;
     this.simulateSkills = simulateSkills ?? false;
+    this.gitignoreTargetsOnly = gitignoreTargetsOnly ?? true;
     this.dryRun = dryRun ?? false;
     this.check = check ?? false;
     this.sources = sources ?? [];
   }
+  /**
+   * Rejects unknown keys (and the special `*` key) in the object form of
+   * `targets`. For the array form this is already enforced at the Zod schema
+   * level via `z.enum(ALL_TOOL_TARGETS_WITH_WILDCARD)`; for the object form
+   * `z.record(z.string(), ...)` intentionally accepts any string key (to work
+   * around zod's `z.record(z.enum(...))` requiring ALL enum members), so
+   * runtime validation lives here instead.
+   */
+  validateObjectFormTargetKeys(targets) {
+    if (Array.isArray(targets)) return;
+    const validTargets = new Set(ALL_TOOL_TARGETS);
+    for (const key of Object.keys(targets)) {
+      if (key === "*") {
+        throw new Error(
+          "Invalid target '*' in object form: wildcard is only supported in the array form `targets: ['*']`. Per-target options cannot be attached to a wildcard."
+        );
+      }
+      if (!validTargets.has(key)) {
+        throw new Error(`Unknown target '${key}'. Valid targets: ${ALL_TOOL_TARGETS.join(", ")}.`);
+      }
+    }
+  }
   validateConflictingTargets(targets) {
+    const has = (target) => {
+      if (Array.isArray(targets)) {
+        return targets.includes(target);
+      }
+      return Object.prototype.hasOwnProperty.call(targets, target);
+    };
     for (const [target1, target2] of CONFLICTING_TARGET_PAIRS) {
-      const hasTarget1 = targets.includes(target1);
-      const hasTarget2 = targets.includes(target2);
-      if (hasTarget1 && hasTarget2) {
+      if (has(target1) && has(target2)) {
         throw new Error(
           `Conflicting targets: '${target1}' and '${target2}' cannot be used together. Please choose one.`
         );
@@ -425,16 +502,45 @@ var Config = class _Config {
   getBaseDirs() {
     return this.baseDirs;
   }
+  /**
+   * Filter an arbitrary string-key list down to the known `ToolTarget` set,
+   * skipping `*` (which is only meaningful as an array element, not a key).
+   */
+  static filterValidToolTargets(keys) {
+    const validTargets = new Set(ALL_TOOL_TARGETS);
+    const result = [];
+    for (const key of keys) {
+      if (key === "*") continue;
+      if (!validTargets.has(key)) continue;
+      result.push(key);
+    }
+    return result;
+  }
   getTargets() {
-    if (this.targets.includes("*")) {
+    if (this.objectFormTargetKeys !== void 0) {
+      return this.objectFormTargetKeys;
+    }
+    const arrayTargets = Array.isArray(this.targets) ? this.targets : [];
+    if (!Array.isArray(this.features)) {
+      return _Config.filterValidToolTargets(Object.keys(this.features));
+    }
+    if (arrayTargets.includes("*")) {
       return ALL_TOOL_TARGETS.filter(
         // eslint-disable-next-line no-type-assertion/no-type-assertion
         (target) => !LEGACY_TARGETS.includes(target)
       );
     }
-    return this.targets.filter((target) => target !== "*");
+    return arrayTargets.filter((target) => target !== "*");
   }
   getFeatures(target) {
+    if (isRulesyncConfigTargetsObject(this.targets)) {
+      if (target) {
+        const value = this.targets[target];
+        if (!value) return [];
+        return _Config.normalizeTargetFeatures(value);
+      }
+      return _Config.collectAllFeatures(Object.values(this.targets));
+    }
     if (!Array.isArray(this.features)) {
       const perTargetFeatures = this.features;
       if (target) {
@@ -444,20 +550,7 @@ var Config = class _Config {
         }
         return _Config.normalizeTargetFeatures(targetFeatures);
       }
-      const allFeatures = [];
-      for (const features of Object.values(perTargetFeatures)) {
-        if (!features) continue;
-        const normalized = _Config.normalizeTargetFeatures(features);
-        for (const feature of normalized) {
-          if (!allFeatures.includes(feature)) {
-            allFeatures.push(feature);
-          }
-        }
-        if (allFeatures.length === ALL_FEATURES.length) {
-          return allFeatures;
-        }
-      }
-      return allFeatures;
+      return _Config.collectAllFeatures(Object.values(perTargetFeatures));
     }
     if (this.features.includes("*")) {
       return [...ALL_FEATURES];
@@ -485,23 +578,40 @@ var Config = class _Config {
     }
     return enabled;
   }
+  /**
+   * Collect the union of features across all per-target values.
+   * Used when `getFeatures()` is called without a target in object mode.
+   */
+  static collectAllFeatures(values) {
+    const allFeatures = [];
+    for (const value of values) {
+      if (!value) continue;
+      const normalized = _Config.normalizeTargetFeatures(value);
+      for (const feature of normalized) {
+        if (!allFeatures.includes(feature)) {
+          allFeatures.push(feature);
+        }
+      }
+      if (allFeatures.length === ALL_FEATURES.length) {
+        return allFeatures;
+      }
+    }
+    return allFeatures;
+  }
   /**
    * Returns the per-feature options object for a given target/feature, if any.
    * Returns `undefined` when no per-feature options were provided or when the
    * feature is not enabled for the given target.
    */
   getFeatureOptions(target, feature) {
-    if (Array.isArray(this.features)) {
+    const value = isRulesyncConfigTargetsObject(this.targets) ? this.targets[target] : !Array.isArray(this.features) ? this.features[target] : void 0;
+    if (!value || Array.isArray(value)) {
       return void 0;
     }
-    const targetFeatures = this.features[target];
-    if (!targetFeatures || Array.isArray(targetFeatures)) {
-      return void 0;
-    }
-    const perFeature = targetFeatures;
-    const value = perFeature[feature];
-    if (value && typeof value === "object" && isFeatureValueEnabled(value)) {
-      return value;
+    const perFeature = value;
+    const featureValue = perFeature[feature];
+    if (featureValue && typeof featureValue === "object" && isFeatureValueEnabled(featureValue)) {
+      return featureValue;
     }
     return void 0;
   }
@@ -509,6 +619,13 @@ var Config = class _Config {
    * Check if per-target features configuration is being used.
    */
   hasPerTargetFeatures() {
+    return isRulesyncConfigTargetsObject(this.targets) || !Array.isArray(this.features);
+  }
+  /**
+   * Returns true if the deprecated object form under `features` is in use.
+   * Callers can use this to emit a migration warning.
+   */
+  hasDeprecatedFeaturesObjectForm() {
     return !Array.isArray(this.features);
   }
   getVerbose() {
@@ -532,6 +649,9 @@ var Config = class _Config {
   getSimulateSkills() {
     return this.simulateSkills;
   }
+  getGitignoreTargetsOnly() {
+    return this.gitignoreTargetsOnly;
+  }
   getDryRun() {
     return this.dryRun;
   }
@@ -550,6 +670,17 @@ var Config = class _Config {
   }
 };
 
+// src/config/deprecation-warnings.ts
+var deprecationWarningEmitted = false;
+var emitFeaturesObjectFormDeprecationWarning = () => {
+  if (deprecationWarningEmitted) return;
+  if (process.env.RULESYNC_SILENT_DEPRECATION) return;
+  deprecationWarningEmitted = true;
+  console.warn(
+    "[rulesync] DEPRECATED: 'features' object form is deprecated. Use the new 'targets' object form instead: `targets: { claudecode: { rules: true, ignore: { fileMode: 'local' } } }`. See https://github.com/dyoshikawa/rulesync/blob/main/docs/guide/configuration.md for the migration guide."
+  );
+};
+
 // src/config/config-resolver.ts
 var getDefaults = () => ({
   targets: ["agentsmd"],
@@ -563,6 +694,7 @@ var getDefaults = () => ({
   simulateCommands: false,
   simulateSubagents: false,
   simulateSkills: false,
+  gitignoreTargetsOnly: true,
   dryRun: false,
   check: false,
   sources: []
@@ -575,6 +707,10 @@ var loadConfigFromFile = async (filePath) => {
   const jsonData = parseJsonc(fileContent);
   const parsed = ConfigFileSchema.parse(jsonData);
   const { $schema: _schema, ...configParams } = parsed;
+  assertTargetsFeaturesExclusive({
+    targets: configParams.targets,
+    features: configParams.features
+  });
   return configParams;
 };
 var mergeConfigs = (baseConfig, localConfig) => {
@@ -589,6 +725,7 @@ var mergeConfigs = (baseConfig, localConfig) => {
     simulateCommands: localConfig.simulateCommands ?? baseConfig.simulateCommands,
     simulateSubagents: localConfig.simulateSubagents ?? baseConfig.simulateSubagents,
     simulateSkills: localConfig.simulateSkills ?? baseConfig.simulateSkills,
+    gitignoreTargetsOnly: localConfig.gitignoreTargetsOnly ?? baseConfig.gitignoreTargetsOnly,
     dryRun: localConfig.dryRun ?? baseConfig.dryRun,
     check: localConfig.check ?? baseConfig.check,
     sources: localConfig.sources ?? baseConfig.sources
@@ -607,6 +744,7 @@ var ConfigResolver = class {
     simulateCommands,
     simulateSubagents,
     simulateSkills,
+    gitignoreTargetsOnly,
     dryRun,
     check
   }) {
@@ -616,13 +754,35 @@ var ConfigResolver = class {
     const localConfigPath = join3(configDir, RULESYNC_LOCAL_CONFIG_RELATIVE_FILE_PATH);
     const localConfig = await loadConfigFromFile(localConfigPath);
     const configByFile = mergeConfigs(baseConfig, localConfig);
+    try {
+      assertTargetsFeaturesExclusive({
+        targets: configByFile.targets,
+        features: configByFile.features
+      });
+    } catch (error) {
+      const detail = error instanceof Error ? error.message : String(error);
+      throw new Error(
+        `${detail} (detected after merging '${validatedConfigPath}' with '${localConfigPath}' \u2014 the two files combined produce the invalid combination; remove the conflicting field from one of them).`,
+        { cause: error }
+      );
+    }
     const resolvedGlobal = global ?? configByFile.global ?? getDefaults().global;
     const resolvedSimulateCommands = simulateCommands ?? configByFile.simulateCommands ?? getDefaults().simulateCommands;
     const resolvedSimulateSubagents = simulateSubagents ?? configByFile.simulateSubagents ?? getDefaults().simulateSubagents;
     const resolvedSimulateSkills = simulateSkills ?? configByFile.simulateSkills ?? getDefaults().simulateSkills;
+    const resolvedGitignoreTargetsOnly = gitignoreTargetsOnly ?? configByFile.gitignoreTargetsOnly ?? getDefaults().gitignoreTargetsOnly;
+    const userProvidedFeatures = features ?? configByFile.features;
+    const userProvidedTargets = targets ?? configByFile.targets;
+    const targetsIsObject = userProvidedTargets !== void 0 && !Array.isArray(userProvidedTargets);
+    const featuresIsObject = userProvidedFeatures !== void 0 && !Array.isArray(userProvidedFeatures);
+    if (featuresIsObject) {
+      emitFeaturesObjectFormDeprecationWarning();
+    }
+    const resolvedFeatures = userProvidedFeatures ?? (targetsIsObject ? void 0 : getDefaults().features);
+    const resolvedTargets = userProvidedTargets ?? (featuresIsObject ? void 0 : getDefaults().targets);
     const configParams = {
-      targets: targets ?? configByFile.targets ?? getDefaults().targets,
-      features: features ?? configByFile.features ?? getDefaults().features,
+      targets: resolvedTargets,
+      features: resolvedFeatures,
       verbose: verbose ?? configByFile.verbose ?? getDefaults().verbose,
       delete: isDelete ?? configByFile.delete ?? getDefaults().delete,
       baseDirs: getBaseDirsInLightOfGlobal({
@@ -634,6 +794,7 @@ var ConfigResolver = class {
       simulateCommands: resolvedSimulateCommands,
       simulateSubagents: resolvedSimulateSubagents,
       simulateSkills: resolvedSimulateSkills,
+      gitignoreTargetsOnly: resolvedGitignoreTargetsOnly,
       dryRun: dryRun ?? configByFile.dryRun ?? getDefaults().dryRun,
       check: check ?? configByFile.check ?? getDefaults().check,
       sources: configByFile.sources ?? getDefaults().sources
@@ -14799,12 +14960,16 @@ var CopilotSubagent = class _CopilotSubagent extends ToolSubagent {
     const body = rulesyncSubagent.getBody();
     const fileContent = stringifyFrontmatter(body, copilotFrontmatter);
     const paths = this.getSettablePaths({ global });
+    let relativeFilePath = rulesyncSubagent.getRelativeFilePath();
+    if (!relativeFilePath.endsWith(".agent.md")) {
+      relativeFilePath = relativeFilePath.replace(/\.md$/, ".agent.md");
+    }
     return new _CopilotSubagent({
       baseDir,
       frontmatter: copilotFrontmatter,
       body,
       relativeDirPath: paths.relativeDirPath,
-      relativeFilePath: rulesyncSubagent.getRelativeFilePath(),
+      relativeFilePath,
       fileContent,
       validate,
       global
@@ -19323,7 +19488,8 @@ var rulesProcessorToolTargets = [
 var RulesProcessorToolTargetSchema = z70.enum(rulesProcessorToolTargets);
 var formatRulePaths = (rules) => rules.map((r) => join135(r.getRelativeDirPath(), r.getRelativeFilePath())).join(", ");
 var RulesFeatureOptionsSchema = z70.looseObject({
-  ruleDiscoveryMode: z70.optional(z70.enum(["none", "explicit"]))
+  ruleDiscoveryMode: z70.optional(z70.enum(["none", "explicit"])),
+  includeLocalRoot: z70.optional(z70.boolean())
 });
 var resolveRuleDiscoveryMode = ({
   defaultMode,
@@ -19344,6 +19510,19 @@ var resolveRuleDiscoveryMode = ({
   }
   return parsed.data.ruleDiscoveryMode === "none" ? "auto" : "toon";
 };
+var IncludeLocalRootSchema = z70.looseObject({
+  includeLocalRoot: z70.optional(z70.boolean())
+});
+var resolveIncludeLocalRoot = (options) => {
+  if (!options) return true;
+  const parsed = IncludeLocalRootSchema.safeParse(options);
+  if (!parsed.success) {
+    throw new Error(
+      `Invalid options for rules feature: ${parsed.error.message}. \`includeLocalRoot\` must be a boolean.`
+    );
+  }
+  return parsed.data.includeLocalRoot ?? true;
+};
 var toolRuleFactories = /* @__PURE__ */ new Map([
   [
     "agentsmd",
@@ -19707,7 +19886,8 @@ var RulesProcessor = class extends FeatureProcessor {
         global: this.global
       });
     }).filter((rule) => rule !== null);
-    if (localRootRules.length > 0 && !this.global) {
+    const includeLocalRoot = resolveIncludeLocalRoot(this.featureOptions);
+    if (localRootRules.length > 0 && !this.global && includeLocalRoot) {
       const localRootRule = localRootRules[0];
       if (localRootRule && factory.class.isTargetedByRulesyncRule(localRootRule)) {
         this.handleLocalRootRule(toolRules, localRootRule, factory);
@@ -21123,6 +21303,7 @@ var JsonLogger = class extends BaseLogger {
 
 export {
   RULESYNC_CONFIG_RELATIVE_FILE_PATH,
+  RULESYNC_LOCAL_CONFIG_RELATIVE_FILE_PATH,
   RULESYNC_RELATIVE_DIR_PATH,
   RULESYNC_RULES_RELATIVE_DIR_PATH,
   RULESYNC_COMMANDS_RELATIVE_DIR_PATH,