autosnippet 3.0.0 → 3.0.2

package/lib/service/snippet/SnippetInstaller.js

@@ -1,43 +1,76 @@
 /**
- * SnippetInstaller — Xcode .codesnippet 安装器
- * 将生成的 snippet 文件写入 Xcode CodeSnippets 目录
+ * SnippetInstaller — Codec 驱动的 Snippet 安装器
+ *
+ * 支持:
+ *   - Xcode: 每个 snippet 一个 .codesnippet 文件
+ *   - VSCode: 所有 snippets 合并为单个 .code-snippets JSON 文件
+ *
+ * 行为由注入的 SnippetCodec 决定。
  */
 
-import { writeFileSync, mkdirSync, existsSync, readdirSync, unlinkSync } from 'node:fs';
+import { existsSync, mkdirSync, readdirSync, readFileSync, unlinkSync, writeFileSync } from 'node:fs';
 import { join } from 'node:path';
-import { homedir } from 'node:os';
-
-const XCODE_SNIPPETS_DIR = join(
-  homedir(),
-  'Library/Developer/Xcode/UserData/CodeSnippets'
-);
 
 export class SnippetInstaller {
-  #snippetsDir;
+  #codec;
   #snippetFactory;
+  #snippetsDirOverride;
 
+  /**
+   * @param {object} options
+   * @param {import('./codecs/SnippetCodec.js').SnippetCodec} options.codec — IDE codec
+   * @param {import('./SnippetFactory.js').SnippetFactory} [options.snippetFactory]
+   * @param {string} [options.snippetsDir] — 覆盖 codec 默认目录
+   */
   constructor(options = {}) {
-    this.#snippetsDir = options.snippetsDir || XCODE_SNIPPETS_DIR;
+    this.#codec = options.codec || null;
     this.#snippetFactory = options.snippetFactory || null;
+    this.#snippetsDirOverride = options.snippetsDir || null;
+  }
+
+  /** codec ID ('xcode' | 'vscode') */
+  get target() {
+    return this.#codec?.id || 'unknown';
+  }
+
+  /** 当前安装目录 */
+  get snippetsDir() {
+    return this.#snippetsDirOverride || this.#codec?.getInstallDir(process.cwd()) || '';
+  }
+
+  setSnippetFactory(factory) {
+    this.#snippetFactory = factory;
   }
 
-  setSnippetFactory(factory) { this.#snippetFactory = factory; }
+  setCodec(codec) {
+    this.#codec = codec;
+  }
+
+  // ─────────────── 安装 ───────────────
 
   /**
-   * 安装单个 snippet
-   * @param {object} spec — { identifier, title, completion, summary, code, language }
+   * 安装单个 snippet spec
+   * @param {object} spec — SnippetSpec
+   * @param {string} [projectRoot] — VSCode 需要 projectRoot 确定 .vscode/ 路径
    * @returns {{ success: boolean, path: string, message: string }}
    */
-  install(spec) {
-    if (!this.#snippetFactory) throw new Error('SnippetFactory not set');
-
+  install(spec, projectRoot) {
+    this.#assertCodec();
     try {
-      this.#ensureDir();
-      const xml = this.#snippetFactory.generate(spec);
-      const filename = `${spec.identifier}.codesnippet`;
-      const filePath = join(this.#snippetsDir, filename);
+      const dir = this.#resolveDir(projectRoot);
+      this.#ensureDir(dir);
 
-      writeFileSync(filePath, xml);
+      const bundleFilename = this.#codec.getBundleFilename();
+      if (bundleFilename) {
+        // Bundle 模式 (VSCode): merge into single JSON file
+        return this.#installToBundle(spec, dir, bundleFilename);
+      }
+
+      // Per-file 模式 (Xcode): 每个 snippet 一个文件
+      const content = this.#codec.generate(spec);
+      const filename = `${spec.identifier}${this.#codec.fileExtension}`;
+      const filePath = join(dir, filename);
+      writeFileSync(filePath, content);
       return { success: true, path: filePath, message: `Installed: ${filename}` };
     } catch (error) {
       return { success: false, path: '', message: error.message };
@@ -46,88 +79,227 @@ export class SnippetInstaller {
 
   /**
    * 从 Recipe 批量安装
-   * @param {Array} recipes — [{ id, title, trigger, code, description, language }]
+   * @param {Array} recipes
+   * @param {string} [projectRoot]
    * @returns {{ success: boolean, count: number, successCount: number, errorCount: number, details: Array }}
    */
-  installFromRecipes(recipes) {
-    if (!this.#snippetFactory) throw new Error('SnippetFactory not set');
+  installFromRecipes(recipes, projectRoot) {
+    this.#assertCodec();
+    this.#assertFactory();
+
+    const dir = this.#resolveDir(projectRoot);
+    this.#ensureDir(dir);
+
+    const specs = recipes.map((r) => this.#snippetFactory.fromRecipe(r));
+    const bundleFilename = this.#codec.getBundleFilename();
 
-    this.#ensureDir();
+    if (bundleFilename) {
+      // Bundle 模式: 一次性写入整个 bundle
+      return this.#installBundleFromSpecs(specs, dir, bundleFilename, recipes.length);
+    }
+
+    // Per-file 模式
     const details = [];
     let successCount = 0;
     let errorCount = 0;
 
-    for (const recipe of recipes) {
-      try {
-        const spec = this.#snippetFactory.fromRecipe(recipe);
-        const result = this.install(spec);
-        details.push(result);
-        if (result.success) successCount++;
-        else errorCount++;
-      } catch (error) {
-        details.push({ success: false, path: '', message: error.message });
-        errorCount++;
-      }
+    for (const spec of specs) {
+      const result = this.install(spec, projectRoot);
+      details.push(result);
+      if (result.success) successCount++;
+      else errorCount++;
     }
 
-    return {
-      success: errorCount === 0,
-      count: recipes.length,
-      successCount,
-      errorCount,
-      details,
-    };
+    return { success: errorCount === 0, count: recipes.length, successCount, errorCount, details };
   }
 
+  // ─────────────── 查询 ───────────────
+
   /**
    * 列出已安装的 AutoSnippet 管理的 snippet
+   * @param {string} [projectRoot]
    * @returns {Array<{ filename: string, path: string }>}
    */
-  listInstalled() {
-    if (!existsSync(this.#snippetsDir)) return [];
+  listInstalled(projectRoot) {
+    const dir = this.#resolveDir(projectRoot);
+    if (!existsSync(dir)) return [];
+
+    const bundleFilename = this.#codec?.getBundleFilename();
+    if (bundleFilename) {
+      // VSCode: 检查 bundle 文件是否存在
+      const bundlePath = join(dir, bundleFilename);
+      if (!existsSync(bundlePath)) return [];
+      try {
+        const content = JSON.parse(readFileSync(bundlePath, 'utf-8'));
+        return Object.keys(content).map((key) => ({
+          filename: key,
+          path: bundlePath,
+        }));
+      } catch {
+        return [];
+      }
+    }
 
-    return readdirSync(this.#snippetsDir)
-      .filter(f => f.startsWith('com.autosnippet.') && f.endsWith('.codesnippet'))
-      .map(f => ({ filename: f, path: join(this.#snippetsDir, f) }));
+    // Xcode: 列出 com.autosnippet.*.codesnippet 文件
+    return readdirSync(dir)
+      .filter((f) => f.startsWith('com.autosnippet.') && f.endsWith(this.#codec?.fileExtension || '.codesnippet'))
+      .map((f) => ({ filename: f, path: join(dir, f) }));
   }
 
+  // ─────────────── 卸载 ───────────────
+
   /**
    * 卸载指定 snippet
    * @param {string} identifier
+   * @param {string} [projectRoot]
    * @returns {{ success: boolean, message: string }}
    */
-  uninstall(identifier) {
-    const filename = identifier.endsWith('.codesnippet') ? identifier : `${identifier}.codesnippet`;
-    const filePath = join(this.#snippetsDir, filename);
+  uninstall(identifier, projectRoot) {
+    const dir = this.#resolveDir(projectRoot);
+    const bundleFilename = this.#codec?.getBundleFilename();
+
+    if (bundleFilename) {
+      // VSCode: 从 bundle JSON 中移除对应 key
+      return this.#removeFromBundle(identifier, dir, bundleFilename);
+    }
 
+    // Xcode: 删除单个文件
+    const ext = this.#codec?.fileExtension || '.codesnippet';
+    const filename = identifier.endsWith(ext) ? identifier : `${identifier}${ext}`;
+    const filePath = join(dir, filename);
     if (!existsSync(filePath)) {
       return { success: false, message: `Not found: ${filename}` };
     }
-
     unlinkSync(filePath);
     return { success: true, message: `Uninstalled: ${filename}` };
   }
 
   /**
    * 清除所有 AutoSnippet 管理的 snippet
+   * @param {string} [projectRoot]
    * @returns {{ success: boolean, removed: number }}
    */
-  cleanAll() {
-    const installed = this.listInstalled();
-    let removed = 0;
+  cleanAll(projectRoot) {
+    const dir = this.#resolveDir(projectRoot);
+    const bundleFilename = this.#codec?.getBundleFilename();
 
-    for (const { path } of installed) {
-      try { unlinkSync(path); removed++; } catch { /* ignore */ }
+    if (bundleFilename) {
+      // VSCode: 删除整个 bundle 文件
+      const bundlePath = join(dir, bundleFilename);
+      if (existsSync(bundlePath)) {
+        unlinkSync(bundlePath);
+        return { success: true, removed: 1 };
+      }
+      return { success: true, removed: 0 };
     }
 
+    // Xcode: 删除所有 com.autosnippet.* 文件
+    const installed = this.listInstalled(projectRoot);
+    let removed = 0;
+    for (const { path: filePath } of installed) {
+      try {
+        unlinkSync(filePath);
+        removed++;
+      } catch {
+        /* ignore */
+      }
+    }
     return { success: true, removed };
   }
 
-  get snippetsDir() { return this.#snippetsDir; }
+  // ─────────────── Private ───────────────
+
+  #assertCodec() {
+    if (!this.#codec) throw new Error('SnippetCodec not set');
+  }
+
+  #assertFactory() {
+    if (!this.#snippetFactory) throw new Error('SnippetFactory not set');
+  }
+
+  #resolveDir(projectRoot) {
+    if (this.#snippetsDirOverride) return this.#snippetsDirOverride;
+    return this.#codec?.getInstallDir(projectRoot || process.cwd()) || '';
+  }
+
+  #ensureDir(dir) {
+    if (!existsSync(dir)) {
+      mkdirSync(dir, { recursive: true });
+    }
+  }
+
+  /**
+   * VSCode bundle: 将单个 spec 追加/更新到 bundle JSON
+   */
+  #installToBundle(spec, dir, bundleFilename) {
+    const bundlePath = join(dir, bundleFilename);
+    let bundle = {};
+    if (existsSync(bundlePath)) {
+      try {
+        bundle = JSON.parse(readFileSync(bundlePath, 'utf-8'));
+      } catch {
+        bundle = {};
+      }
+    }
 
-  #ensureDir() {
-    if (!existsSync(this.#snippetsDir)) {
-      mkdirSync(this.#snippetsDir, { recursive: true });
+    const key = `Recipe: ${spec.title || spec.identifier}`;
+    const content = JSON.parse(this.#codec.generate(spec));
+    const entryKey = Object.keys(content)[0];
+    bundle[key] = content[entryKey];
+
+    writeFileSync(bundlePath, JSON.stringify(bundle, null, 2) + '\n');
+    return { success: true, path: bundlePath, message: `Installed: ${key}` };
+  }
+
+  /**
+   * VSCode bundle: 一次性写入完整 bundle
+   */
+  #installBundleFromSpecs(specs, dir, bundleFilename, totalCount) {
+    try {
+      const content = this.#codec.generateBundle(specs);
+      const bundlePath = join(dir, bundleFilename);
+      writeFileSync(bundlePath, content);
+      return {
+        success: true,
+        count: totalCount,
+        successCount: totalCount,
+        errorCount: 0,
+        details: [{ success: true, path: bundlePath, message: `Bundle: ${totalCount} snippets` }],
+      };
+    } catch (error) {
+      return {
+        success: false,
+        count: totalCount,
+        successCount: 0,
+        errorCount: totalCount,
+        details: [{ success: false, path: '', message: error.message }],
+      };
+    }
+  }
+
+  /**
+   * VSCode bundle: 从 JSON 中移除一个 snippet
+   */
+  #removeFromBundle(identifier, dir, bundleFilename) {
+    const bundlePath = join(dir, bundleFilename);
+    if (!existsSync(bundlePath)) {
+      return { success: false, message: `Bundle not found: ${bundleFilename}` };
+    }
+
+    try {
+      const bundle = JSON.parse(readFileSync(bundlePath, 'utf-8'));
+      // 按 identifier 或 title 匹配
+      const keyToRemove = Object.keys(bundle).find(
+        (k) => k.includes(identifier) || k === `Recipe: ${identifier}`
+      );
+      if (!keyToRemove) {
+        return { success: false, message: `Snippet not found in bundle: ${identifier}` };
+      }
+      delete bundle[keyToRemove];
+      writeFileSync(bundlePath, JSON.stringify(bundle, null, 2) + '\n');
+      return { success: true, message: `Uninstalled: ${keyToRemove}` };
+    } catch (error) {
+      return { success: false, message: error.message };
     }
   }
 }

package/lib/service/snippet/codecs/SnippetCodec.js

@@ -0,0 +1,67 @@
+/**
+ * SnippetCodec — IDE Snippet 格式抽象接口
+ *
+ * 子类实现:
+ *   - XcodeCodec  (.codesnippet plist XML)
+ *   - VSCodeCodec (.code-snippets JSON, 兼容 Cursor)
+ *
+ * SnippetSpec 结构 (IDE 无关中间表示):
+ *   { identifier, title, completion, summary, code, language }
+ */
+export class SnippetCodec {
+  /** @returns {string} codec 标识 ('xcode' | 'vscode') */
+  get id() {
+    throw new Error('SnippetCodec.id is abstract');
+  }
+
+  /** @returns {string} 输出文件的扩展名 ('.codesnippet' | '.code-snippets') */
+  get fileExtension() {
+    throw new Error('SnippetCodec.fileExtension is abstract');
+  }
+
+  /**
+   * 单个 SnippetSpec → IDE 格式字符串
+   * @param {object} spec
+   * @returns {string}
+   */
+  generate(spec) {
+    throw new Error('SnippetCodec.generate() is abstract');
+  }
+
+  /**
+   * 批量 specs → IDE 格式输出
+   *   Xcode:  返回 Array<{ filename, content }>（每个 snippet 一个文件）
+   *   VSCode: 返回 string（单个 JSON bundle 文件内容）
+   * @param {object[]} specs
+   * @returns {string | Array<{ filename: string, content: string }>}
+   */
+  generateBundle(specs) {
+    throw new Error('SnippetCodec.generateBundle() is abstract');
+  }
+
+  /**
+   * 目标 snippet 安装目录路径
+   * @param {string} [projectRoot]
+   * @returns {string}
+   */
+  getInstallDir(projectRoot) {
+    throw new Error('SnippetCodec.getInstallDir() is abstract');
+  }
+
+  /**
+   * AutoSnippet 语言标识 → IDE 语言标识映射
+   * @param {string} lang
+   * @returns {string}
+   */
+  mapLanguage(lang) {
+    throw new Error('SnippetCodec.mapLanguage() is abstract');
+  }
+
+  /**
+   * 获取 bundle 文件名 (VSCode = 'autosnippet.code-snippets', Xcode = per-file)
+   * @returns {string|null}
+   */
+  getBundleFilename() {
+    return null;
+  }
+}

package/lib/service/snippet/codecs/VSCodeCodec.js

@@ -0,0 +1,102 @@
+/**
+ * VSCodeCodec — VSCode .code-snippets (JSON) 生成器
+ *
+ * 特性:
+ *   - 项目级 .vscode/autosnippet.code-snippets 单 bundle 文件
+ *   - 兼容 Cursor (100% VSCode snippet 格式)
+ *   - Xcode 占位符 <#…#> 自动转换为 VSCode ${N:…}
+ *   - 多语言 scope 自动映射
+ */
+
+import { join } from 'node:path';
+import { SnippetCodec } from './SnippetCodec.js';
+import { PlaceholderConverter } from '../PlaceholderConverter.js';
+
+/** AutoSnippet language → VSCode snippet scope */
+const VSCODE_LANGUAGE_MAP = {
+  swift: 'swift',
+  'objective-c': 'objective-c',
+  objc: 'objective-c',
+  c: 'c',
+  'c++': 'cpp',
+  go: 'go',
+  python: 'python',
+  java: 'java',
+  kotlin: 'kotlin',
+  javascript: 'javascript,javascriptreact',
+  typescript: 'typescript,typescriptreact',
+  rust: 'rust',
+  ruby: 'ruby',
+};
+
+const BUNDLE_FILENAME = 'autosnippet.code-snippets';
+
+export class VSCodeCodec extends SnippetCodec {
+  get id() {
+    return 'vscode';
+  }
+
+  get fileExtension() {
+    return '.code-snippets';
+  }
+
+  /**
+   * 单个 SnippetSpec → JSON 字符串
+   */
+  generate(spec) {
+    const entry = this.#specToEntry(spec);
+    return JSON.stringify({ [spec.title || spec.identifier]: entry }, null, 2);
+  }
+
+  /**
+   * VSCode: 所有 snippets 合并为单个 JSON bundle 文件
+   * @returns {string} JSON 字符串
+   */
+  generateBundle(specs) {
+    const bundle = {};
+    for (const spec of specs) {
+      const key = `Recipe: ${spec.title || spec.identifier}`;
+      bundle[key] = this.#specToEntry(spec);
+    }
+    return JSON.stringify(bundle, null, 2) + '\n';
+  }
+
+  /**
+   * VSCode snippets 安装目录 = 项目级 .vscode/
+   */
+  getInstallDir(projectRoot) {
+    return join(projectRoot, '.vscode');
+  }
+
+  mapLanguage(lang) {
+    return VSCODE_LANGUAGE_MAP[lang?.toLowerCase()] || '';
+  }
+
+  getBundleFilename() {
+    return BUNDLE_FILENAME;
+  }
+
+  /**
+   * @private SnippetSpec → VSCode snippet entry
+   */
+  #specToEntry(spec) {
+    const code = Array.isArray(spec.code) ? spec.code.join('\n') : spec.code || '';
+    // 自动将 Xcode 占位符转为 VSCode 格式
+    const converted = PlaceholderConverter.xcodeToVSCode(code);
+    const body = converted.split('\n');
+
+    const entry = {
+      prefix: spec.completion || spec.trigger || spec.identifier,
+      body,
+      description: spec.summary || '',
+    };
+
+    // 添加语言 scope (空字符串 = 所有语言)
+    const scope = this.mapLanguage(spec.language);
+    if (scope) {
+      entry.scope = scope;
+    }
+
+    return entry;
+  }
+}

package/lib/service/snippet/codecs/XcodeCodec.js

@@ -0,0 +1,5 @@
+/**
+ * @deprecated Moved to lib/platform/ios/snippet/XcodeCodec.js
+ * This re-export shim maintains backward compatibility.
+ */
+export { XcodeCodec } from '../../../platform/ios/snippet/XcodeCodec.js';