glooit 0.5.4 → 0.5.6

package/README.md

@@ -29,17 +29,37 @@ glooit init
 This creates a `glooit.config.ts` file:
 
 ```typescript
-import { Config } from 'glooit';
+import { defineRules } from 'glooit';
 
-export default {
+export default defineRules({
+  configDir: '.glooit',
   rules: [
     {
-      file: 'main.md',
+      name: 'main',
+      file: '.glooit/main.md',
       to: './',
       targets: ['claude', 'cursor', 'codex']
-    }
-  ]
-} satisfies Config;
+    },
+    {
+      name: 'frontend',
+      file: '.glooit/frontend.md',
+      to: './apps/frontend',
+      globs: './apps/frontend/{src,tests}/**/*.{ts,tsx,js,jsx,md}',
+      targets: [
+        'claude',
+        'codex',
+      ]
+    },
+    {
+      name: 'server',
+      file: '.glooit/server.md',
+      to: './apps/server',
+      globs: './apps/server/{src,tests}/**/*.{ts,tsx,js,jsx,md}',
+      targets: ['claude', 'codex']
+    },
+  ],
+  mcps: [],
+});
 ```
 
 ### 2. Sync Your Rules
@@ -179,12 +199,14 @@ export default defineRules({
 ```
 
 **🕒 `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__
@@ -192,6 +214,7 @@ API Key: __ENV_API_KEY__
 ```
 
 **📁 `replaceStructure`** - Replace `__STRUCTURE__` with project tree
+
 ```markdown
 Project structure:
 __STRUCTURE__
@@ -199,6 +222,7 @@ __STRUCTURE__
 ```
 
 **🗜️ `compact`** - Clean up and compress your markdown
+
 ```typescript
 hooks.compact({
   maxConsecutiveNewlines: 2,
@@ -278,3 +302,11 @@ glooit backup list   # List backups
 ## License
 
 MIT
+
+## Credits
+
+Without these amazing projects, this project would not be possible.
+
+- [Antfu](https://antfu.me) for the amazing packages
+- [Ruler](https://github.com/intellectronica/ruler) Inspiration for the project & ideias
+- [Claude](https://www.anthropic.com/home/claude) for the amazing AI that made this project possible in a few hours.

package/dist/cli/index.js

@@ -2214,7 +2214,8 @@ import { existsSync as existsSync2, readFileSync as readFileSync2 } from "fs";
 
 class CursorWriter {
   formatContent(content, rule) {
-    const ruleName = this.extractRuleName(rule.file);
+    const firstFile = Array.isArray(rule.file) ? rule.file[0] : rule.file;
+    const ruleName = this.extractRuleName(firstFile);
     const hasGlobs = rule.globs && rule.globs.length > 0;
     const frontmatter = [
       "---",
@@ -2336,7 +2337,8 @@ class AgentDistributor {
     this.config = config;
   }
   async distributeRule(rule) {
-    const content = this.loadRuleContent(rule.file);
+    const filePath = Array.isArray(rule.file) ? rule.file : [rule.file];
+    const content = this.loadRuleContent(filePath);
     for (const agent of rule.targets) {
       await this.distributeToAgent(agent, rule, content);
     }
@@ -2354,7 +2356,8 @@ class AgentDistributor {
     if (customPath) {
       targetPath = customPath;
     } else {
-      const ruleName = this.extractRuleName(rule.file);
+      const firstFile = Array.isArray(rule.file) ? rule.file[0] : rule.file;
+      const ruleName = this.extractRuleName(firstFile);
       const agentPath = getAgentPath(agentName, ruleName);
       targetPath = join2(rule.to, agentPath);
     }
@@ -2371,11 +2374,27 @@ class AgentDistributor {
     const finalContent = await this.applyHooks(context);
     writeFileSync(targetPath, finalContent, "utf-8");
   }
-  loadRuleContent(filePath) {
+  loadRuleContent(filePaths) {
     try {
-      return readFileSync3(filePath, "utf-8");
+      if (filePaths.length === 1) {
+        return readFileSync3(filePaths[0], "utf-8");
+      }
+      const mergedContent = [];
+      for (let i = 0;i < filePaths.length; i++) {
+        const filePath = filePaths[i];
+        const content = readFileSync3(filePath, "utf-8");
+        mergedContent.push(`<!-- Source: ${filePath} -->`);
+        mergedContent.push(content);
+        if (i < filePaths.length - 1) {
+          mergedContent.push(`
+---
+`);
+        }
+      }
+      return mergedContent.join(`
+`);
     } catch (error) {
-      throw new Error(`Failed to read rule file ${filePath}: ${error}`);
+      throw new Error(`Failed to read rule file(s): ${error}`);
     }
   }
   extractRuleName(filePath) {
@@ -2556,15 +2575,22 @@ class GitIgnoreManager {
     writeFileSync3(this.gitignorePath, cleanedContent, "utf-8");
   }
   collectGeneratedPaths() {
+    if (this.config.gitignore === false) {
+      return [];
+    }
     const paths = new Set;
     for (const rule of this.config.rules) {
+      if (rule.gitignore === false) {
+        continue;
+      }
       for (const agent of rule.targets) {
         const agentName = this.getAgentName(agent);
         const customPath = this.getCustomPath(agent);
         if (customPath) {
           paths.add(customPath);
         } else {
-          const ruleName = this.extractRuleName(rule.file);
+          const filePath = Array.isArray(rule.file) ? rule.file[0] : rule.file;
+          const ruleName = this.extractRuleName(filePath);
           const agentPath = getAgentPath(agentName, ruleName);
           const fullPath = `${rule.to}/${agentPath}`.replace(/\/+/g, "/");
           paths.add(fullPath);
@@ -2706,8 +2732,11 @@ class AIRulesCore {
   async validate() {
     try {
       for (const rule of this.config.rules) {
-        if (!existsSync5(rule.file)) {
-          throw new Error(`Rule file not found: ${rule.file}`);
+        const files = Array.isArray(rule.file) ? rule.file : [rule.file];
+        for (const file of files) {
+          if (!existsSync5(file)) {
+            throw new Error(`Rule file not found: ${file}`);
+          }
         }
       }
       if (this.config.commands) {
@@ -2801,7 +2830,8 @@ class AIRulesCore {
         if (customPath) {
           paths.push(customPath);
         } else {
-          const ruleName = rule.file.split("/").pop()?.replace(".md", "") || "rule";
+          const firstFile = Array.isArray(rule.file) ? rule.file[0] : rule.file;
+          const ruleName = firstFile.split("/").pop()?.replace(".md", "") || "rule";
           const agentPath = getAgentPath(agentName, ruleName);
           let fullPath = `${rule.to}/${agentPath}`.replace(/\/+/g, "/");
           if (fullPath.startsWith("./")) {
@@ -2914,6 +2944,7 @@ Original error: ${jitiError}`);
     });
     c.configDir = c.configDir || ".glooit";
     c.mergeMcps = c.mergeMcps ?? true;
+    c.gitignore = c.gitignore ?? true;
     if (c.backup) {
       const backup = c.backup;
       backup.enabled = backup.enabled ?? true;
@@ -2933,8 +2964,10 @@ Original error: ${jitiError}`);
       throw new Error(`Rule at index ${index}: Rule must be an object`);
     }
     const r = rule;
-    if (typeof r.file !== "string") {
-      throw new Error(`Rule at index ${index}: Rule.file must be a string`);
+    const isFileString = typeof r.file === "string";
+    const isFileArray = Array.isArray(r.file) && r.file.length > 0 && r.file.every((f) => typeof f === "string");
+    if (!isFileString && !isFileArray) {
+      throw new Error(`Rule at index ${index}: Rule.file must be a string or a non-empty array of strings`);
     }
     if (typeof r.to !== "string") {
       throw new Error(`Rule at index ${index}: Rule.to must be a string`);
@@ -2955,6 +2988,14 @@ Original error: ${jitiError}`);
     })) {
       throw new Error(`Rule at index ${index}: Rule.targets must contain valid agents: ${validAgentNames.join(", ")}, or objects with {name, to?}`);
     }
+    if (isFileArray) {
+      const allTargetsAreObjects = r.targets.every((agent) => {
+        return typeof agent === "object" && agent !== null && "name" in agent && "to" in agent;
+      });
+      if (!allTargetsAreObjects) {
+        throw new Error(`Rule at index ${index}: When using file array (merge mode), all targets must be objects with {name, to} properties`);
+      }
+    }
   }
   static createInitialConfig() {
     return this.createTypedConfig();
@@ -2998,12 +3039,15 @@ class ConfigValidator {
   static async validate(config) {
     const errors = [];
     for (const [index, rule] of config.rules.entries()) {
-      if (!existsSync7(rule.file)) {
-        errors.push({
-          field: `rules[${index}].file`,
-          message: `Rule file not found: ${rule.file}`,
-          path: rule.file
-        });
+      const files = Array.isArray(rule.file) ? rule.file : [rule.file];
+      for (const file of files) {
+        if (!existsSync7(file)) {
+          errors.push({
+            field: `rules[${index}].file`,
+            message: `Rule file not found: ${file}`,
+            path: file
+          });
+        }
       }
       if (rule.targets.length === 0) {
         errors.push({
@@ -3351,7 +3395,7 @@ function constructCommand(value, args) {
 import { execSync } from "child_process";
 import { createInterface } from "readline";
 // package.json
-var version = "0.5.4";
+var version = "0.5.6";
 
 // src/cli/index.ts
 var args = process.argv.slice(2);

package/dist/index.js

@@ -3388,8 +3388,10 @@ function validateRule(rule) {
     throw new Error("Rule must be an object");
   }
   const r = rule;
-  if (typeof r.file !== "string") {
-    throw new Error("Rule.file must be a string");
+  const isFileString = typeof r.file === "string";
+  const isFileArray = Array.isArray(r.file) && r.file.length > 0 && r.file.every((f) => typeof f === "string");
+  if (!isFileString && !isFileArray) {
+    throw new Error("Rule.file must be a string or a non-empty array of strings");
   }
   if (typeof r.to !== "string") {
     throw new Error("Rule.to must be a string");
@@ -3400,6 +3402,14 @@ function validateRule(rule) {
   if (!r.targets.every(isValidAgent)) {
     throw new Error("Rule.targets must contain valid agents: claude, cursor, codex, roocode, generic, or objects with {name, to?}");
   }
+  if (isFileArray) {
+    const allTargetsAreObjects = r.targets.every((target) => {
+      return typeof target === "object" && target !== null && "name" in target && "to" in target;
+    });
+    if (!allTargetsAreObjects) {
+      throw new Error("When using file array (merge mode), all targets must be objects with {name, to} properties");
+    }
+  }
 }
 function validateConfig(config) {
   if (!config || typeof config !== "object") {
@@ -3418,6 +3428,7 @@ function validateConfig(config) {
   });
   c.configDir = c.configDir || ".glooit";
   c.mergeMcps = c.mergeMcps ?? true;
+  c.gitignore = c.gitignore ?? true;
   if (c.backup) {
     const backup = c.backup;
     backup.enabled = backup.enabled ?? true;
@@ -3522,7 +3533,8 @@ import { existsSync as existsSync2, readFileSync as readFileSync2 } from "fs";
 
 class CursorWriter {
   formatContent(content, rule) {
-    const ruleName = this.extractRuleName(rule.file);
+    const firstFile = Array.isArray(rule.file) ? rule.file[0] : rule.file;
+    const ruleName = this.extractRuleName(firstFile);
     const hasGlobs = rule.globs && rule.globs.length > 0;
     const frontmatter = [
       "---",
@@ -3644,7 +3656,8 @@ class AgentDistributor {
     this.config = config;
   }
   async distributeRule(rule) {
-    const content = this.loadRuleContent(rule.file);
+    const filePath = Array.isArray(rule.file) ? rule.file : [rule.file];
+    const content = this.loadRuleContent(filePath);
     for (const agent of rule.targets) {
       await this.distributeToAgent(agent, rule, content);
     }
@@ -3662,7 +3675,8 @@ class AgentDistributor {
     if (customPath) {
       targetPath = customPath;
     } else {
-      const ruleName = this.extractRuleName(rule.file);
+      const firstFile = Array.isArray(rule.file) ? rule.file[0] : rule.file;
+      const ruleName = this.extractRuleName(firstFile);
       const agentPath = getAgentPath(agentName, ruleName);
       targetPath = join2(rule.to, agentPath);
     }
@@ -3679,11 +3693,27 @@ class AgentDistributor {
     const finalContent = await this.applyHooks(context);
     writeFileSync(targetPath, finalContent, "utf-8");
   }
-  loadRuleContent(filePath) {
+  loadRuleContent(filePaths) {
     try {
-      return readFileSync3(filePath, "utf-8");
+      if (filePaths.length === 1) {
+        return readFileSync3(filePaths[0], "utf-8");
+      }
+      const mergedContent = [];
+      for (let i = 0;i < filePaths.length; i++) {
+        const filePath = filePaths[i];
+        const content = readFileSync3(filePath, "utf-8");
+        mergedContent.push(`<!-- Source: ${filePath} -->`);
+        mergedContent.push(content);
+        if (i < filePaths.length - 1) {
+          mergedContent.push(`
+---
+`);
+        }
+      }
+      return mergedContent.join(`
+`);
     } catch (error) {
-      throw new Error(`Failed to read rule file ${filePath}: ${error}`);
+      throw new Error(`Failed to read rule file(s): ${error}`);
     }
   }
   extractRuleName(filePath) {
@@ -3864,15 +3894,22 @@ class GitIgnoreManager {
     writeFileSync3(this.gitignorePath, cleanedContent, "utf-8");
   }
   collectGeneratedPaths() {
+    if (this.config.gitignore === false) {
+      return [];
+    }
     const paths = new Set;
     for (const rule of this.config.rules) {
+      if (rule.gitignore === false) {
+        continue;
+      }
       for (const agent of rule.targets) {
         const agentName = this.getAgentName(agent);
         const customPath = this.getCustomPath(agent);
         if (customPath) {
           paths.add(customPath);
         } else {
-          const ruleName = this.extractRuleName(rule.file);
+          const filePath = Array.isArray(rule.file) ? rule.file[0] : rule.file;
+          const ruleName = this.extractRuleName(filePath);
           const agentPath = getAgentPath(agentName, ruleName);
           const fullPath = `${rule.to}/${agentPath}`.replace(/\/+/g, "/");
           paths.add(fullPath);
@@ -4014,8 +4051,11 @@ class AIRulesCore {
   async validate() {
     try {
       for (const rule of this.config.rules) {
-        if (!existsSync5(rule.file)) {
-          throw new Error(`Rule file not found: ${rule.file}`);
+        const files = Array.isArray(rule.file) ? rule.file : [rule.file];
+        for (const file of files) {
+          if (!existsSync5(file)) {
+            throw new Error(`Rule file not found: ${file}`);
+          }
         }
       }
       if (this.config.commands) {
@@ -4109,7 +4149,8 @@ class AIRulesCore {
         if (customPath) {
           paths.push(customPath);
         } else {
-          const ruleName = rule.file.split("/").pop()?.replace(".md", "") || "rule";
+          const firstFile = Array.isArray(rule.file) ? rule.file[0] : rule.file;
+          const ruleName = firstFile.split("/").pop()?.replace(".md", "") || "rule";
           const agentPath = getAgentPath(agentName, ruleName);
           let fullPath = `${rule.to}/${agentPath}`.replace(/\/+/g, "/");
           if (fullPath.startsWith("./")) {
@@ -4221,6 +4262,7 @@ Original error: ${jitiError}`);
     });
     c.configDir = c.configDir || ".glooit";
     c.mergeMcps = c.mergeMcps ?? true;
+    c.gitignore = c.gitignore ?? true;
     if (c.backup) {
       const backup = c.backup;
       backup.enabled = backup.enabled ?? true;
@@ -4240,8 +4282,10 @@ Original error: ${jitiError}`);
       throw new Error(`Rule at index ${index}: Rule must be an object`);
     }
     const r = rule;
-    if (typeof r.file !== "string") {
-      throw new Error(`Rule at index ${index}: Rule.file must be a string`);
+    const isFileString = typeof r.file === "string";
+    const isFileArray = Array.isArray(r.file) && r.file.length > 0 && r.file.every((f) => typeof f === "string");
+    if (!isFileString && !isFileArray) {
+      throw new Error(`Rule at index ${index}: Rule.file must be a string or a non-empty array of strings`);
     }
     if (typeof r.to !== "string") {
       throw new Error(`Rule at index ${index}: Rule.to must be a string`);
@@ -4262,6 +4306,14 @@ Original error: ${jitiError}`);
     })) {
       throw new Error(`Rule at index ${index}: Rule.targets must contain valid agents: ${validAgentNames.join(", ")}, or objects with {name, to?}`);
     }
+    if (isFileArray) {
+      const allTargetsAreObjects = r.targets.every((agent) => {
+        return typeof agent === "object" && agent !== null && "name" in agent && "to" in agent;
+      });
+      if (!allTargetsAreObjects) {
+        throw new Error(`Rule at index ${index}: When using file array (merge mode), all targets must be objects with {name, to} properties`);
+      }
+    }
   }
   static createInitialConfig() {
     return this.createTypedConfig();

package/dist/types/index.d.ts

@@ -4,14 +4,22 @@ export interface AgentTarget {
     to?: string;
 }
 export type Agent = AgentName | AgentTarget;
-export interface Rule {
+interface BaseRule {
     name?: string;
-    file: string;
     to: string;
     globs?: string;
-    targets: Agent[];
     hooks?: string[];
+    gitignore?: boolean;
+}
+export interface SingleFileRule extends BaseRule {
+    file: string;
+    targets: Agent[];
+}
+export interface MergedFileRule extends BaseRule {
+    file: string[];
+    targets: AgentTarget[];
 }
+export type Rule = SingleFileRule | MergedFileRule;
 export interface Command {
     command: string;
     file: string;
@@ -56,6 +64,7 @@ export interface Config {
     mergeMcps?: boolean;
     hooks?: Hooks;
     backup?: BackupConfig;
+    gitignore?: boolean;
 }
 export interface AgentMapping {
     path: string;
@@ -78,3 +87,4 @@ export interface BackupEntry {
     }[];
 }
 export declare function defineRules(config: Config): Config;
+export {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "glooit",
-  "version": "0.5.4",
+  "version": "0.5.6",
   "description": "🧴 Sync your AI agent configurations and rules across platforms with ease",
   "main": "dist/index.js",
   "module": "dist/index.js",
@@ -24,6 +24,7 @@
     "format": "oxlint src tests --fix",
     "check": "bun run typecheck && bun run lint && bun run test",
     "taze": "bunx taze",
+    "release": "bun run check && npx bumpp && git push --follow-tags",
     "prepublishOnly": "bun run check && bun run build",
     "install:local": "bun run build:binary && sudo mv bin/glooit /usr/local/bin/"
   },