template-syncer 1.0.2 → 1.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Icey Wu
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -2,20 +2,31 @@
 
 智能模板同步工具，让你的项目与模板仓库保持同步。
 
+<a href="https://github.com/iceywu/template-syncer">
+  <img alt="GitHub Repo stars" src="https://img.shields.io/github/stars/iceywu/template-syncer?logo=github&color=%234d80f0&link=https%3A%2F%2Fgithub.com%2iceywu%2Ftemplate-syncer">
+</a>
+<a href="https://www.npmjs.com/package/template-syncer">
+  <img alt="npm" src="https://img.shields.io/npm/v/template-syncer?logo=npm&color=%234d80f0&link=https%3A%2F%2Fwww.npmjs.com%2Fpackage%2Ftemplate-syncer">
+</a>
+<a href="https://www.npmjs.com/package/template-syncer">
+  <img alt="npm" src="https://img.shields.io/npm/dw/template-syncer?logo=npm&link=https%3A%2F%2Fwww.npmjs.com%2Fpackage%2Ftemplate-syncer">
+</a>
+
 ## ✨ 特性
 
 - 🚀 **智能同步** - 自动检测并同步模板更新
-- � **自动扫描** - 智能扫描当前目录的所有可同步文件
-- ✅ **批量选择** - 支持全选/反选，批量处理文件
-- 🔍 **智能对比** - 先对比差异，再选择性更新
-- �📦 **智能合并** - 特别针对 `package.json` 的智能合并策略
-- 🔄 **差异对比** - 使用 Git diff 显示文件变更
+- 🌍 **跨平台** - 完美支持 Windows/macOS/Linux
+- 📦 **智能合并** - package.json 等配置文件智能合并
+- 🎯 **自动分类** - 基于 glob 模式的智能文件分类
+- 🔌 **可扩展** - 支持自定义分类规则和合并策略
 - 💾 **安全备份** - 操作前自动创建 Git 备份
-- 🎯 **两阶段确认** - 先选择文件，再选择更新项
+- 🌿 **多分支** - 支持从任意分支同步
 
 ## 📦 安装
 
 ```bash
+pnpm add -g template-syncer
+# 或
 npm install -g template-syncer
 ```
 
@@ -24,59 +35,146 @@ npm install -g template-syncer
 ### 基本用法
 
 ```bash
-# 交互式同步（会询问模板仓库）
+# 交互式同步
 syn
 
 # 指定模板仓库
-syn --repo https://github.com/antfu/vitesse-lite.git
+syn -r https://github.com/user/template.git
 
-# 详细模式
-syn --verbose
-```
+# 指定分支
+syn -r https://github.com/user/template.git -b dev
 
-### 同步流程
+# 详细输出
+syn -v
+```
 
-1. **文件扫描** - 自动扫描当前目录下的所有支持文件
-2. **文件选择** - 默认全选，可以自定义选择要检查的文件
-3. **差异对比** - 与模板进行对比，找出有变化的文件
-4. **变更选择** - 选择要更新的文件，可以预览差异
-5. **批量更新** - 一次性更新所有选中的文件
+### 运行模式
 
-### 支持的文件类型
+```bash
+syn              # 交互式同步 (默认)
+syn --init       # 初始化配置
+syn --batch      # 批量处理模式
+syn --preview    # 预览差异
+syn --smart      # 智能推荐模式
+```
 
-- **配置文件**: `.json`, `.yml`, `.yaml`, `.xml`
-- **代码文件**: `.js`, `.ts`, `.jsx`, `.tsx`
-- **样式文件**: `.css`, `.scss`, `.less`
-- **文档文件**: `.md`, `.txt`
-- **配置文件**: `.gitignore`, `.npmrc`, `.eslintrc`, `.prettierrc` 等
-- **容器文件**: `Dockerfile`, `.dockerignore`
-- **构建文件**: `Makefile`, 各种配置文件
+### 配置文件
+
+运行 `syn --init` 创建配置文件 `.template-sync.json`:
+
+```json
+{
+  "repo": "https://github.com/user/template.git",
+  "branch": "main",
+  "ignore": [".env.local"],
+  "rules": {
+    "deleteOrphans": false,
+    "deletePatterns": ["src/deprecated/**"],
+    "protectPatterns": ["src/local/**", "*.local.*"],
+    "autoBackup": true,
+    "defaultMergeStrategy": "overwrite"
+  },
+  "lastSync": "2024-01-01T00:00:00.000Z"
+}
+```
 
-### 初始化配置
+### 同步规则 (rules)
+
+| 选项 | 类型 | 默认值 | 说明 |
+|------|------|--------|------|
+| `deleteOrphans` | boolean | `false` | 是否删除本地独有文件 |
+| `deletePatterns` | string[] | `[]` | 要删除的文件模式 (glob) |
+| `protectPatterns` | string[] | `[]` | 保护不被删除的文件模式 |
+| `autoBackup` | boolean | `true` | 同步前自动备份 |
+| `defaultMergeStrategy` | string | `"overwrite"` | 默认合并策略 |
+
+**示例：删除本地独有的 Swift 文件**
+
+```json
+{
+  "rules": {
+    "deleteOrphans": true,
+    "deletePatterns": ["**/*.swift"],
+    "protectPatterns": ["src/local/**"]
+  }
+}
+```
+```
 
-```bash
-syn --init
+## 🔧 高级用法
+
+### 编程式使用
+
+```typescript
+import { TemplateSyncer } from 'template-syncer';
+
+const syncer = new TemplateSyncer({
+  repo: 'https://github.com/user/template.git',
+  branch: 'main',
+  verbose: true,
+  // 自定义忽略模式
+  ignore: ['*.local', 'secrets/**'],
+  // 自定义分类规则
+  categories: [
+    { match: '**/custom/*.ts', category: '自定义模块', icon: '🎯', priority: 100 }
+  ],
+  // 自定义合并策略
+  mergers: {
+    'config.json': 'smart',
+    'README.md': 'skip'
+  },
+  // 同步规则
+  rules: {
+    deleteOrphans: true,
+    deletePatterns: ['src/deprecated/**'],
+    protectPatterns: ['src/local/**'],
+    autoBackup: true
+  }
+});
+
+await syncer.sync();
 ```
 
-## 🧪 测试
+### 合并策略
+
+| 策略 | 说明 |
+|------|------|
+| `overwrite` | 直接覆盖 (默认) |
+| `skip` | 跳过不处理 |
+| `smart` | 智能合并 (JSON 文件) |
+| `ask` | 询问用户 |
+
+### 自定义分类规则
+
+```typescript
+const syncer = new TemplateSyncer({
+  categories: [
+    // 高优先级规则
+    { match: '**/api/*.ts', category: 'API 模块', icon: '🔌', priority: 100 },
+    // 低优先级规则
+    { match: '**/*.ts', category: 'TypeScript', icon: '🔷', priority: 10 }
+  ]
+});
+```
 
-```bash
-# 创建 vitesse-lite 测试项目
-npm test
+## 📁 支持的文件类型
 
-# 然后在测试项目中修改文件，运行同步命令查看效果
-```
+工具会自动识别并分类各种文件：
 
-- **merge** - 智能合并（主要用于 `package.json`）
-- **diff** - 显示差异并让用户选择是否更新
-- **overwrite** - 直接覆盖
+- **项目配置**: package.json, Cargo.toml, go.mod 等
+- **构建工具**: vite.config.*, webpack.config.* 等
+- **代码质量**: .eslintrc*, .prettierrc* 等
+- **框架配置**: nuxt.config.*, next.config.* 等
+- **容器化**: Dockerfile, docker-compose.yml 等
+- **CI/CD**: .github/workflows/*, .gitlab-ci.yml 等
+- **各种编程语言**: .ts, .js, .py, .go, .rs, .java 等
 
 ## 🛡️ 安全性
 
 - **Git 备份**: 操作前自动创建 stash 备份
-- **交互确认**: 每个文件更改都需要用户确认
-- **差异显示**: 清楚展示即将进行的更改
+- **交互确认**: 每次操作都需要用户确认
+- **差异预览**: 可以先预览再决定是否应用
 
 ## 📄 许可证
 
-MIT License
+[MIT License](./LICENSE)

package/bin/syn.js

@@ -1,7 +1,7 @@
-#!/usr/bin/env node
+#!/usr/bin/env node
 
 const { Command } = require('commander');
-const { TemplateSyncer } = require('../lib/index');
+const { TemplateSyncer } = require('../lib/syncer');
 const pkg = require('../package.json');
 
 const program = new Command();
@@ -10,99 +10,65 @@ program
   .name('syn')
   .description('智能模板同步工具 - 让你的项目与模板仓库保持同步')
   .version(pkg.version)
-  .option('-r, --repo <url>', '指定模板仓库 URL')
-  .option('-v, --verbose', '显示详细输出信息')
-  .option('-i, --init', '初始化配置向导')
-  .option('-b, --batch', '高级批量操作模式')
-  .option('-p, --preview', '预览所有差异（不执行更新）')
-  .option('-s, --smart', '智能同步模式（自动推荐）')
-  .helpOption('-h, --help', '显示帮助信息');
+  .option('-r, --repo <url>', '模板仓库 URL')
+  .option('-b, --branch <name>', '分支名称')
+  .option('-v, --verbose', '详细输出')
+  .option('-i, --init', '初始化配置')
+  .option('--batch', '批量处理模式')
+  .option('-p, --preview', '预览差异')
+  .option('-s, --smart', '智能同步模式')
+  .helpOption('-h, --help', '显示帮助');
 
 program.addHelpText('after', `
 
 示例:
   $ syn                    # 交互式同步
   $ syn --init             # 初始化配置
-  $ syn --batch            # 高级批量操作
-  $ syn --preview          # 预览所有差异
+  $ syn --batch            # 批量处理模式
+  $ syn --preview          # 预览差异
   $ syn --smart            # 智能推荐模式
-  $ syn --repo https://github.com/antfu/vitesse-lite.git
-  $ syn --repo git@github.com:your/template.git --verbose
+  $ syn -r https://github.com/user/template.git
+  $ syn -r https://github.com/user/template.git -b dev
 
 支持的仓库格式:
-  • GitHub: https://github.com/owner/repo.git
-  • GitLab: https://gitlab.com/owner/repo.git  
-  • Bitbucket: https://bitbucket.org/owner/repo.git
+  • HTTPS: https://github.com/owner/repo.git
   • SSH: git@github.com:owner/repo.git
 
 功能特性:
   ✅ 智能合并 package.json
-  ✅ 支持 Vue/React/Angular 项目
-  ✅ 文件差异对比
-  ✅ 交互式确认更新
+  ✅ 跨平台支持 (Windows/macOS/Linux)
+  ✅ 自动文件分类
+  ✅ 多分支支持
   ✅ Git 备份保护
-  ✅ 配置文件保存
+  ✅ 可扩展的分类规则
 
 更多信息: https://github.com/IceyWu/template-syncer
 `);
 
-// 主要执行逻辑
 async function main() {
   try {
     program.parse();
-    const options = program.opts();
+    const opts = program.opts();
 
-    // 显示启动信息
-    if (options.verbose) {
-      console.log('🔧 启动配置:');
-      if (options.repo) {
-        console.log(`   模板仓库: ${options.repo}`);
-      }
-      console.log(`   详细模式: 已启用`);
-      console.log('');
-    }    // 创建同步器实例
-    const syncerOptions = {
-      ...options,
-      templateRepo: options.repo
-    };
-    const syncer = new TemplateSyncer(syncerOptions);
-    
-    if (options.init) {
-      await syncer.initConfig();    } else if (options.batch) {
-      // 高级批量操作模式
-      try {
-        await syncer.batchProcess();
-      } finally {
-        // 清理临时文件
-        syncer.cleanup();
-      }
-    } else if (options.preview) {
-      // 预览模式
-      try {
-        await syncer.getTemplateRepo();
-        await syncer.cloneTemplate();
-        const templateFiles = await syncer.scanTemplateFiles();
-        const currentFiles = await syncer.scanCurrentFiles();
-        const changedFiles = await syncer.compareFiles(templateFiles, currentFiles);
-        await syncer.previewAllDifferences(changedFiles);
-      } finally {
-        // 清理临时文件
-        syncer.cleanup();
-      }
-    } else if (options.smart) {
-      // 智能同步模式
-      try {
-        await syncer.intelligentSync();
-      } finally {
-        // 清理临时文件
-        syncer.cleanup();
-      }
+    const syncer = new TemplateSyncer({
+      repo: opts.repo,
+      branch: opts.branch,
+      verbose: opts.verbose
+    });
+
+    if (opts.init) {
+      await syncer.init();
+    } else if (opts.batch) {
+      await syncer.batch();
+    } else if (opts.preview) {
+      await syncer.preview();
+    } else if (opts.smart) {
+      await syncer.smart();
     } else {
-      // 默认交互式同步
       await syncer.sync();
     }
   } catch (error) {
-    console.error('❌ 程序执行失败:', error.message);
+    console.error('❌ 执行失败:', error.message);
     if (program.opts().verbose) {
       console.error(error.stack);
     }
@@ -110,16 +76,14 @@ async function main() {
   }
 }
 
-// 处理未捕获的异常
 process.on('uncaughtException', (error) => {
   console.error('💥 未捕获的异常:', error.message);
   process.exit(1);
 });
 
-process.on('unhandledRejection', (reason, promise) => {
+process.on('unhandledRejection', (reason) => {
   console.error('💥 未处理的 Promise 拒绝:', reason);
   process.exit(1);
 });
 
-// 启动程序
 main();

package/lib/index.d.ts

@@ -1,112 +1,5 @@
-import { FileConfig, TemplateSyncerOptions, BatchResults } from './types';
-/**
- * 智能模板同步工具
- * 用于将项目与模板仓库保持同步
- */
-export declare class TemplateSyncer {
-    private tempDir;
-    private templateRepo;
-    private configFile;
-    private changes;
-    private verbose;
-    private ignorePatterns;
-    private fileTypeConfig;
-    private specialFiles;
-    constructor(options?: TemplateSyncerOptions);
-    /**
-     * 创建 Git 备份
-     */
-    createBackup(): void;
-    /**
-     * 克隆模板仓库
-     */
-    cloneTemplate(): Promise<void>; /**
-     * 获取或设置模板仓库
-     */
-    getTemplateRepo(): Promise<string>;
-    /**
-     * 测试仓库连接
-     */
-    testRepository(repo: string): Promise<boolean>;
-    /**
-     * 扫描模板文件
-     */
-    scanTemplateFiles(): Promise<FileConfig[]>;
-    /**
-     * 扫描当前项目文件
-     */
-    scanCurrentFiles(): Promise<FileConfig[]>;
-    /**
-     * 分析文件类型和特征
-     */
-    private analyzeFile;
-    /**
-     * 对比文件并生成变更列表
-     */
-    compareFiles(templateFiles: FileConfig[], currentFiles: FileConfig[]): Promise<FileConfig[]>;
-    /**
-     * 交互式选择要应用的变更
-     */
-    selectChangesToApply(changes: FileConfig[]): Promise<FileConfig[]>;
-    /**
-     * 按分类选择文件
-     */
-    private selectByCategory;
-    /**
-     * 逐一选择文件
-     */
-    private selectIndividually;
-    /**
-     * 批量更新文件
-     */
-    batchUpdateFiles(files: FileConfig[]): Promise<BatchResults>;
-    /**
-     * 更新单个文件
-     */
-    private updateSingleFile;
-    /**
-     * 智能合并 package.json
-     */
-    private mergePackageJson;
-    /**
-     * 显示操作摘要
-     */
-    showSummary(results: BatchResults): void;
-    /**
-     * 清理临时文件
-     */
-    cleanup(): void;
-    /**
-     * 加载配置文件
-     */
-    private loadConfig;
-    /**
-     * 保存配置文件
-     */
-    private saveConfig;
-    /**
-     * 主同步流程
-     */
-    sync(options?: TemplateSyncerOptions): Promise<void>;
-    /**
-     * 初始化配置向导
-     */
-    initConfig(): Promise<void>;
-    /**
-     * 批量处理模式
-     */
-    batchProcess(): Promise<void>;
-    /**
-     * 生成智能推荐
-     */
-    private generateRecommendations;
-    /**
-     * 预览所有差异
-     */
-    previewAllDifferences(files: FileConfig[]): Promise<void>;
-    /**
-     * 智能同步模式
-     */
-    intelligentSync(): Promise<void>;
-}
+export { TemplateSyncer } from './syncer';
+export type { FileInfo, FileChange, SyncerOptions, SyncConfig, SyncRules, CategoryRule, MergeStrategy, BatchResult, Recommendation } from './types';
+export { platform, Categorizer, Merger, Git, Scanner } from './utils';
+export { prompts, logger } from './ui';
 //# sourceMappingURL=index.d.ts.map

package/lib/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAOA,OAAO,EACL,UAAU,EAEV,qBAAqB,EAGrB,YAAY,EAGb,MAAM,SAAS,CAAC;AAEjB;;;GAGG;AACH,qBAAa,cAAc;IACzB,OAAO,CAAC,OAAO,CAAS;IACxB,OAAO,CAAC,YAAY,CAAqB;IACzC,OAAO,CAAC,UAAU,CAAS;IAC3B,OAAO,CAAC,OAAO,CAAW;IAC1B,OAAO,CAAC,OAAO,CAAU;IACzB,OAAO,CAAC,cAAc,CAAW;IACjC,OAAO,CAAC,cAAc,CAAiC;IACvD,OAAO,CAAC,YAAY,CAAiC;gBAEzC,OAAO,GAAE,qBAA0B;IAwK/C;;OAEG;IACH,YAAY,IAAI,IAAI;IAYpB;;OAEG;IACG,aAAa,IAAI,OAAO,CAAC,IAAI,CAAC,EAwBjC;;OAEA;IACG,eAAe,IAAI,OAAO,CAAC,MAAM,CAAC;IAiCxC;;OAEG;IACG,cAAc,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC;IAYpD;;OAEG;IACG,iBAAiB,IAAI,OAAO,CAAC,UAAU,EAAE,CAAC;IAgChD;;OAEG;IACG,gBAAgB,IAAI,OAAO,CAAC,UAAU,EAAE,CAAC;IA8B/C;;OAEG;IACH,OAAO,CAAC,WAAW;IAyCnB;;OAEG;IACG,YAAY,CAAC,aAAa,EAAE,UAAU,EAAE,EAAE,YAAY,EAAE,UAAU,EAAE,GAAG,OAAO,CAAC,UAAU,EAAE,CAAC;IAsClG;;OAEG;IACG,oBAAoB,CAAC,OAAO,EAAE,UAAU,EAAE,GAAG,OAAO,CAAC,UAAU,EAAE,CAAC;IAuDxE;;OAEG;YACW,gBAAgB;IAqB9B;;OAEG;YACW,kBAAkB;IAoBhC;;OAEG;IACG,gBAAgB,CAAC,KAAK,EAAE,UAAU,EAAE,GAAG,OAAO,CAAC,YAAY,CAAC;IAgClE;;OAEG;YACW,gBAAgB;IAyB9B;;OAEG;YACW,gBAAgB;IAuC9B;;OAEG;IACH,WAAW,CAAC,OAAO,EAAE,YAAY,GAAG,IAAI;IAuBxC;;OAEG;IACH,OAAO,IAAI,IAAI;IAWf;;OAEG;IACH,OAAO,CAAC,UAAU;IAWlB;;OAEG;IACH,OAAO,CAAC,UAAU;IAQlB;;OAEG;IACG,IAAI,CAAC,OAAO,GAAE,qBAA0B,GAAG,OAAO,CAAC,IAAI,CAAC;IAsE9D;;OAEG;IACG,UAAU,IAAI,OAAO,CAAC,IAAI,CAAC;IAoDjC;;OAEG;IACG,YAAY,IAAI,OAAO,CAAC,IAAI,CAAC;IAgEnC;;OAEG;YACW,uBAAuB;IA6DrC;;OAEG;IACG,qBAAqB,CAAC,KAAK,EAAE,UAAU,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC;IAkC/D;;OAEG;IACG,eAAe,IAAI,OAAO,CAAC,IAAI,CAAC;CAyDvC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,cAAc,EAAE,MAAM,UAAU,CAAC;AAG1C,YAAY,EACV,QAAQ,EACR,UAAU,EACV,aAAa,EACb,UAAU,EACV,SAAS,EACT,YAAY,EACZ,aAAa,EACb,WAAW,EACX,cAAc,EACf,MAAM,SAAS,CAAC;AAGjB,OAAO,EAAE,QAAQ,EAAE,WAAW,EAAE,MAAM,EAAE,GAAG,EAAE,OAAO,EAAE,MAAM,SAAS,CAAC;AACtE,OAAO,EAAE,OAAO,EAAE,MAAM,EAAE,MAAM,MAAM,CAAC"}