@intellectronica/ruler 0.3.3 → 0.3.5

package/README.md

@@ -65,6 +65,7 @@ Ruler solves this by providing a **single source of truth** for all your AI agen
 | Windsurf         | `.windsurf/rules/ruler_windsurf_instructions.md` | -                                                |
 | Cline            | `.clinerules`                                    | -                                                |
 | Amp              | `AGENTS.md`                                      | -                                                |
+| Amazon Q CLI     | `.amazonq/rules/ruler_q_rules.md`                | `.amazonq/mcp.json`                              |
 | Aider            | `AGENTS.md`, `.aider.conf.yml`                   | `.mcp.json`                                      |
 | Firebase Studio  | `.idx/airules.md`                                | -                                                |
 | Open Hands       | `.openhands/microagents/repo.md`                 | `.openhands/config.toml`                         |

package/dist/agents/AmazonQCliAgent.js

@@ -0,0 +1,103 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AmazonQCliAgent = void 0;
+const path = __importStar(require("path"));
+const fs_1 = require("fs");
+const FileSystemUtils_1 = require("../core/FileSystemUtils");
+const merge_1 = require("../mcp/merge");
+/**
+ * Amazon Q CLI agent adapter.
+ */
+class AmazonQCliAgent {
+    getIdentifier() {
+        return 'amazonqcli';
+    }
+    getName() {
+        return 'Amazon Q CLI';
+    }
+    async applyRulerConfig(concatenatedRules, projectRoot, rulerMcpJson, agentConfig, backup = true) {
+        const outputPaths = this.getDefaultOutputPath(projectRoot);
+        const rulesPath = path.resolve(projectRoot, agentConfig?.outputPath ||
+            agentConfig?.outputPathInstructions ||
+            outputPaths['instructions']);
+        // Write rules file to .amazonq/rules/
+        await (0, FileSystemUtils_1.ensureDirExists)(path.dirname(rulesPath));
+        if (backup) {
+            await (0, FileSystemUtils_1.backupFile)(rulesPath);
+        }
+        await (0, FileSystemUtils_1.writeGeneratedFile)(rulesPath, concatenatedRules);
+        // Handle MCP configuration if enabled and provided
+        const mcpEnabled = agentConfig?.mcp?.enabled ?? true;
+        if (mcpEnabled && rulerMcpJson) {
+            const mcpPath = path.resolve(projectRoot, agentConfig?.outputPathConfig ?? outputPaths['mcp']);
+            const mcpStrategy = agentConfig?.mcp?.strategy ?? 'merge';
+            await (0, FileSystemUtils_1.ensureDirExists)(path.dirname(mcpPath));
+            let existingMcpConfig = {};
+            try {
+                const raw = await fs_1.promises.readFile(mcpPath, 'utf8');
+                existingMcpConfig = JSON.parse(raw);
+            }
+            catch (err) {
+                if (err.code !== 'ENOENT') {
+                    throw err;
+                }
+                // File doesn't exist, start with empty config
+            }
+            // Merge the MCP configurations using the standard merge function
+            const mergedConfig = (0, merge_1.mergeMcp)(existingMcpConfig, rulerMcpJson, mcpStrategy, 'mcpServers');
+            if (backup) {
+                await (0, FileSystemUtils_1.backupFile)(mcpPath);
+            }
+            await (0, FileSystemUtils_1.writeGeneratedFile)(mcpPath, JSON.stringify(mergedConfig, null, 2));
+        }
+    }
+    getDefaultOutputPath(projectRoot) {
+        return {
+            instructions: path.join(projectRoot, '.amazonq', 'rules', 'ruler_q_rules.md'),
+            mcp: path.join(projectRoot, '.amazonq', 'mcp.json'),
+        };
+    }
+    getMcpServerKey() {
+        return 'mcpServers';
+    }
+    supportsMcpStdio() {
+        return true;
+    }
+    supportsMcpRemote() {
+        return true;
+    }
+}
+exports.AmazonQCliAgent = AmazonQCliAgent;

package/dist/agents/CodexCliAgent.js

@@ -44,26 +44,26 @@ const constants_1 = require("../constants");
 /**
  * OpenAI Codex CLI agent adapter.
  */
-class CodexCliAgent extends AgentsMdAgent_1.AgentsMdAgent {
+class CodexCliAgent {
+    constructor() {
+        this.agentsMdAgent = new AgentsMdAgent_1.AgentsMdAgent();
+    }
     getIdentifier() {
         return 'codex';
     }
     getName() {
         return 'OpenAI Codex CLI';
     }
-    async applyRulerConfig(concatenatedRules, projectRoot, rulerMcpJson, agentConfig) {
-        // First perform idempotent AGENTS.md write via base class (instructions file).
-        await super.applyRulerConfig(concatenatedRules, projectRoot, null, {
+    async applyRulerConfig(concatenatedRules, projectRoot, rulerMcpJson, agentConfig, backup = true) {
+        // First perform idempotent AGENTS.md write via composed AgentsMdAgent
+        await this.agentsMdAgent.applyRulerConfig(concatenatedRules, projectRoot, null, {
             // Preserve explicit outputPath precedence semantics if provided.
             outputPath: agentConfig?.outputPath ||
                 agentConfig?.outputPathInstructions ||
                 undefined,
-        });
-        // Resolve config path helper (mirrors previous logic)
-        const defaults = {
-            instructions: path.join(projectRoot, constants_1.DEFAULT_RULES_FILENAME),
-            config: path.join(projectRoot, '.codex', 'config.toml'),
-        };
+        }, backup);
+        // Use proper path resolution from getDefaultOutputPath and agentConfig
+        const defaults = this.getDefaultOutputPath(projectRoot);
         const mcpEnabled = agentConfig?.mcp?.enabled ?? true;
         if (mcpEnabled && rulerMcpJson) {
             // Apply MCP server filtering and transformation
@@ -73,7 +73,7 @@ class CodexCliAgent extends AgentsMdAgent_1.AgentsMdAgent {
                 return; // No compatible servers found
             }
             const filteredRulerMcpJson = filteredMcpConfig;
-            // Determine the config file path
+            // Determine the config file path using proper precedence
             const configPath = agentConfig?.outputPathConfig ?? defaults.config;
             // Ensure the parent directory exists
             await fs_1.promises.mkdir(path.dirname(configPath), { recursive: true });
@@ -177,6 +177,12 @@ class CodexCliAgent extends AgentsMdAgent_1.AgentsMdAgent {
             await (0, FileSystemUtils_1.writeGeneratedFile)(configPath, tomlContent);
         }
     }
+    getDefaultOutputPath(projectRoot) {
+        return {
+            instructions: path.join(projectRoot, constants_1.DEFAULT_RULES_FILENAME),
+            config: path.join(projectRoot, '.codex', 'config.toml'),
+        };
+    }
     supportsMcpStdio() {
         return true;
     }

package/dist/agents/CopilotAgent.js

@@ -1,54 +1,17 @@
 "use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
-    Object.defineProperty(o, "default", { enumerable: true, value: v });
-}) : function(o, v) {
-    o["default"] = v;
-});
-var __importStar = (this && this.__importStar) || (function () {
-    var ownKeys = function(o) {
-        ownKeys = Object.getOwnPropertyNames || function (o) {
-            var ar = [];
-            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
-            return ar;
-        };
-        return ownKeys(o);
-    };
-    return function (mod) {
-        if (mod && mod.__esModule) return mod;
-        var result = {};
-        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
-        __setModuleDefault(result, mod);
-        return result;
-    };
-})();
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.CopilotAgent = void 0;
-const path = __importStar(require("path"));
-const AbstractAgent_1 = require("./AbstractAgent");
+const AgentsMdAgent_1 = require("./AgentsMdAgent");
 /**
  * GitHub Copilot agent adapter.
  */
-class CopilotAgent extends AbstractAgent_1.AbstractAgent {
+class CopilotAgent extends AgentsMdAgent_1.AgentsMdAgent {
     getIdentifier() {
         return 'copilot';
     }
     getName() {
         return 'GitHub Copilot';
     }
-    getDefaultOutputPath(projectRoot) {
-        return path.join(projectRoot, '.github', 'copilot-instructions.md');
-    }
     getMcpServerKey() {
         return 'servers';
     }

package/dist/agents/TraeAgent.js

@@ -0,0 +1,54 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TraeAgent = void 0;
+const path = __importStar(require("path"));
+const AbstractAgent_1 = require("./AbstractAgent");
+/**
+ * Trae AI agent adapter.
+ * Generates project_rules.md configuration file.
+ */
+class TraeAgent extends AbstractAgent_1.AbstractAgent {
+    getIdentifier() {
+        return 'trae';
+    }
+    getName() {
+        return 'Trae AI';
+    }
+    getDefaultOutputPath(projectRoot) {
+        return path.join(projectRoot, '.trae', 'rules', 'project_rules.md');
+    }
+}
+exports.TraeAgent = TraeAgent;

package/dist/agents/index.js

@@ -27,6 +27,8 @@ const QwenCodeAgent_1 = require("./QwenCodeAgent");
 const KiroAgent_1 = require("./KiroAgent");
 const WarpAgent_1 = require("./WarpAgent");
 const RooCodeAgent_1 = require("./RooCodeAgent");
+const TraeAgent_1 = require("./TraeAgent");
+const AmazonQCliAgent_1 = require("./AmazonQCliAgent");
 exports.allAgents = [
     new CopilotAgent_1.CopilotAgent(),
     new ClaudeAgent_1.ClaudeAgent(),
@@ -52,4 +54,6 @@ exports.allAgents = [
     new KiroAgent_1.KiroAgent(),
     new WarpAgent_1.WarpAgent(),
     new RooCodeAgent_1.RooCodeAgent(),
+    new TraeAgent_1.TraeAgent(),
+    new AmazonQCliAgent_1.AmazonQCliAgent(),
 ];

package/dist/core/GitignoreUtils.js

@@ -57,8 +57,9 @@ async function updateGitignore(projectRoot, paths) {
             throw err;
         }
     }
-    // Convert paths to relative POSIX format
-    const relativePaths = paths.map((p) => {
+    // Convert paths to repo-relative POSIX format with leading /
+    const relativePaths = paths
+        .map((p) => {
         let relative;
         if (path.isAbsolute(p)) {
             relative = path.relative(projectRoot, p);
@@ -78,6 +79,14 @@ async function updateGitignore(projectRoot, paths) {
             }
         }
         return relative.replace(/\\/g, '/'); // Convert to POSIX format
+    })
+        .filter((p) => {
+        // Never include any path that resides inside a .ruler directory (inputs, not outputs)
+        return !p.includes('/.ruler/') && !p.startsWith('.ruler/');
+    })
+        .map((p) => {
+        // Always write full repository-relative paths (prefix with leading /)
+        return p.startsWith('/') ? p : `/${p}`;
     });
     // Get all existing paths from .gitignore (excluding Ruler block)
     const existingPaths = getExistingPathsExcludingRulerBlock(existingContent);

package/dist/core/apply-engine.js

@@ -402,7 +402,7 @@ async function applyStandardMcpConfiguration(agent, filteredMcpJson, dest, agent
  * @param cliGitignoreEnabled CLI gitignore setting
  * @param dryRun Whether to perform a dry run
  */
-async function updateGitignore(projectRoot, generatedPaths, config, cliGitignoreEnabled, dryRun, backup = true) {
+async function updateGitignore(projectRoot, generatedPaths, config, cliGitignoreEnabled, dryRun) {
     // Configuration precedence: CLI > TOML > Default (enabled)
     let gitignoreEnabled;
     if (cliGitignoreEnabled !== undefined) {
@@ -416,10 +416,8 @@ async function updateGitignore(projectRoot, generatedPaths, config, cliGitignore
     }
     if (gitignoreEnabled && generatedPaths.length > 0) {
         const uniquePaths = [...new Set(generatedPaths)];
-        // Add wildcard pattern for backup files only if backup is enabled
-        if (backup) {
-            uniquePaths.push('*.bak');
-        }
+        // Note: Individual backup patterns are added per-file in the collection phase
+        // No need to add a broad *.bak pattern here
         if (uniquePaths.length > 0) {
             const prefix = (0, constants_1.actionPrefix)(dryRun);
             if (dryRun) {

package/dist/lib.js

@@ -53,7 +53,7 @@ async function applyAllAgentConfigs(projectRoot, includedAgents, configPath, cli
         (0, constants_1.logVerbose)(`Selected ${selectedAgents.length} agents: ${selectedAgents.map((a) => a.getName()).join(', ')}`, verbose);
         generatedPaths = await (0, apply_engine_1.processSingleConfiguration)(selectedAgents, singleConfig, projectRoot, verbose, dryRun, cliMcpEnabled, cliMcpStrategy, backup);
     }
-    await (0, apply_engine_1.updateGitignore)(projectRoot, generatedPaths, loadedConfig, cliGitignoreEnabled, dryRun, backup);
+    await (0, apply_engine_1.updateGitignore)(projectRoot, generatedPaths, loadedConfig, cliGitignoreEnabled, dryRun);
 }
 /**
  * Normalizes per-agent config keys to agent identifiers for consistent lookup.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@intellectronica/ruler",
-  "version": "0.3.3",
+  "version": "0.3.5",
   "description": "Ruler — apply the same rules to all coding agents",
   "main": "dist/lib.js",
   "scripts": {