glooit 0.5.2 → 0.5.4

package/README.md

@@ -7,11 +7,15 @@
 ## Quick Start
 
 ```bash
-# Install globally
-npm install -g glooitit
+# Install 
+npm install -g glooit
+bun install -g glooit
+pnpm install -g glooit
 
-# Or run directly
-npx glooitit init
+#  Run
+npx glooit init
+bunx glooit init
+pnpx glooit init
 ```
 
 ## Basic Usage
@@ -30,9 +34,9 @@ import { Config } from 'glooit';
 export default {
   rules: [
     {
-      file: 'my-coding-rules.md',
+      file: 'main.md',
       to: './',
-      targets: ['claude', 'cursor']
+      targets: ['claude', 'cursor', 'codex']
     }
   ]
 } satisfies Config;
@@ -45,8 +49,10 @@ glooit sync
 ```
 
 This automatically creates:
+
 - `CLAUDE.md` (for Claude Code)
-- `.cursor/rules/my-coding-rules.md` (for Cursor)
+- `.cursor/rules/main.md` (for Cursor)
+- `AGENTS.md` (for Codex)
 
 ### 3. Add MCP Configurations
 
@@ -73,36 +79,179 @@ export default {
 
 ### Supported Agents
 
-- **Claude Code**: `.mcp.json`
-- **Cursor**: `~/.cursor/mcp.json`
-- **Roo Code/Cline**: `.roo/mcp.json`
+- **Claude Code**
+- **Cursor**
+- **Roo Code/Cline**
+- **Codex**
+- **Generic**
 
-### Example Configuration
+### Full Configuration
 
 ```typescript
-import { Config } from 'glooit';
+import { defineRules } from 'glooit';
 
-export default {
+export default defineRules({
   configDir: '.glooit',
+  targets: ['claude', 'cursor'],
   rules: [
     {
-      file: 'coding-standards.md',
+      name: 'main',
+      file: '.glooit/main.md',
       to: './',
-      targets: ['claude', 'cursor', 'roocode']
+      targets: ['claude', 'cursor']
     }
   ],
+  mcps: [],
+  mergeMcps: true,
+  backup: {
+    enabled: true,
+    retention: 10
+  }
+});
+```
+
+## Advanced Usage
+
+### Custom File Destinations
+
+```typescript
+export default defineRules({
+  rules: [
+    {
+      name: 'backend-rules',
+      file: '.glooit/backend.md',
+      to: './',
+      targets: [
+        'claude',
+        { name: 'cursor', to: './backend/.cursor/rules/backend.md' },
+        { name: 'generic', to: './docs/backend-standards.md' }
+      ]
+    }
+  ]
+});
+```
+
+### Hooks (Before & After Sync)
+
+```typescript
+import { defineRules, hooks } from 'glooit';
+
+export default defineRules({
+  rules: [/* your rules */],
+  hooks: {
+    before: [
+      async ({ config }) => {
+        console.log('🚀 Starting sync...');
+        // Run tests, validate env, etc.
+      }
+    ],
+    after: [
+      async (context) => {
+        console.log('✅ Sync complete!');
+        // Commit changes, notify team, etc.
+        return `Synced ${context.rule.name} successfully`;
+      },
+      hooks.addTimestamp,
+      hooks.replaceEnv
+    ]
+  }
+});
+```
+
+### Built-in Hooks
+
+glooit comes with handy hooks to supercharge your sync process:
+
+```typescript
+import { defineRules, hooks } from 'glooit';
+
+export default defineRules({
+  rules: [/* your rules */],
+  hooks: {
+    after: [
+      hooks.addTimestamp,
+      hooks.replaceEnv,
+      hooks.replaceStructure,
+      hooks.compact()
+    ]
+  }
+});
+```
+
+**🕒 `addTimestamp`** - Replace `__TIMESTAMP__` with current date/time
+```markdown
+Last updated: __TIMESTAMP__
+<!-- Becomes: Last updated: December 24, 2024, 03:30 PM -->
+```
+
+**🌍 `replaceEnv`** - Replace `__ENV_VAR__` patterns with environment variables
+```markdown
+Database: __ENV_DATABASE_URL__
+API Key: __ENV_API_KEY__
+<!-- Uses your actual env vars -->
+```
+
+**📁 `replaceStructure`** - Replace `__STRUCTURE__` with project tree
+```markdown
+Project structure:
+__STRUCTURE__
+<!-- Becomes a nice ASCII tree of your project -->
+```
+
+**🗜️ `compact`** - Clean up and compress your markdown
+```typescript
+hooks.compact({
+  maxConsecutiveNewlines: 2,
+  removeFillerWords: true,    // Removes "basically", "literally", etc.
+  compactLists: true         // Tightens up list spacing
+})
+```
+
+### MCP Configuration
+
+```typescript
+export default defineRules({
+  rules: [/* your rules */],
   mcps: [
     {
-      name: 'database',
+      name: 'filesystem',
       config: {
         command: 'npx',
-        args: ['db-mcp-server']
+        args: ['@modelcontextprotocol/server-filesystem', process.cwd()]
       },
       targets: ['claude']
+    },
+    {
+      name: 'postgres',
+      config: {
+        command: 'uvx',
+        args: ['mcp-server-postgres'],
+        env: { DATABASE_URL: process.env.DATABASE_URL }
+      },
+      targets: ['claude', 'cursor']
     }
-  ],
-  mergeMcps: true
-} satisfies Config;
+  ]
+});
+```
+
+### Monorepos & AGENTS.md
+
+When using `AGENTS.md` in subdirectories, Cursor automatically detects them - no need to enable Cursor for those specific paths. Perfect for monorepos where different services need different rules.
+
+### File Formats by Project Type
+
+**JavaScript/TypeScript projects:**
+
+```typescript
+// glooit.config.ts - with TypeScript support
+export default defineRules({ /* config */ });
+```
+
+**Non-JS projects:**
+
+```javascript
+// glooit.config.js - plain JavaScript / typescript
+export default { /* config */ };
 ```
 
 ## Commands
@@ -120,25 +269,12 @@ glooit backup list   # List backups
 
 - 🔄 **Multi-platform sync** - Works with all major AI coding assistants
 - 📦 **MCP support** - Model Context Protocol configuration management
-- 🎯 **Selective targeting** - Choose which agents get which rules
+- 🎯 **Selective targeting** - Choose which agents get which rules and wht folders, perfect for complex projects & monorepos
 - 🔙 **Backup system** - Automatic backups before changes
 - 🧹 **Clean management** - Easy cleanup and reset options
-- ⚡ **Fast** - Built with Bun for maximum performance
-
-## Installation
-
-```bash
-# NPM
-npm install -g glooit
-
-# Bun
-bun install -g glooit
-
-# Direct execution
-npx glooitit init
-bunx glooitit sync
-```
+- 📝 **Auto .gitignore** - Automatically manages generated files in .gitignore
+- ⚡ **Fast** - Built with Bun for.... you know... bun?
 
 ## License
 
-MIT
+MIT

package/dist/cli/index.js

@@ -2215,11 +2215,12 @@ import { existsSync as existsSync2, readFileSync as readFileSync2 } from "fs";
 class CursorWriter {
   formatContent(content, rule) {
     const ruleName = this.extractRuleName(rule.file);
+    const hasGlobs = rule.globs && rule.globs.length > 0;
     const frontmatter = [
       "---",
       `description: AI Rules - ${ruleName}`,
-      `globs: ${rule.globs || "**/*"}`,
-      "alwaysApply: true",
+      `globs: ${hasGlobs ? rule.globs : "**/*"}`,
+      "alwaysApply: " + (hasGlobs ? "false" : "true"),
       "---",
       ""
     ].join(`
@@ -2855,7 +2856,23 @@ class ConfigLoader {
       throw new Error(`No configuration file found. Looking for: ${this.DEFAULT_CONFIG_PATHS.join(", ")}`);
     }
     try {
-      const configModule = await import(join4(process.cwd(), configPath));
+      const fullPath = join4(process.cwd(), configPath);
+      let configModule;
+      if (configPath.endsWith(".ts")) {
+        try {
+          const { createJiti } = await import("jiti");
+          const jiti = createJiti(import.meta.url);
+          configModule = await jiti.import(fullPath);
+        } catch (jitiError) {
+          throw new Error(`Failed to load TypeScript config. Please either:
+1. Use 'bunx glooit' instead of 'npx glooit'
+2. Rename ${configPath} to ${configPath.replace(".ts", ".js")}
+3. Use JavaScript config: npx glooit init --js
+Original error: ${jitiError}`);
+        }
+      } else {
+        configModule = await import(fullPath);
+      }
       const config = configModule.default || configModule;
       if (typeof config === "function") {
         const result = config();
@@ -2945,135 +2962,30 @@ class ConfigLoader {
   static createTypedConfig() {
     return `import { defineRules } from 'glooit';
 
-// defineRules() provides TypeScript IntelliSense and validation
 export default defineRules({
-  // Directory where glooit stores configuration files
   configDir: '.glooit',
-
-  // Default targets for all rules (can be overridden per rule)
-  targets: ['claude', 'cursor'],
-
-  // Rules define how to sync your files to different AI agents
   rules: [
     {
       name: 'main',
-      file: '.glooit/main.md',         // Source file to sync
-      to: './',                        // Destination directory
-      targets: ['claude', 'cursor']    // Which agents to sync to
-    }
-    // Add more rules here:
-    // {
-    //   name: 'coding-standards',
-    //   file: '.glooit/coding-rules.md',
-    //   to: './',
-    //   targets: [
-    //     'claude',
-    //     { name: 'cursor', to: './custom/cursor-rules.mdc' }, // Custom path override
-    //     { name: 'generic', to: './docs/coding-standards.md' } // Generic agent with custom path
-    //   ],
-    //   globs: '**/*.{ts,js,tsx,jsx}' // Optional: only apply to certain file patterns
-    // }
-  ],
-
-  // MCP (Model Context Protocol) server configurations
-  mcps: [
-    // Example MCP server configurations:
-    // {
-    //   name: 'database',
-    //   config: {
-    //     command: 'npx',
-    //     args: ['@modelcontextprotocol/server-postgres'],
-    //     env: { DATABASE_URL: process.env.DATABASE_URL }
-    //   },
-    //   targets: ['claude']
-    // },
-    // {
-    //   name: 'filesystem',
-    //   config: {
-    //     command: 'npx',
-    //     args: ['@modelcontextprotocol/server-filesystem', process.cwd()]
-    //   },
-    //   targets: ['claude', 'cursor']
-    // }
+      file: '.glooit/main.md',
+      to: './',
+      targets: ['claude', 'cursor']
+    }
   ],
-
-  // Additional options:
-  // mergeMcps: true,        // Merge with existing MCP configs (default: true)
-  // backup: {               // Backup settings
-  //   enabled: true,         // Create backups before syncing (default: true)
-  //   retention: 10          // Keep last 10 backups (default: 10)
-  // },
-  // hooks: {                // Custom hooks for advanced workflows
-  //   before: [],           // Run before sync
-  //   after: [],            // Run after sync
-  //   error: []             // Run on error
-  // }
 });
 `;
   }
   static createPlainConfig() {
     return `export default {
-  // Directory where glooit stores configuration files
   configDir: '.glooit',
-
-  // Default targets for all rules (can be overridden per rule)
-  targets: ['claude', 'cursor'],
-
-  // Rules define how to sync your files to different AI agents
   rules: [
     {
       name: 'main',
-      file: '.glooit/main.md',         // Source file to sync
-      to: './',                        // Destination directory
-      targets: ['claude', 'cursor']    // Which agents to sync to
-    }
-    // Add more rules here:
-    // {
-    //   name: 'coding-standards',
-    //   file: '.glooit/coding-rules.md',
-    //   to: './',
-    //   targets: [
-    //     'claude',
-    //     { name: 'cursor', to: './custom/cursor-rules.mdc' }, // Custom path override
-    //     { name: 'generic', to: './docs/coding-standards.md' } // Generic agent with custom path
-    //   ],
-    //   globs: '**/*.{ts,js,tsx,jsx}' // Optional: only apply to certain file patterns
-    // }
+      file: '.glooit/main.md',
+      to: './',
+      targets: ['claude', 'cursor']
+    }
   ],
-
-  // MCP (Model Context Protocol) server configurations
-  mcps: [
-    // Example MCP server configurations:
-    // {
-    //   name: 'database',
-    //   config: {
-    //     command: 'npx',
-    //     args: ['@modelcontextprotocol/server-postgres'],
-    //     env: { DATABASE_URL: process.env.DATABASE_URL }
-    //   },
-    //   targets: ['claude']
-    // },
-    // {
-    //   name: 'filesystem',
-    //   config: {
-    //     command: 'npx',
-    //     args: ['@modelcontextprotocol/server-filesystem', process.cwd()]
-    //   },
-    //   targets: ['claude', 'cursor']
-    // }
-  ]
-
-  // Additional options:
-  // mergeMcps: true,        // Merge with existing MCP configs (default: true)
-  // backup: {               // Backup settings
-  //   enabled: true,         // Create backups before syncing (default: true)
-  //   retention: 10          // Keep last 10 backups (default: 10)
-  // },
-  // hooks: {                // Custom hooks for advanced workflows
-  //   before: [],           // Run before sync
-  //   after: [],            // Run after sync
-  //   error: []             // Run on error
-  // }
 };
 `;
   }
@@ -3439,7 +3351,7 @@ function constructCommand(value, args) {
 import { execSync } from "child_process";
 import { createInterface } from "readline";
 // package.json
-var version = "0.5.2";
+var version = "0.5.4";
 
 // src/cli/index.ts
 var args = process.argv.slice(2);