@intellectronica/ruler 0.2.19 → 0.3.0

package/dist/core/apply-engine.js

@@ -0,0 +1,302 @@
+"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.loadRulerConfiguration = loadRulerConfiguration;
+exports.selectAgentsToRun = selectAgentsToRun;
+exports.applyConfigurationsToAgents = applyConfigurationsToAgents;
+exports.updateGitignore = updateGitignore;
+const path = __importStar(require("path"));
+const FileSystemUtils = __importStar(require("./FileSystemUtils"));
+const RuleProcessor_1 = require("./RuleProcessor");
+const ConfigLoader_1 = require("./ConfigLoader");
+const GitignoreUtils_1 = require("./GitignoreUtils");
+const merge_1 = require("../mcp/merge");
+const mcp_1 = require("../paths/mcp");
+const propagateOpenHandsMcp_1 = require("../mcp/propagateOpenHandsMcp");
+const propagateOpenCodeMcp_1 = require("../mcp/propagateOpenCodeMcp");
+const agent_utils_1 = require("../agents/agent-utils");
+const capabilities_1 = require("../mcp/capabilities");
+const constants_1 = require("../constants");
+/**
+ * Loads all necessary configurations for ruler operation.
+ * @param projectRoot Root directory of the project
+ * @param configPath Optional custom config path
+ * @param localOnly Whether to search only locally for .ruler directory
+ * @returns Promise resolving to the loaded configuration
+ */
+async function loadRulerConfiguration(projectRoot, configPath, localOnly) {
+    // Find the .ruler directory
+    const rulerDir = await FileSystemUtils.findRulerDir(projectRoot, !localOnly);
+    if (!rulerDir) {
+        throw (0, constants_1.createRulerError)(`.ruler directory not found`, `Searched from: ${projectRoot}`);
+    }
+    // Load the ruler.toml configuration
+    const config = await (0, ConfigLoader_1.loadConfig)({
+        projectRoot,
+        configPath,
+    });
+    // Read and concatenate the markdown rule files
+    const files = await FileSystemUtils.readMarkdownFiles(rulerDir);
+    const concatenatedRules = (0, RuleProcessor_1.concatenateRules)(files, path.dirname(rulerDir));
+    // Load unified config to get merged MCP configuration
+    const { loadUnifiedConfig } = await Promise.resolve().then(() => __importStar(require('./UnifiedConfigLoader')));
+    const unifiedConfig = await loadUnifiedConfig({ projectRoot, configPath });
+    // Synthesize rulerMcpJson from unified MCP bundle for backward compatibility
+    let rulerMcpJson = null;
+    if (unifiedConfig.mcp && Object.keys(unifiedConfig.mcp.servers).length > 0) {
+        rulerMcpJson = {
+            mcpServers: unifiedConfig.mcp.servers,
+        };
+    }
+    return {
+        config,
+        concatenatedRules,
+        rulerMcpJson,
+    };
+}
+/**
+ * Selects the agents to process based on configuration.
+ * @param allAgents Array of all available agents
+ * @param config Loaded configuration
+ * @returns Array of agents to be processed
+ */
+function selectAgentsToRun(allAgents, config) {
+    // CLI --agents > config.default_agents > per-agent.enabled flags > default all
+    let selected = allAgents;
+    if (config.cliAgents && config.cliAgents.length > 0) {
+        const filters = config.cliAgents.map((n) => n.toLowerCase());
+        // Check if any of the specified agents don't exist
+        const validAgentIdentifiers = new Set(allAgents.map((agent) => agent.getIdentifier()));
+        const validAgentNames = new Set(allAgents.map((agent) => agent.getName().toLowerCase()));
+        const invalidAgents = filters.filter((filter) => !validAgentIdentifiers.has(filter) &&
+            ![...validAgentNames].some((name) => name.includes(filter)));
+        if (invalidAgents.length > 0) {
+            throw (0, constants_1.createRulerError)(`Invalid agent specified: ${invalidAgents.join(', ')}`, `Valid agents are: ${[...validAgentIdentifiers].join(', ')}`);
+        }
+        selected = allAgents.filter((agent) => filters.some((f) => agent.getIdentifier() === f ||
+            agent.getName().toLowerCase().includes(f)));
+    }
+    else if (config.defaultAgents && config.defaultAgents.length > 0) {
+        const defaults = config.defaultAgents.map((n) => n.toLowerCase());
+        // Check if any of the default agents don't exist
+        const validAgentIdentifiers = new Set(allAgents.map((agent) => agent.getIdentifier()));
+        const validAgentNames = new Set(allAgents.map((agent) => agent.getName().toLowerCase()));
+        const invalidAgents = defaults.filter((filter) => !validAgentIdentifiers.has(filter) &&
+            ![...validAgentNames].some((name) => name.includes(filter)));
+        if (invalidAgents.length > 0) {
+            throw (0, constants_1.createRulerError)(`Invalid agent specified in default_agents: ${invalidAgents.join(', ')}`, `Valid agents are: ${[...validAgentIdentifiers].join(', ')}`);
+        }
+        selected = allAgents.filter((agent) => {
+            const identifier = agent.getIdentifier();
+            const override = config.agentConfigs[identifier]?.enabled;
+            if (override !== undefined) {
+                return override;
+            }
+            return defaults.some((d) => identifier === d || agent.getName().toLowerCase().includes(d));
+        });
+    }
+    else {
+        selected = allAgents.filter((agent) => config.agentConfigs[agent.getIdentifier()]?.enabled !== false);
+    }
+    return selected;
+}
+/**
+ * Applies configurations to the selected agents.
+ * @param agents Array of agents to process
+ * @param concatenatedRules Concatenated rule content
+ * @param rulerMcpJson MCP configuration JSON
+ * @param config Loaded configuration
+ * @param projectRoot Root directory of the project
+ * @param verbose Whether to enable verbose logging
+ * @param dryRun Whether to perform a dry run
+ * @returns Promise resolving to array of generated file paths
+ */
+async function applyConfigurationsToAgents(agents, concatenatedRules, rulerMcpJson, config, projectRoot, verbose, dryRun, cliMcpEnabled = true, cliMcpStrategy) {
+    const generatedPaths = [];
+    let agentsMdWritten = false;
+    for (const agent of agents) {
+        const prefix = (0, constants_1.actionPrefix)(dryRun);
+        console.log(`${prefix} Applying rules for ${agent.getName()}...`);
+        (0, constants_1.logVerbose)(`Processing agent: ${agent.getName()}`, verbose);
+        const agentConfig = config.agentConfigs[agent.getIdentifier()];
+        // Collect output paths for .gitignore
+        const outputPaths = (0, agent_utils_1.getAgentOutputPaths)(agent, projectRoot, agentConfig);
+        (0, constants_1.logVerbose)(`Agent ${agent.getName()} output paths: ${outputPaths.join(', ')}`, verbose);
+        generatedPaths.push(...outputPaths);
+        // Also add the backup file paths to the gitignore list
+        const backupPaths = outputPaths.map((p) => `${p}.bak`);
+        generatedPaths.push(...backupPaths);
+        if (dryRun) {
+            (0, constants_1.logVerbose)(`DRY RUN: Would write rules to: ${outputPaths.join(', ')}`, verbose);
+        }
+        else {
+            let skipApplyForThisAgent = false;
+            if (agent.getIdentifier() === 'jules' ||
+                agent.getIdentifier() === 'agentsmd') {
+                if (agentsMdWritten) {
+                    // Skip rewriting AGENTS.md, but still allow MCP handling below
+                    skipApplyForThisAgent = true;
+                }
+                else {
+                    agentsMdWritten = true;
+                }
+            }
+            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,
+                    },
+                };
+            }
+            if (!skipApplyForThisAgent) {
+                await agent.applyRulerConfig(concatenatedRules, projectRoot, rulerMcpJson, finalAgentConfig);
+            }
+        }
+        // Handle MCP configuration
+        await handleMcpConfiguration(agent, agentConfig, config, rulerMcpJson, projectRoot, generatedPaths, verbose, dryRun, cliMcpEnabled, cliMcpStrategy);
+    }
+    return generatedPaths;
+}
+/**
+ * Handles MCP configuration for a specific agent.
+ */
+async function handleMcpConfiguration(agent, agentConfig, config, rulerMcpJson, projectRoot, generatedPaths, verbose, dryRun, cliMcpEnabled = true, cliMcpStrategy) {
+    // Check if agent supports MCP at all
+    if (!(0, capabilities_1.agentSupportsMcp)(agent)) {
+        (0, constants_1.logVerbose)(`Agent ${agent.getName()} does not support MCP - skipping MCP configuration`, verbose);
+        return;
+    }
+    const dest = await (0, mcp_1.getNativeMcpPath)(agent.getName(), projectRoot);
+    const mcpEnabledForAgent = cliMcpEnabled && (agentConfig?.mcp?.enabled ?? config.mcp?.enabled ?? true);
+    if (dest && mcpEnabledForAgent && rulerMcpJson) {
+        // Filter MCP configuration based on agent capabilities
+        const filteredMcpJson = (0, capabilities_1.filterMcpConfigForAgent)(rulerMcpJson, agent);
+        if (!filteredMcpJson) {
+            (0, constants_1.logVerbose)(`No compatible MCP servers found for ${agent.getName()} - skipping MCP configuration`, verbose);
+            return;
+        }
+        // Include MCP config file in .gitignore only if it's within the project directory
+        if (dest.startsWith(projectRoot)) {
+            const relativeDest = path.relative(projectRoot, dest);
+            generatedPaths.push(relativeDest);
+            // Also add the backup for the MCP file
+            generatedPaths.push(`${relativeDest}.bak`);
+        }
+        // Prevent writing MCP configs outside the project root (e.g., legacy home-directory targets)
+        if (!dest.startsWith(projectRoot)) {
+            (0, constants_1.logVerbose)(`Skipping MCP config for ${agent.getName()} because target path is outside project: ${dest}`, verbose);
+            return;
+        }
+        if (agent.getIdentifier() === 'openhands') {
+            // *** Special handling for Open Hands ***
+            if (dryRun) {
+                (0, constants_1.logVerbose)(`DRY RUN: Would apply MCP config by updating TOML file: ${dest}`, verbose);
+            }
+            else {
+                await (0, propagateOpenHandsMcp_1.propagateMcpToOpenHands)(filteredMcpJson, dest);
+            }
+        }
+        else if (agent.getIdentifier() === 'opencode') {
+            // *** Special handling for OpenCode ***
+            if (dryRun) {
+                (0, constants_1.logVerbose)(`DRY RUN: Would apply MCP config by updating OpenCode config file: ${dest}`, verbose);
+            }
+            else {
+                await (0, propagateOpenCodeMcp_1.propagateMcpToOpenCode)(filteredMcpJson, dest);
+            }
+        }
+        else {
+            // Standard MCP handling using capabilities
+            const strategy = cliMcpStrategy ??
+                agentConfig?.mcp?.strategy ??
+                config.mcp?.strategy ??
+                'merge';
+            // Determine the correct server key for the agent
+            const serverKey = agent.getMcpServerKey?.() || 'mcpServers';
+            (0, constants_1.logVerbose)(`Applying filtered MCP config for ${agent.getName()} with strategy: ${strategy} and key: ${serverKey}`, verbose);
+            if (dryRun) {
+                (0, constants_1.logVerbose)(`DRY RUN: Would apply MCP config to: ${dest}`, verbose);
+            }
+            else {
+                const existing = await (0, mcp_1.readNativeMcp)(dest);
+                const merged = (0, merge_1.mergeMcp)(existing, filteredMcpJson, strategy, serverKey);
+                await (0, mcp_1.writeNativeMcp)(dest, merged);
+            }
+        }
+    }
+}
+/**
+ * Updates the .gitignore file with generated paths.
+ * @param projectRoot Root directory of the project
+ * @param generatedPaths Array of generated file paths
+ * @param config Loaded configuration
+ * @param cliGitignoreEnabled CLI gitignore setting
+ * @param dryRun Whether to perform a dry run
+ */
+async function updateGitignore(projectRoot, generatedPaths, config, cliGitignoreEnabled, dryRun) {
+    // Configuration precedence: CLI > TOML > Default (enabled)
+    let gitignoreEnabled;
+    if (cliGitignoreEnabled !== undefined) {
+        gitignoreEnabled = cliGitignoreEnabled;
+    }
+    else if (config.gitignore?.enabled !== undefined) {
+        gitignoreEnabled = config.gitignore.enabled;
+    }
+    else {
+        gitignoreEnabled = true; // Default enabled
+    }
+    if (gitignoreEnabled && generatedPaths.length > 0) {
+        const uniquePaths = [...new Set(generatedPaths)];
+        // Add wildcard pattern for backup files
+        uniquePaths.push('*.bak');
+        if (uniquePaths.length > 0) {
+            const prefix = (0, constants_1.actionPrefix)(dryRun);
+            if (dryRun) {
+                console.log(`${prefix} Would update .gitignore with ${uniquePaths.length} unique path(s): ${uniquePaths.join(', ')}`);
+            }
+            else {
+                await (0, GitignoreUtils_1.updateGitignore)(projectRoot, uniquePaths);
+                console.log(`${prefix} Updated .gitignore with ${uniquePaths.length} unique path(s) in the Ruler block.`);
+            }
+        }
+    }
+}

package/dist/core/config-utils.js

@@ -0,0 +1,30 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.mapRawAgentConfigs = mapRawAgentConfigs;
+/**
+ * Maps raw agent configuration keys to their corresponding agent identifiers.
+ *
+ * This function normalizes configuration keys by matching them against agent identifiers
+ * and display names. It performs both exact matching (case-insensitive) with agent
+ * identifiers and substring matching (case-insensitive) with agent display names
+ * for backwards compatibility.
+ *
+ * @param raw Raw agent configurations with user-provided keys
+ * @param agents Array of all available agents
+ * @returns Record with agent identifiers as keys and their configurations as values
+ */
+function mapRawAgentConfigs(raw, agents) {
+    const mappedConfigs = {};
+    for (const [key, cfg] of Object.entries(raw)) {
+        const lowerKey = key.toLowerCase();
+        for (const agent of agents) {
+            const identifier = agent.getIdentifier();
+            // Exact match with identifier or substring match with display name for backwards compatibility
+            if (identifier === lowerKey ||
+                agent.getName().toLowerCase().includes(lowerKey)) {
+                mappedConfigs[identifier] = cfg;
+            }
+        }
+    }
+    return mappedConfigs;
+}

package/dist/core/hash.js

@@ -0,0 +1,24 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.sha256 = sha256;
+exports.stableJson = stableJson;
+const crypto_1 = require("crypto");
+function sha256(data) {
+    return (0, crypto_1.createHash)('sha256').update(data, 'utf8').digest('hex');
+}
+// Stable JSON stringify: sorts object keys recursively.
+function stableJson(value) {
+    return JSON.stringify(sortValue(value));
+}
+function sortValue(value) {
+    if (Array.isArray(value)) {
+        return value.map(sortValue);
+    }
+    if (value && typeof value === 'object') {
+        const entries = Object.entries(value)
+            .sort(([a], [b]) => (a < b ? -1 : a > b ? 1 : 0))
+            .map(([k, v]) => [k, sortValue(v)]);
+        return Object.fromEntries(entries);
+    }
+    return value;
+}