aicm 0.6.5 → 0.8.0

package/README.md

@@ -30,7 +30,6 @@ In your project's `aicm.json`, reference the package and the specific rule:
 
 ```json
 {
-  "ides": ["cursor"],
   "rules": {
     "typescript": "@myteam/ai-tools/rules/typescript.mdc",
     "react": "@myteam/ai-tools/rules/react.mdc"
@@ -80,7 +79,6 @@ In your project's `aicm.json`, reference the preset by its npm package or direct
 
 ```json
 {
-  "ides": ["cursor"],
   "presets": ["@myteam/ai-tools"]
 }
 ```
@@ -132,10 +130,7 @@ npm install --save-dev pirate-coding
 2. Create an `aicm.json` file in your project
 
 ```bash
-echo '{
-  "ides": ["cursor"],
-  "presets": ["pirate-coding"]
-}' > aicm.json
+echo '{ "presets": ["pirate-coding"] }' > aicm.json
 ```
 
 3. Install all rules & mcps from your configuration
@@ -179,6 +174,9 @@ Example `aicm.json`:
 - **ides**: Array of IDE names where rules should be installed. Currently supported values:
 
   - `"cursor"`: For the Cursor IDE
+  - `"windsurf"`: For the Windsurf IDE
+
+  > **Note:** The 'ides' field is default to `["cursor"]` if not specified.
 
 - **rules**: Object containing rule configurations
 
@@ -194,6 +192,8 @@ Example `aicm.json`:
 
   - Preset files should contain a `rules` and `mcpServers` objects with the same structure as the main configuration.
 
+- **installOnCI**: Boolean flag (default: `false`) that controls whether installation should proceed in CI environments. When set to `true`, rules will be installed even in CI environments.
+
 ### MCP Server Installation
 
 - **Cursor**: MCP server configs are written to `.cursor/mcp.json` (see Cursor docs for latest path).
@@ -249,6 +249,10 @@ Installs all rules and MCPs configured in your `aicm.json`.
 npx aicm install
 ```
 
+Options:
+
+- `--ci`: run in CI environments (default: `false`)
+
 ## Node.js API
 
 In addition to the CLI, aicm can be used programmatically in Node.js applications:
@@ -276,7 +280,6 @@ const customConfig = {
 install({
   config: customConfig,
   cwd: "/path/to/project",
-  silent: true,
 }).then((result) => {
   // Handle result
 });
@@ -292,7 +295,7 @@ Installs rules and MCP servers based on configuration.
 
 - `cwd`: Base directory to use instead of `process.cwd()`
 - `config`: Custom config object to use instead of loading from file
-- `silent`: Whether to suppress console output
+- `installOnCI`: Run installation on CI environments (default: `false`)
 
 **Returns:**
 

package/dist/api.d.ts

@@ -1,7 +1,7 @@
 import { InstallOptions, InstallResult } from "./commands/install";
 /**
  * Install AICM rules based on configuration
- * @param options Install options
+ * @param options Installation options
  * @returns Result of the install operation
  */
 export declare function install(options?: InstallOptions): Promise<InstallResult>;

package/dist/api.js

@@ -4,7 +4,7 @@ exports.install = install;
 const install_1 = require("./commands/install");
 /**
  * Install AICM rules based on configuration
- * @param options Install options
+ * @param options Installation options
  * @returns Result of the install operation
  */
 async function install(options = {}) {

package/dist/commands/init.js

@@ -11,6 +11,7 @@ const defaultConfig = {
     ides: ["cursor"],
     rules: {},
     mcpServers: {},
+    installOnCI: false,
 };
 function initCommand() {
     const configPath = path_1.default.join(process.cwd(), "aicm.json");

package/dist/commands/install.d.ts

@@ -12,9 +12,9 @@ export interface InstallOptions {
      */
     config?: Config;
     /**
-     * Whether to log progress to console
+     * allow installation on CI environments
      */
-    silent?: boolean;
+    installOnCI?: boolean;
 }
 /**
  * Result of the install operation
@@ -39,4 +39,4 @@ export interface InstallResult {
  * @returns Result of the install operation
  */
 export declare function install(options?: InstallOptions): Promise<InstallResult>;
-export declare function installCommand(): Promise<void>;
+export declare function installCommand(installOnCI?: boolean): Promise<void>;

package/dist/commands/install.js

@@ -12,6 +12,7 @@ const rule_collector_1 = require("../utils/rule-collector");
 const rule_writer_1 = require("../utils/rule-writer");
 const fs_extra_1 = __importDefault(require("fs-extra"));
 const node_path_1 = __importDefault(require("node:path"));
+const ci_info_1 = require("ci-info");
 /**
  * Write MCP servers configuration to IDE targets
  * @param mcpServers The MCP servers configuration
@@ -33,6 +34,19 @@ function writeMcpServersToTargets(mcpServers, ides, cwd) {
         }
     }
 }
+/**
+ * Checks if the current environment is a CI environment
+ * This function respects any explicit settings in process.env.CI
+ */
+function isInCIEnvironment() {
+    // Explicit environment variable settings take precedence
+    if (process.env.CI === "true")
+        return true;
+    if (process.env.CI === "false")
+        return false;
+    // Fall back to ci-info's detection
+    return ci_info_1.isCI;
+}
 /**
  * Core implementation of the rule installation logic
  * @param options Install options
@@ -40,23 +54,15 @@ function writeMcpServersToTargets(mcpServers, ides, cwd) {
  */
 async function install(options = {}) {
     const cwd = options.cwd || process.cwd();
-    const silent = options.silent || false;
-    const log = silent ? () => { } : console.log;
-    const error = silent ? () => { } : console.error;
+    const installOnCI = options.installOnCI === true; // Default to false if not specified
     try {
-        // Save original process.cwd() and change to the specified cwd
         const originalCwd = process.cwd();
         if (cwd !== originalCwd) {
             process.chdir(cwd);
         }
-        // Initialize rule collection
         const ruleCollection = (0, rule_collector_1.initRuleCollection)();
-        // Use provided config or load from file
         const config = options.config || (0, config_1.getConfig)();
-        // If config doesn't exist, return error
         if (!config) {
-            error("Configuration file not found!");
-            // Restore original cwd
             if (cwd !== originalCwd) {
                 process.chdir(originalCwd);
             }
@@ -66,12 +72,21 @@ async function install(options = {}) {
                 installedRuleCount: 0,
             };
         }
+        const inCI = isInCIEnvironment();
+        if (inCI && !installOnCI && !config.installOnCI) {
+            if (cwd !== originalCwd) {
+                process.chdir(originalCwd);
+            }
+            console.log(chalk_1.default.yellow("Detected CI environment, skipping install."));
+            return {
+                success: true,
+                installedRuleCount: 0,
+            };
+        }
         // Check if rules are defined (either directly or through presets)
         if (!config.rules || Object.keys(config.rules).length === 0) {
             // If there are no presets defined either, show a message
             if (!config.presets || config.presets.length === 0) {
-                error("No rules defined in configuration.");
-                // Restore original cwd
                 if (cwd !== originalCwd) {
                     process.chdir(originalCwd);
                 }
@@ -104,24 +119,20 @@ async function install(options = {}) {
                         ruleContent = (0, rule_collector_1.collectLocalRule)(name, source, ruleBasePath);
                         break;
                     default:
-                        error(`Unknown rule type: ${ruleType}`);
                         errorMessages.push(`Unknown rule type: ${ruleType}`);
                         continue;
                 }
-                // Add rule to collection
                 (0, rule_collector_1.addRuleToCollection)(ruleCollection, ruleContent, config.ides);
                 installedRuleCount++;
             }
             catch (e) {
                 hasErrors = true;
                 const errorMessage = `Error processing rule ${name}: ${e instanceof Error ? e.message : String(e)}`;
-                error(errorMessage);
                 errorMessages.push(errorMessage);
             }
         }
         // If there were errors, exit with error
         if (hasErrors) {
-            // Restore original cwd
             if (cwd !== originalCwd) {
                 process.chdir(originalCwd);
             }
@@ -139,7 +150,6 @@ async function install(options = {}) {
             const filteredMcpServers = Object.fromEntries(Object.entries(config.mcpServers).filter(([, v]) => v !== false));
             writeMcpServersToTargets(filteredMcpServers, config.ides, cwd);
         }
-        log("Rules installation completed");
         // Restore original cwd
         if (cwd !== originalCwd) {
             process.chdir(originalCwd);
@@ -150,8 +160,7 @@ async function install(options = {}) {
         };
     }
     catch (e) {
-        const errorMessage = `Error during rule installation: ${e instanceof Error ? e.message : String(e)}`;
-        error(errorMessage);
+        const errorMessage = e instanceof Error ? e.message : String(e);
         // If cwd was changed, restore it
         if (cwd !== process.cwd()) {
             process.chdir(cwd);
@@ -163,16 +172,19 @@ async function install(options = {}) {
         };
     }
 }
-async function installCommand() {
+async function installCommand(installOnCI) {
     try {
-        const result = await install({ silent: false });
+        const result = await install({ installOnCI });
         if (!result.success) {
             console.error(chalk_1.default.red(result.error));
             process.exit(1);
         }
+        else {
+            console.log("Rules installation completed");
+        }
     }
     catch (error) {
-        console.error(chalk_1.default.red(`Error during rule installation: ${error instanceof Error ? error.message : String(error)}`));
+        console.error(chalk_1.default.red(error instanceof Error ? error.message : String(error)));
         process.exit(1);
     }
 }

package/dist/commands/list.js

@@ -24,9 +24,9 @@ function listCommand() {
     console.log(chalk_1.default.dim("─".repeat(50)));
     for (const [ruleName, source] of Object.entries(config.rules)) {
         if (source === false)
-            continue; // skip canceled rules
+            continue;
         const ruleType = (0, rule_detector_1.detectRuleType)(source);
-        const status = (0, rule_status_1.checkRuleStatus)(ruleName, ruleType, config.ides);
+        const status = (0, rule_status_1.checkRuleStatus)(ruleName, config.ides);
         const statusColor = status
             ? chalk_1.default.green("Installed")
             : chalk_1.default.yellow("Not installed");

package/dist/index.js

@@ -16,6 +16,7 @@ const pkg = require("../package.json");
 const args = (0, arg_1.default)({
     "--help": Boolean,
     "--version": Boolean,
+    "--ci": Boolean,
     "-h": "--help",
     "-v": "--version",
 }, {
@@ -35,7 +36,7 @@ switch (command) {
         (0, init_1.initCommand)();
         break;
     case "install":
-        (0, install_1.installCommand)();
+        (0, install_1.installCommand)(args["--ci"]);
         break;
     case "list":
         (0, list_1.listCommand)();
@@ -60,6 +61,7 @@ ${chalk_1.default.bold("COMMANDS")}
 ${chalk_1.default.bold("OPTIONS")}
   -h, --help          Show this help message
   -v, --version       Show version number
+  --ci                Run in CI environments (default: \`false\`)
 
 ${chalk_1.default.bold("EXAMPLES")}
   $ aicm init

package/dist/types/index.d.ts

@@ -21,6 +21,7 @@ export interface Config {
     rules: Rules;
     presets?: string[];
     mcpServers?: MCPServers;
+    installOnCI?: boolean;
 }
 export interface RuleMetadata {
     type?: string;

package/dist/utils/config.js

@@ -42,7 +42,7 @@ function getFullPresetPath(presetPath) {
 function loadPreset(presetPath) {
     const fullPresetPath = getFullPresetPath(presetPath);
     if (!fullPresetPath) {
-        throw new Error(`Error loading preset: File not found: ${presetPath}. Make sure the package is installed in your project.`);
+        throw new Error(`Error loading preset: "${presetPath}". Make sure the package is installed in your project.`);
     }
     const presetContent = fs_extra_1.default.readFileSync(fullPresetPath, "utf8");
     let preset;
@@ -133,11 +133,12 @@ function loadAicmConfigCosmiconfig() {
         const config = result.config;
         if (!config.rules)
             config.rules = {};
+        if (!config.ides)
+            config.ides = ["cursor"];
         return config;
     }
     catch (error) {
-        console.error("Error loading aicm config via cosmiconfig:", error);
-        return null;
+        throw new Error(`Error loading aicm config: ${error instanceof Error ? error.message : String(error)}`);
     }
 }
 /**
@@ -145,8 +146,9 @@ function loadAicmConfigCosmiconfig() {
  */
 function getConfig() {
     const config = loadAicmConfigCosmiconfig();
-    if (!config)
-        return null;
+    if (!config) {
+        throw new Error(`No config found in ${process.cwd()}, create one using "aicm init"`);
+    }
     processPresets(config);
     return config;
 }

package/dist/utils/rule-status.d.ts

@@ -5,4 +5,4 @@ export declare function getIdePaths(): Record<string, string>;
 /**
  * Check if a rule is installed in the specified IDEs
  */
-export declare function checkRuleStatus(ruleName: string, ruleType: string, ides: string[]): boolean;
+export declare function checkRuleStatus(ruleName: string, ides: string[]): boolean;

package/dist/utils/rule-status.js

@@ -20,7 +20,7 @@ function getIdePaths() {
 /**
  * Check if a rule is installed in the specified IDEs
  */
-function checkRuleStatus(ruleName, ruleType, ides) {
+function checkRuleStatus(ruleName, ides) {
     const idePaths = getIdePaths();
     return ides.every((ide) => {
         if (!idePaths[ide]) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "aicm",
-  "version": "0.6.5",
+  "version": "0.8.0",
   "description": "A TypeScript CLI tool for managing AI IDE rules across different projects and teams",
   "main": "dist/api.js",
   "types": "dist/api.d.ts",
@@ -41,6 +41,7 @@
     "arg": "^5.0.2",
     "args": "^5.0.3",
     "chalk": "^4.1.2",
+    "ci-info": "^4.2.0",
     "cosmiconfig": "^9.0.0",
     "fs-extra": "^11.1.1"
   },