@dezkareid/ai-context-sync 1.2.0 → 1.3.0

package/dist/engine.js

@@ -10,34 +10,44 @@ const constants_js_1 = require("./constants.js");
 const claude_js_1 = require("./strategies/claude.js");
 const gemini_js_1 = require("./strategies/gemini.js");
 const gemini_md_js_1 = require("./strategies/gemini-md.js");
+const other_js_1 = require("./strategies/other.js");
 class SyncEngine {
-    allStrategies = [
-        new claude_js_1.ClaudeStrategy(),
-        new gemini_js_1.GeminiStrategy(),
-        new gemini_md_js_1.GeminiMdStrategy()
-    ];
-    async sync(projectRoot, selectedStrategies, targetDir) {
-        const agentsPath = path_1.default.join(projectRoot, constants_js_1.AGENTS_FILENAME);
+    async sync(projectRoot, selectedStrategies, targetDir, fromFile, otherFiles) {
+        const sourceFile = fromFile ?? constants_js_1.AGENTS_FILENAME;
+        const agentsPath = path_1.default.join(projectRoot, sourceFile);
         const outputDir = targetDir ?? projectRoot;
         if (!(await fs_extra_1.default.pathExists(agentsPath))) {
-            throw new Error(`${constants_js_1.AGENTS_FILENAME} not found in ${projectRoot}`);
+            throw new Error(`${sourceFile} not found in ${projectRoot}`);
         }
         const context = await fs_extra_1.default.readFile(agentsPath, 'utf-8');
+        const builtInStrategies = [
+            new claude_js_1.ClaudeStrategy(fromFile),
+            new gemini_js_1.GeminiStrategy(fromFile),
+            new gemini_md_js_1.GeminiMdStrategy(fromFile)
+        ];
         let strategiesToRun;
         if (!selectedStrategies || (Array.isArray(selectedStrategies) && selectedStrategies.length === 0)) {
-            strategiesToRun = this.allStrategies;
+            strategiesToRun = builtInStrategies;
         }
         else {
             const selectedList = Array.isArray(selectedStrategies) ? selectedStrategies : [selectedStrategies];
             const normalizedList = selectedList.map(s => s.toLowerCase());
             if (normalizedList.includes('all') || normalizedList.includes('both')) {
-                strategiesToRun = this.allStrategies;
+                strategiesToRun = builtInStrategies;
             }
             else {
-                strategiesToRun = this.allStrategies.filter(s => normalizedList.includes(s.name.toLowerCase()));
+                strategiesToRun = builtInStrategies.filter(s => normalizedList.includes(s.name.toLowerCase()));
+            }
+            if (normalizedList.includes('other')) {
+                if (!otherFiles || otherFiles.length === 0) {
+                    throw new Error('Strategy "other" requires otherFiles to be specified.');
+                }
+                for (const filename of otherFiles) {
+                    strategiesToRun.push(new other_js_1.OtherStrategy(filename, fromFile));
+                }
             }
         }
-        const availableNames = this.allStrategies.map(s => s.name).join(', ');
+        const availableNames = [...builtInStrategies.map(s => s.name), 'other'].join(', ');
         if (strategiesToRun.length === 0 && selectedStrategies) {
             throw new Error(`No valid strategies found for: ${selectedStrategies}. Available strategies: ${availableNames}`);
         }

package/dist/engine.test.js

@@ -87,7 +87,82 @@ const os_1 = __importDefault(require("os"));
         const engine = new engine_js_1.SyncEngine();
         const agentsPath = path_1.default.join(tempDir, constants_js_1.AGENTS_FILENAME);
         await fs_extra_1.default.writeFile(agentsPath, '# Agent Context');
-        await (0, vitest_1.expect)(engine.sync(tempDir, 'invalid')).rejects.toThrow('No valid strategies found for: invalid. Available strategies: claude, gemini, gemini-md');
+        await (0, vitest_1.expect)(engine.sync(tempDir, 'invalid')).rejects.toThrow('No valid strategies found for: invalid. Available strategies: claude, gemini, gemini-md, other');
+    });
+    (0, vitest_1.describe)('otherFiles option', () => {
+        (0, vitest_1.it)('should create a symlink for a single otherFile', async () => {
+            const engine = new engine_js_1.SyncEngine();
+            const agentsPath = path_1.default.join(tempDir, constants_js_1.AGENTS_FILENAME);
+            await fs_extra_1.default.writeFile(agentsPath, '# Agent Context');
+            await engine.sync(tempDir, 'other', undefined, undefined, ['CURSOR.md']);
+            const cursorPath = path_1.default.join(tempDir, 'CURSOR.md');
+            (0, vitest_1.expect)(await fs_extra_1.default.pathExists(cursorPath)).toBe(true);
+            const stats = await fs_extra_1.default.lstat(cursorPath);
+            (0, vitest_1.expect)(stats.isSymbolicLink()).toBe(true);
+        });
+        (0, vitest_1.it)('should create symlinks for multiple otherFiles', async () => {
+            const engine = new engine_js_1.SyncEngine();
+            const agentsPath = path_1.default.join(tempDir, constants_js_1.AGENTS_FILENAME);
+            await fs_extra_1.default.writeFile(agentsPath, '# Agent Context');
+            await engine.sync(tempDir, ['other'], undefined, undefined, ['CURSOR.md', 'COPILOT.md']);
+            const cursorPath = path_1.default.join(tempDir, 'CURSOR.md');
+            const copilotPath = path_1.default.join(tempDir, 'COPILOT.md');
+            (0, vitest_1.expect)(await fs_extra_1.default.pathExists(cursorPath)).toBe(true);
+            (0, vitest_1.expect)(await fs_extra_1.default.pathExists(copilotPath)).toBe(true);
+        });
+        (0, vitest_1.it)('should throw descriptive error when strategy is "other" but otherFiles is not provided', async () => {
+            const engine = new engine_js_1.SyncEngine();
+            const agentsPath = path_1.default.join(tempDir, constants_js_1.AGENTS_FILENAME);
+            await fs_extra_1.default.writeFile(agentsPath, '# Agent Context');
+            await (0, vitest_1.expect)(engine.sync(tempDir, 'other')).rejects.toThrow('Strategy "other" requires otherFiles to be specified.');
+        });
+        (0, vitest_1.it)('should throw descriptive error when strategy is "other" but otherFiles is empty', async () => {
+            const engine = new engine_js_1.SyncEngine();
+            const agentsPath = path_1.default.join(tempDir, constants_js_1.AGENTS_FILENAME);
+            await fs_extra_1.default.writeFile(agentsPath, '# Agent Context');
+            await (0, vitest_1.expect)(engine.sync(tempDir, 'other', undefined, undefined, [])).rejects.toThrow('Strategy "other" requires otherFiles to be specified.');
+        });
+        (0, vitest_1.it)('should run both built-in and custom strategies when combined', async () => {
+            const engine = new engine_js_1.SyncEngine();
+            const agentsPath = path_1.default.join(tempDir, constants_js_1.AGENTS_FILENAME);
+            await fs_extra_1.default.writeFile(agentsPath, '# Agent Context');
+            await engine.sync(tempDir, ['claude', 'other'], undefined, undefined, ['CURSOR.md']);
+            const claudePath = path_1.default.join(tempDir, 'CLAUDE.md');
+            const cursorPath = path_1.default.join(tempDir, 'CURSOR.md');
+            (0, vitest_1.expect)(await fs_extra_1.default.pathExists(claudePath)).toBe(true);
+            (0, vitest_1.expect)(await fs_extra_1.default.pathExists(cursorPath)).toBe(true);
+        });
+    });
+    (0, vitest_1.describe)('fromFile option', () => {
+        (0, vitest_1.it)('should use a custom source file when fromFile is provided', async () => {
+            const engine = new engine_js_1.SyncEngine();
+            const customSource = 'MY_AGENTS.md';
+            const customSourcePath = path_1.default.join(tempDir, customSource);
+            await fs_extra_1.default.writeFile(customSourcePath, '# Custom Agent Context');
+            await engine.sync(tempDir, 'claude', undefined, customSource);
+            const claudePath = path_1.default.join(tempDir, 'CLAUDE.md');
+            (0, vitest_1.expect)(await fs_extra_1.default.pathExists(claudePath)).toBe(true);
+            const stats = await fs_extra_1.default.lstat(claudePath);
+            (0, vitest_1.expect)(stats.isSymbolicLink()).toBe(true);
+            // Symlink should resolve to the custom source file
+            const resolvedPath = await fs_extra_1.default.realpath(claudePath);
+            const expectedPath = await fs_extra_1.default.realpath(customSourcePath);
+            (0, vitest_1.expect)(resolvedPath).toBe(expectedPath);
+        });
+        (0, vitest_1.it)('should throw error when custom fromFile does not exist', async () => {
+            const engine = new engine_js_1.SyncEngine();
+            await (0, vitest_1.expect)(engine.sync(tempDir, 'claude', undefined, 'MISSING.md')).rejects.toThrow('MISSING.md not found in');
+        });
+        (0, vitest_1.it)('should use custom fromFile with other strategy', async () => {
+            const engine = new engine_js_1.SyncEngine();
+            const customSource = 'MY_AGENTS.md';
+            await fs_extra_1.default.writeFile(path_1.default.join(tempDir, customSource), '# Custom Agent Context');
+            await engine.sync(tempDir, 'other', undefined, customSource, ['CURSOR.md']);
+            const cursorPath = path_1.default.join(tempDir, 'CURSOR.md');
+            const resolvedPath = await fs_extra_1.default.realpath(cursorPath);
+            const expectedPath = await fs_extra_1.default.realpath(path_1.default.join(tempDir, customSource));
+            (0, vitest_1.expect)(resolvedPath).toBe(expectedPath);
+        });
     });
     (0, vitest_1.describe)('targetDir option', () => {
         let targetDir;

package/dist/index.js

@@ -21,6 +21,8 @@ program
     .option('-d, --dir <path>', 'Project directory (where AGENTS.md lives)', process.cwd())
     .option('-t, --target-dir <path>', 'Target directory where synced files will be written (defaults to --dir)')
     .option('-s, --strategy <strategy>', 'Sync strategy (claude, gemini, all, or comma-separated list)')
+    .option('-f, --files <names>', 'Comma-separated custom filenames for "other" strategy')
+    .option('--from <path>', 'Source file path for symlinks (default: AGENTS.md)')
     .option('--skip-config', 'Avoid reading/creating the config file', false)
     .action(async (options) => {
     try {
@@ -28,21 +30,41 @@ program
         const targetDir = options.targetDir ? path_1.default.resolve(options.targetDir) : projectRoot;
         const configPath = path_1.default.join(projectRoot, constants_js_1.CONFIG_FILENAME);
         let strategy = options.strategy;
+        let otherFiles;
+        let fromFile;
         // 1. If no strategy provided, try to read from config
-        if (!strategy && !options.skipConfig) {
+        if (!options.skipConfig) {
             if (await fs_extra_1.default.pathExists(configPath)) {
                 try {
                     const config = await fs_extra_1.default.readJson(configPath);
-                    if (config.strategies) {
+                    if (!strategy && config.strategies) {
                         strategy = config.strategies;
                     }
+                    if (config.otherFiles) {
+                        otherFiles = config.otherFiles;
+                    }
+                    if (config.from) {
+                        fromFile = config.from;
+                    }
                 }
                 catch (e) {
                     // Ignore corrupted config and proceed to prompt
                 }
             }
         }
-        // 2. If still no strategy, prompt user
+        // 2. Resolve --from flag (takes precedence over config)
+        if (options.from) {
+            if (path_1.default.isAbsolute(options.from)) {
+                throw new Error('--from must be a relative path, not an absolute path.');
+            }
+            fromFile = options.from;
+        }
+        // 3. Resolve --files flag (merge with config otherFiles)
+        if (options.files) {
+            const flagFiles = options.files.split(',').map((s) => s.trim()).filter(Boolean);
+            otherFiles = [...new Set([...(otherFiles ?? []), ...flagFiles])];
+        }
+        // 4. If still no strategy, prompt user
         if (!strategy) {
             const answers = await inquirer_1.default.prompt([
                 {
@@ -52,7 +74,8 @@ program
                     choices: [
                         { name: 'Claude (CLAUDE.md)', value: 'claude', checked: true },
                         { name: 'Gemini (.gemini/settings.json)', value: 'gemini', checked: true },
-                        { name: 'Gemini Markdown (GEMINI.md)', value: 'gemini-md', checked: true }
+                        { name: 'Gemini Markdown (GEMINI.md)', value: 'gemini-md', checked: true },
+                        { name: 'Other (custom files)', value: 'other', checked: false }
                     ],
                     validate: (answer) => {
                         if (answer.length < 1) {
@@ -63,16 +86,37 @@ program
                 }
             ]);
             strategy = answers.strategies;
+            // Follow-up prompt for custom filenames when 'other' is selected and not already set
+            if (strategy.includes('other') && (!otherFiles || otherFiles.length === 0)) {
+                const filesAnswer = await inquirer_1.default.prompt([
+                    {
+                        type: 'input',
+                        name: 'otherFiles',
+                        message: 'Enter custom file name(s) to create as symlinks (comma-separated):',
+                        validate: (v) => v.trim().length > 0 || 'At least one filename is required.'
+                    }
+                ]);
+                otherFiles = filesAnswer.otherFiles.split(',').map((s) => s.trim()).filter(Boolean);
+            }
         }
         else if (typeof strategy === 'string') {
             strategy = strategy.split(',').map(s => s.trim());
         }
-        // 3. Save strategy to config if not skipping
+        // 5. Validate: if 'other' strategy selected but no otherFiles resolved
+        if (Array.isArray(strategy) && strategy.includes('other') && (!otherFiles || otherFiles.length === 0)) {
+            throw new Error('Strategy "other" requires --files or a saved "otherFiles" config entry.');
+        }
+        // 6. Save strategy to config if not skipping
         if (!options.skipConfig) {
-            await fs_extra_1.default.writeJson(configPath, { strategies: strategy }, { spaces: 2 });
+            const configData = { strategies: strategy };
+            if (otherFiles?.length)
+                configData.otherFiles = otherFiles;
+            if (fromFile)
+                configData.from = fromFile;
+            await fs_extra_1.default.writeJson(configPath, configData, { spaces: 2 });
         }
         const engine = new engine_js_1.SyncEngine();
-        await engine.sync(projectRoot, strategy, targetDir);
+        await engine.sync(projectRoot, strategy, targetDir, fromFile, otherFiles);
         const strategyMsg = Array.isArray(strategy) ? strategy.join(', ') : strategy;
         console.log(`Successfully synchronized context files using "${strategyMsg}"!`);
     }

package/dist/strategies/claude.js

@@ -5,5 +5,8 @@ const symlink_js_1 = require("./symlink.js");
 class ClaudeStrategy extends symlink_js_1.SymlinkStrategy {
     name = 'claude';
     targetFilename = 'CLAUDE.md';
+    constructor(fromFile) {
+        super(fromFile);
+    }
 }
 exports.ClaudeStrategy = ClaudeStrategy;

package/dist/strategies/gemini-md.js

@@ -5,5 +5,8 @@ const symlink_js_1 = require("./symlink.js");
 class GeminiMdStrategy extends symlink_js_1.SymlinkStrategy {
     name = 'gemini-md';
     targetFilename = 'GEMINI.md';
+    constructor(fromFile) {
+        super(fromFile);
+    }
 }
 exports.GeminiMdStrategy = GeminiMdStrategy;

package/dist/strategies/gemini.js

@@ -9,12 +9,16 @@ const fs_extra_1 = __importDefault(require("fs-extra"));
 const path_1 = __importDefault(require("path"));
 class GeminiStrategy {
     name = 'gemini';
+    fromFile;
+    constructor(fromFile = index_js_1.AGENTS_FILE) {
+        this.fromFile = fromFile;
+    }
     async sync(_context, projectRoot, targetDir) {
         const outputDir = targetDir ?? projectRoot;
         const geminiDir = path_1.default.join(outputDir, '.gemini');
         const settingsPath = path_1.default.join(geminiDir, 'settings.json');
-        // Compute the path to AGENTS.md relative to the target .gemini directory
-        const agentsAbsPath = path_1.default.join(projectRoot, index_js_1.AGENTS_FILE);
+        // Compute the path to the source file relative to the target .gemini directory
+        const agentsAbsPath = path_1.default.join(projectRoot, this.fromFile);
         const agentsRelativePath = path_1.default.relative(outputDir, agentsAbsPath);
         await fs_extra_1.default.ensureDir(geminiDir);
         let settings = {};

package/dist/strategies/other.js

@@ -0,0 +1,13 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.OtherStrategy = void 0;
+const symlink_js_1 = require("./symlink.js");
+class OtherStrategy extends symlink_js_1.SymlinkStrategy {
+    name = 'other';
+    targetFilename;
+    constructor(targetFilename, fromFile) {
+        super(fromFile);
+        this.targetFilename = targetFilename;
+    }
+}
+exports.OtherStrategy = OtherStrategy;

package/dist/strategies/other.test.js

@@ -0,0 +1,58 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const vitest_1 = require("vitest");
+const other_js_1 = require("./other.js");
+const index_js_1 = require("./index.js");
+const fs_extra_1 = __importDefault(require("fs-extra"));
+const path_1 = __importDefault(require("path"));
+const os_1 = __importDefault(require("os"));
+(0, vitest_1.describe)('OtherStrategy', () => {
+    let tempDir;
+    (0, vitest_1.beforeEach)(async () => {
+        tempDir = await fs_extra_1.default.mkdtemp(path_1.default.join(os_1.default.tmpdir(), 'other-strategy-test-'));
+        await fs_extra_1.default.writeFile(path_1.default.join(tempDir, index_js_1.AGENTS_FILE), '# Agents');
+    });
+    (0, vitest_1.afterEach)(async () => {
+        await fs_extra_1.default.remove(tempDir);
+    });
+    (0, vitest_1.it)('should create a symlink with the correct targetFilename', async () => {
+        const strategy = new other_js_1.OtherStrategy('CURSOR.md');
+        await strategy.sync('', tempDir);
+        const targetPath = path_1.default.join(tempDir, 'CURSOR.md');
+        const stats = await fs_extra_1.default.lstat(targetPath);
+        (0, vitest_1.expect)(stats.isSymbolicLink()).toBe(true);
+        const target = await fs_extra_1.default.readlink(targetPath);
+        (0, vitest_1.expect)(target).toContain(index_js_1.AGENTS_FILE);
+    });
+    (0, vitest_1.it)('should use default AGENTS.md as source when fromFile is not provided', async () => {
+        const strategy = new other_js_1.OtherStrategy('COPILOT.md');
+        await strategy.sync('', tempDir);
+        const targetPath = path_1.default.join(tempDir, 'COPILOT.md');
+        const resolvedPath = await fs_extra_1.default.realpath(targetPath);
+        const expectedPath = await fs_extra_1.default.realpath(path_1.default.join(tempDir, index_js_1.AGENTS_FILE));
+        (0, vitest_1.expect)(resolvedPath).toBe(expectedPath);
+    });
+    (0, vitest_1.it)('should use custom fromFile when provided', async () => {
+        const customSource = 'MY_AGENTS.md';
+        await fs_extra_1.default.writeFile(path_1.default.join(tempDir, customSource), '# Custom Agents');
+        const strategy = new other_js_1.OtherStrategy('CURSOR.md', customSource);
+        await strategy.sync('', tempDir);
+        const targetPath = path_1.default.join(tempDir, 'CURSOR.md');
+        const stats = await fs_extra_1.default.lstat(targetPath);
+        (0, vitest_1.expect)(stats.isSymbolicLink()).toBe(true);
+        const resolvedPath = await fs_extra_1.default.realpath(targetPath);
+        const expectedPath = await fs_extra_1.default.realpath(path_1.default.join(tempDir, customSource));
+        (0, vitest_1.expect)(resolvedPath).toBe(expectedPath);
+    });
+    (0, vitest_1.it)('should have name "other"', () => {
+        const strategy = new other_js_1.OtherStrategy('CURSOR.md');
+        (0, vitest_1.expect)(strategy.name).toBe('other');
+    });
+    (0, vitest_1.it)('should expose the targetFilename', () => {
+        const strategy = new other_js_1.OtherStrategy('CUSTOM_FILE.md');
+        (0, vitest_1.expect)(strategy.targetFilename).toBe('CUSTOM_FILE.md');
+    });
+});

package/dist/strategies/symlink.js

@@ -8,11 +8,15 @@ const index_js_1 = require("./index.js");
 const fs_extra_1 = __importDefault(require("fs-extra"));
 const path_1 = __importDefault(require("path"));
 class SymlinkStrategy {
+    fromFile;
+    constructor(fromFile = index_js_1.AGENTS_FILE) {
+        this.fromFile = fromFile;
+    }
     async sync(_context, projectRoot, targetDir) {
         const outputDir = targetDir ?? projectRoot;
         const targetPath = path_1.default.join(outputDir, this.targetFilename);
-        // Compute the symlink value: relative path from outputDir to the AGENTS.md in projectRoot
-        const agentsAbsPath = path_1.default.join(projectRoot, index_js_1.AGENTS_FILE);
+        // Compute the symlink value: relative path from outputDir to the source file in projectRoot
+        const agentsAbsPath = path_1.default.join(projectRoot, this.fromFile);
         const symlinkTarget = path_1.default.relative(outputDir, agentsAbsPath);
         // Check if it exists and what type it is
         if (await fs_extra_1.default.pathExists(targetPath)) {
@@ -27,7 +31,7 @@ class SymlinkStrategy {
             // If it's a file or a link to somewhere else, remove it
             await fs_extra_1.default.remove(targetPath);
         }
-        // Create symlink pointing to AGENTS.md
+        // Create symlink pointing to the source file
         await fs_extra_1.default.ensureSymlink(symlinkTarget, targetPath);
     }
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dezkareid/ai-context-sync",
-  "version": "1.2.0",
+  "version": "1.3.0",
   "description": "CLI utility to synchronize AI agent context files from AGENTS.md",
   "main": "dist/index.js",
   "bin": {