@intellectronica/ruler 0.2.9 → 0.2.10

package/README.md

@@ -35,21 +35,21 @@ Ruler solves this by providing a **single source of truth** for all your AI agen
 
 ## Supported AI Agents
 
-| Agent            | File(s) Created/Updated                                       |
-| ---------------- | ------------------------------------------------------------- |
-| GitHub Copilot   | `.github/copilot-instructions.md`                             |
-| Claude Code      | `CLAUDE.md`                                                   |
-| OpenAI Codex CLI | `AGENTS.md`                                                   |
-| Jules            | `AGENTS.md`                                                   |
-| Cursor           | `.cursor/rules/ruler_cursor_instructions.mdc`                 |
-| Windsurf         | `.windsurf/rules/ruler_windsurf_instructions.md`              |
-| Cline            | `.clinerules`                                                 |
-| Aider            | `ruler_aider_instructions.md` and `.aider.conf.yml`           |
-| Firebase Studio  | `.idx/airules.md`                                             |
-| Open Hands       | `.openhands/microagents/repo.md` and `.openhands/config.toml` |
-| Gemini CLI       | `GEMINI.md` and `.gemini/settings.json`                       |
-| Junie            | `.junie/guidelines.md`                                        |
-| AugmentCode      | `.augment-guidelines` and `.augmentcode/config.json`         |
+| Agent            | Rules File(s)                                    | MCP Configuration                                |
+| ---------------- | ------------------------------------------------ | ------------------------------------------------ |
+| GitHub Copilot   | `.github/copilot-instructions.md`                | `.vscode/mcp.json`                               |
+| Claude Code      | `CLAUDE.md`                                      | `claude_desktop_config.json`                     |
+| OpenAI Codex CLI | `AGENTS.md`                                      | `~/.codex/config.json`                           |
+| Jules            | `AGENTS.md`                                      | -                                                |
+| Cursor           | `.cursor/rules/ruler_cursor_instructions.mdc`    | `.cursor/mcp.json`, `~/.cursor/mcp.json`         |
+| Windsurf         | `.windsurf/rules/ruler_windsurf_instructions.md` | `~/.codeium/windsurf/mcp_config.json`            |
+| Cline            | `.clinerules`                                    | -                                                |
+| Aider            | `ruler_aider_instructions.md`, `.aider.conf.yml` | `.mcp.json`                                      |
+| Firebase Studio  | `.idx/airules.md`                                | -                                                |
+| Open Hands       | `.openhands/microagents/repo.md`                 | `.openhands/config.toml`                         |
+| Gemini CLI       | `GEMINI.md`                                      | `.gemini/settings.json`                          |
+| Junie            | `.junie/guidelines.md`                           | -                                                |
+| AugmentCode      | `.augment/rules/ruler_augment_instructions.md`   | `.vscode/settings.json`                          |
 
 ## Getting Started
 

package/dist/agents/AugmentCodeAgent.js

@@ -35,12 +35,11 @@ var __importStar = (this && this.__importStar) || (function () {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.AugmentCodeAgent = void 0;
 const path = __importStar(require("path"));
-const fs_1 = require("fs");
 const FileSystemUtils_1 = require("../core/FileSystemUtils");
-const merge_1 = require("../mcp/merge");
+const settings_1 = require("../vscode/settings");
 /**
  * AugmentCode agent adapter.
- * Generates .augment-guidelines configuration file and supports MCP server configuration.
+ * Generates ruler_augment_instructions.md configuration file and updates VSCode settings.json with MCP server configuration.
  */
 class AugmentCodeAgent {
     getIdentifier() {
@@ -53,26 +52,17 @@ class AugmentCodeAgent {
         const output = agentConfig?.outputPath ?? this.getDefaultOutputPath(projectRoot);
         await (0, FileSystemUtils_1.backupFile)(output);
         await (0, FileSystemUtils_1.writeGeneratedFile)(output, concatenatedRules);
-        // Handle MCP configuration if provided
         if (rulerMcpJson) {
-            const configPath = path.join(projectRoot, '.augmentcode', 'config.json');
-            let existingConfig = {};
-            try {
-                const existingConfigRaw = await fs_1.promises.readFile(configPath, 'utf8');
-                existingConfig = JSON.parse(existingConfigRaw);
-            }
-            catch (error) {
-                if (error.code !== 'ENOENT') {
-                    throw error;
-                }
-            }
-            const merged = (0, merge_1.mergeMcp)(existingConfig, rulerMcpJson, agentConfig?.mcp?.strategy ?? 'merge', this.getMcpServerKey());
-            await fs_1.promises.mkdir(path.dirname(configPath), { recursive: true });
-            await fs_1.promises.writeFile(configPath, JSON.stringify(merged, null, 2));
+            const settingsPath = (0, settings_1.getVSCodeSettingsPath)(projectRoot);
+            await (0, FileSystemUtils_1.backupFile)(settingsPath);
+            const existingSettings = await (0, settings_1.readVSCodeSettings)(settingsPath);
+            const augmentServers = (0, settings_1.transformRulerToAugmentMcp)(rulerMcpJson);
+            const mergedSettings = (0, settings_1.mergeAugmentMcpServers)(existingSettings, augmentServers, agentConfig?.mcp?.strategy ?? 'merge');
+            await (0, settings_1.writeVSCodeSettings)(settingsPath, mergedSettings);
         }
     }
     getDefaultOutputPath(projectRoot) {
-        return path.join(projectRoot, '.augment-guidelines');
+        return path.join(projectRoot, '.augment', 'rules', 'ruler_augment_instructions.md');
     }
     getMcpServerKey() {
         return 'mcpServers';

package/dist/lib.js

@@ -217,7 +217,21 @@ async function applyAllAgentConfigs(projectRoot, includedAgents, configPath, cli
                 }
                 agentsMdWritten = true;
             }
-            await agent.applyRulerConfig(concatenated, projectRoot, rulerMcpJson, agentConfig);
+            let finalAgentConfig = agentConfig;
+            if (agent.getIdentifier() === 'augmentcode' && rulerMcpJson) {
+                const resolvedStrategy = cliMcpStrategy ??
+                    agentConfig?.mcp?.strategy ??
+                    config.mcp?.strategy ??
+                    'merge';
+                finalAgentConfig = {
+                    ...agentConfig,
+                    mcp: {
+                        ...agentConfig?.mcp,
+                        strategy: resolvedStrategy,
+                    },
+                };
+            }
+            await agent.applyRulerConfig(concatenated, projectRoot, rulerMcpJson, finalAgentConfig);
         }
         const dest = await (0, mcp_1.getNativeMcpPath)(agent.getName(), projectRoot);
         const mcpEnabledForAgent = cliMcpEnabled &&
@@ -241,6 +255,14 @@ async function applyAllAgentConfigs(projectRoot, includedAgents, configPath, cli
                 }
                 // Open Hands config file is already included above
             }
+            else if (agent.getIdentifier() === 'augmentcode') {
+                // *** Special handling for AugmentCode ***
+                // AugmentCode handles MCP configuration internally in applyRulerConfig
+                // by updating VSCode settings.json with augment.advanced.mcpServers format
+                if (dryRun) {
+                    (0, constants_1.logVerbose)(`DRY RUN: AugmentCode MCP config handled internally via VSCode settings`, verbose);
+                }
+            }
             else {
                 if (rulerMcpJson) {
                     const strategy = cliMcpStrategy ??

package/dist/paths/mcp.js

@@ -75,8 +75,7 @@ async function getNativeMcpPath(adapterName, projectRoot) {
             candidates.push(path.join(projectRoot, '.gemini', 'settings.json'));
             break;
         case 'AugmentCode':
-            candidates.push(path.join(projectRoot, '.augmentcode', 'config.json'));
-            candidates.push(path.join(home, '.augmentcode', 'config.json'));
+            candidates.push(path.join(projectRoot, '.vscode', 'settings.json'));
             break;
         default:
             return null;

package/dist/revert.js

@@ -50,8 +50,10 @@ const OpenHandsAgent_1 = require("./agents/OpenHandsAgent");
 const GeminiCliAgent_1 = require("./agents/GeminiCliAgent");
 const JulesAgent_1 = require("./agents/JulesAgent");
 const JunieAgent_1 = require("./agents/JunieAgent");
+const AugmentCodeAgent_1 = require("./agents/AugmentCodeAgent");
 const mcp_1 = require("./paths/mcp");
 const constants_1 = require("./constants");
+const settings_1 = require("./vscode/settings");
 const agents = [
     new CopilotAgent_1.CopilotAgent(),
     new ClaudeAgent_1.ClaudeAgent(),
@@ -65,6 +67,7 @@ const agents = [
     new GeminiCliAgent_1.GeminiCliAgent(),
     new JulesAgent_1.JulesAgent(),
     new JunieAgent_1.JunieAgent(),
+    new AugmentCodeAgent_1.AugmentCodeAgent(),
 ];
 /**
  * Gets all output paths for an agent, taking into account any config overrides.
@@ -170,9 +173,101 @@ async function removeBackupFile(filePath, verbose, dryRun) {
     }
     return true;
 }
+/**
+ * Recursively checks if a directory contains only empty directories
+ */
+async function isDirectoryTreeEmpty(dirPath) {
+    try {
+        const entries = await fs_1.promises.readdir(dirPath);
+        if (entries.length === 0) {
+            return true;
+        }
+        for (const entry of entries) {
+            const entryPath = path.join(dirPath, entry);
+            const entryStat = await fs_1.promises.stat(entryPath);
+            if (entryStat.isFile()) {
+                return false;
+            }
+            else if (entryStat.isDirectory()) {
+                const isEmpty = await isDirectoryTreeEmpty(entryPath);
+                if (!isEmpty) {
+                    return false;
+                }
+            }
+        }
+        return true;
+    }
+    catch {
+        return false;
+    }
+}
+/**
+ * Helper function to execute directory removal with consistent dry-run handling and logging.
+ */
+async function executeDirectoryAction(dirPath, action, verbose, dryRun) {
+    const actionPrefix = dryRun ? '[ruler:dry-run]' : '[ruler]';
+    const actionText = action === 'remove-tree' ? 'directory tree' : 'directory';
+    if (dryRun) {
+        (0, constants_1.logVerbose)(`${actionPrefix} Would remove empty ${actionText}: ${dirPath}`, verbose);
+    }
+    else {
+        await fs_1.promises.rm(dirPath, { recursive: true });
+        (0, constants_1.logVerbose)(`${actionPrefix} Removed empty ${actionText}: ${dirPath}`, verbose);
+    }
+    return true;
+}
+/**
+ * Attempts to remove a single empty directory if it exists and is empty.
+ */
+async function removeEmptyDirectory(dirPath, verbose, dryRun, logMissing = false) {
+    try {
+        const stat = await fs_1.promises.stat(dirPath);
+        if (!stat.isDirectory()) {
+            return false;
+        }
+        const isEmpty = await isDirectoryTreeEmpty(dirPath);
+        if (isEmpty) {
+            return await executeDirectoryAction(dirPath, 'remove-tree', verbose, dryRun);
+        }
+        return false;
+    }
+    catch {
+        if (logMissing) {
+            (0, constants_1.logVerbose)(`Directory ${dirPath} doesn't exist or can't be accessed`, verbose);
+        }
+        return false;
+    }
+}
+/**
+ * Handles special cleanup logic for .augment directory and its rules subdirectory.
+ */
+async function removeAugmentDirectory(projectRoot, verbose, dryRun) {
+    const augmentDir = path.join(projectRoot, '.augment');
+    let directoriesRemoved = 0;
+    try {
+        const augmentStat = await fs_1.promises.stat(augmentDir);
+        if (!augmentStat.isDirectory()) {
+            return 0;
+        }
+        const rulesDir = path.join(augmentDir, 'rules');
+        const rulesRemoved = await removeEmptyDirectory(rulesDir, verbose, dryRun);
+        if (rulesRemoved) {
+            directoriesRemoved++;
+        }
+        const augmentRemoved = await removeEmptyDirectory(augmentDir, verbose, dryRun);
+        if (augmentRemoved) {
+            directoriesRemoved++;
+        }
+    }
+    catch {
+        // .augment directory doesn't exist, that's fine. leaving comment as catch block can't be kept empty.
+    }
+    return directoriesRemoved;
+}
 /**
  * Removes empty directories that were created by ruler.
  * Only removes directories if they are empty and were likely created by ruler.
+ * Special handling for .augment directory to clean up rules subdirectory.
  */
 async function removeEmptyDirectories(projectRoot, verbose, dryRun) {
     const rulerCreatedDirs = [
@@ -184,58 +279,17 @@ async function removeEmptyDirectories(projectRoot, verbose, dryRun) {
         '.idx',
         '.gemini',
         '.vscode',
+        '.augmentcode',
     ];
     let directoriesRemoved = 0;
-    const actionPrefix = dryRun ? '[ruler:dry-run]' : '[ruler]';
+    // Handle .augment directory with special logic
+    directoriesRemoved += await removeAugmentDirectory(projectRoot, verbose, dryRun);
+    // Handle all other ruler-created directories
     for (const dirName of rulerCreatedDirs) {
         const dirPath = path.join(projectRoot, dirName);
-        try {
-            const stat = await fs_1.promises.stat(dirPath);
-            if (!stat.isDirectory()) {
-                continue;
-            }
-            const entries = await fs_1.promises.readdir(dirPath);
-            if (entries.length === 0) {
-                if (dryRun) {
-                    (0, constants_1.logVerbose)(`${actionPrefix} Would remove empty directory: ${dirPath}`, verbose);
-                }
-                else {
-                    await fs_1.promises.rmdir(dirPath);
-                    (0, constants_1.logVerbose)(`${actionPrefix} Removed empty directory: ${dirPath}`, verbose);
-                }
-                directoriesRemoved++;
-            }
-            else {
-                let hasNonEmptyContent = false;
-                for (const entry of entries) {
-                    const entryPath = path.join(dirPath, entry);
-                    const entryStat = await fs_1.promises.stat(entryPath);
-                    if (entryStat.isFile()) {
-                        hasNonEmptyContent = true;
-                        break;
-                    }
-                    else if (entryStat.isDirectory()) {
-                        const subEntries = await fs_1.promises.readdir(entryPath);
-                        if (subEntries.length > 0) {
-                            hasNonEmptyContent = true;
-                            break;
-                        }
-                    }
-                }
-                if (!hasNonEmptyContent) {
-                    if (dryRun) {
-                        (0, constants_1.logVerbose)(`${actionPrefix} Would remove directory tree: ${dirPath}`, verbose);
-                    }
-                    else {
-                        await fs_1.promises.rm(dirPath, { recursive: true });
-                        (0, constants_1.logVerbose)(`${actionPrefix} Removed directory tree: ${dirPath}`, verbose);
-                    }
-                    directoriesRemoved++;
-                }
-            }
-        }
-        catch {
-            (0, constants_1.logVerbose)(`Directory ${dirPath} doesn't exist or can't be accessed`, verbose);
+        const removed = await removeEmptyDirectory(dirPath, verbose, dryRun, true);
+        if (removed) {
+            directoriesRemoved++;
         }
     }
     return directoriesRemoved;
@@ -283,6 +337,55 @@ async function removeAdditionalAgentFiles(projectRoot, verbose, dryRun) {
             (0, constants_1.logVerbose)(`Additional file ${fullPath} doesn't exist or can't be accessed`, verbose);
         }
     }
+    const settingsPath = (0, settings_1.getVSCodeSettingsPath)(projectRoot);
+    const backupPath = `${settingsPath}.bak`;
+    if (await fileExists(backupPath)) {
+        const restored = await restoreFromBackup(settingsPath, verbose, dryRun);
+        if (restored) {
+            filesRemoved++;
+            (0, constants_1.logVerbose)(`${actionPrefix} Restored VSCode settings from backup`, verbose);
+        }
+    }
+    else if (await fileExists(settingsPath)) {
+        try {
+            if (dryRun) {
+                const settings = await (0, settings_1.readVSCodeSettings)(settingsPath);
+                if (settings['augment.advanced']) {
+                    delete settings['augment.advanced'];
+                    const remainingKeys = Object.keys(settings);
+                    if (remainingKeys.length === 0) {
+                        (0, constants_1.logVerbose)(`${actionPrefix} Would remove empty VSCode settings file`, verbose);
+                    }
+                    else {
+                        (0, constants_1.logVerbose)(`${actionPrefix} Would remove augment.advanced section from ${settingsPath}`, verbose);
+                    }
+                    filesRemoved++;
+                }
+            }
+            else {
+                const settings = await (0, settings_1.readVSCodeSettings)(settingsPath);
+                if (settings['augment.advanced']) {
+                    delete settings['augment.advanced'];
+                    const remainingKeys = Object.keys(settings);
+                    if (remainingKeys.length === 0) {
+                        await fs_1.promises.unlink(settingsPath);
+                        (0, constants_1.logVerbose)(`${actionPrefix} Removed empty VSCode settings file`, verbose);
+                    }
+                    else {
+                        await (0, settings_1.writeVSCodeSettings)(settingsPath, settings);
+                        (0, constants_1.logVerbose)(`${actionPrefix} Removed augment.advanced section from VSCode settings`, verbose);
+                    }
+                    filesRemoved++;
+                }
+                else {
+                    (0, constants_1.logVerbose)(`No augment.advanced section found in ${settingsPath}`, verbose);
+                }
+            }
+        }
+        catch (error) {
+            (0, constants_1.logVerbose)(`Failed to process VSCode settings.json: ${error}`, verbose);
+        }
+    }
     return filesRemoved;
 }
 /**
@@ -407,20 +510,26 @@ async function revertAllAgentConfigs(projectRoot, includedAgents, configPath, ke
         const mcpPath = await (0, mcp_1.getNativeMcpPath)(agent.getName(), projectRoot);
         if (mcpPath && mcpPath.startsWith(projectRoot)) {
             totalFilesProcessed++;
-            const mcpRestored = await restoreFromBackup(mcpPath, verbose, dryRun);
-            if (mcpRestored) {
-                totalFilesRestored++;
-                if (!keepBackups) {
-                    const mcpBackupRemoved = await removeBackupFile(mcpPath, verbose, dryRun);
-                    if (mcpBackupRemoved) {
-                        totalBackupsRemoved++;
-                    }
-                }
+            if (agent.getName() === 'AugmentCode' &&
+                mcpPath.endsWith('.vscode/settings.json')) {
+                (0, constants_1.logVerbose)(`Skipping MCP handling for AugmentCode settings.json - handled separately`, verbose);
             }
             else {
-                const mcpRemoved = await removeGeneratedFile(mcpPath, verbose, dryRun);
-                if (mcpRemoved) {
-                    totalFilesRemoved++;
+                const mcpRestored = await restoreFromBackup(mcpPath, verbose, dryRun);
+                if (mcpRestored) {
+                    totalFilesRestored++;
+                    if (!keepBackups) {
+                        const mcpBackupRemoved = await removeBackupFile(mcpPath, verbose, dryRun);
+                        if (mcpBackupRemoved) {
+                            totalBackupsRemoved++;
+                        }
+                    }
+                }
+                else {
+                    const mcpRemoved = await removeGeneratedFile(mcpPath, verbose, dryRun);
+                    if (mcpRemoved) {
+                        totalFilesRemoved++;
+                    }
                 }
             }
         }

package/dist/vscode/settings.js

@@ -0,0 +1,117 @@
+"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.readVSCodeSettings = readVSCodeSettings;
+exports.writeVSCodeSettings = writeVSCodeSettings;
+exports.transformRulerToAugmentMcp = transformRulerToAugmentMcp;
+exports.mergeAugmentMcpServers = mergeAugmentMcpServers;
+exports.getVSCodeSettingsPath = getVSCodeSettingsPath;
+const fs_1 = require("fs");
+const path = __importStar(require("path"));
+/**
+ * Read VSCode settings.json file
+ */
+async function readVSCodeSettings(settingsPath) {
+    try {
+        const content = await fs_1.promises.readFile(settingsPath, 'utf8');
+        return JSON.parse(content);
+    }
+    catch (error) {
+        if (error.code === 'ENOENT') {
+            return {};
+        }
+        throw error;
+    }
+}
+/**
+ * Write VSCode settings.json file
+ */
+async function writeVSCodeSettings(settingsPath, settings) {
+    await fs_1.promises.mkdir(path.dirname(settingsPath), { recursive: true });
+    await fs_1.promises.writeFile(settingsPath, JSON.stringify(settings, null, 4));
+}
+/**
+ * Transform ruler MCP config to Augment MCP server array format
+ */
+function transformRulerToAugmentMcp(rulerMcpJson) {
+    const servers = [];
+    if (rulerMcpJson.mcpServers && typeof rulerMcpJson.mcpServers === 'object') {
+        const mcpServers = rulerMcpJson.mcpServers;
+        for (const [name, serverConfig] of Object.entries(mcpServers)) {
+            const augmentServer = {
+                name,
+                command: serverConfig.command,
+            };
+            if (serverConfig.args) {
+                augmentServer.args = serverConfig.args;
+            }
+            if (serverConfig.env) {
+                augmentServer.env = serverConfig.env;
+            }
+            servers.push(augmentServer);
+        }
+    }
+    return servers;
+}
+/**
+ * Merge MCP servers into VSCode settings using the specified strategy
+ */
+function mergeAugmentMcpServers(existingSettings, newServers, strategy) {
+    const result = structuredClone(existingSettings);
+    if (!result['augment.advanced']) {
+        result['augment.advanced'] = {};
+    }
+    if (strategy === 'overwrite') {
+        result['augment.advanced'].mcpServers = newServers;
+    }
+    else {
+        const existingServers = result['augment.advanced'].mcpServers || [];
+        const existingServerMap = new Map();
+        for (const server of existingServers) {
+            existingServerMap.set(server.name, server);
+        }
+        for (const newServer of newServers) {
+            existingServerMap.set(newServer.name, newServer);
+        }
+        result['augment.advanced'].mcpServers = Array.from(existingServerMap.values());
+    }
+    return result;
+}
+/**
+ * Get the VSCode settings.json path for a project (local)
+ */
+function getVSCodeSettingsPath(projectRoot) {
+    return path.join(projectRoot, '.vscode', 'settings.json');
+}

package/package.json

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