template-syncer 1.0.1 → 1.0.3

package/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2025 Template Syncer
+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

package/README.md

@@ -2,13 +2,29 @@
 
 智能模板同步工具，让你的项目与模板仓库保持同步。
 
+<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>
+<a href="https://www.npmjs.com/package/template-syncer">
+  <img src="https://img.shields.io/npm/dt/template-syncer?style=flat-square" alt="downloads">
+</a>
+
 ## ✨ 特性
 
 - 🚀 **智能同步** - 自动检测并同步模板更新
+- 🎇 **自动扫描** - 智能扫描当前目录的所有可同步文件
+- ✅ **批量选择** - 支持全选/反选，批量处理文件
+- 🔍 **智能对比** - 先对比差异，再选择性更新
 - 📦 **智能合并** - 特别针对 `package.json` 的智能合并策略
 - 🔄 **差异对比** - 使用 Git diff 显示文件变更
 - 💾 **安全备份** - 操作前自动创建 Git 备份
-- 🎯 **交互式操作** - 每个变更都需要用户确认
+- 🎯 **两阶段确认** - 先选择文件，再选择更新项
 
 ## 📦 安装
 
@@ -22,35 +38,66 @@ npm install -g template-syncer
 
 ```bash
 # 交互式同步（会询问模板仓库）
-template-sync
+syn
 
 # 指定模板仓库
-template-sync --repo https://github.com/antfu/vitesse-lite.git
+syn --repo https://github.com/IceyWu/cloud-template.git
+
+# 指定模板仓库和分支
+syn --repo https://github.com/IceyWu/cloud-template.git --branch dev
 
 # 详细模式
-template-sync --verbose
+syn --verbose
+
+# 只指定分支（会使用配置文件中的仓库）
+syn --branch main
 ```
 
+### 同步流程
+
+1. **文件扫描** - 自动扫描当前目录下的所有支持文件
+2. **仓库克隆** - 克隆指定的模板仓库
+3. **分支选择** - 如果未指定分支，会列出所有分支供选择
+4. **文件选择** - 默认全选，可以自定义选择要检查的文件
+5. **差异对比** - 与模板进行对比，找出有变化的文件
+6. **变更选择** - 选择要更新的文件，可以预览差异
+7. **批量更新** - 一次性更新所有选中的文件
+
+### 支持的文件类型
+
+- **配置文件**: `.json`, `.yml`, `.yaml`, `.xml`
+- **代码文件**: `.js`, `.ts`, `.jsx`, `.tsx`
+- **样式文件**: `.css`, `.scss`, `.less`
+- **文档文件**: `.md`, `.txt`
+- **配置文件**: `.gitignore`, `.npmrc`, `.eslintrc`, `.prettierrc` 等
+- **容器文件**: `Dockerfile`, `.dockerignore`
+- **构建文件**: `Makefile`, 各种配置文件
+
 ### 初始化配置
 
 ```bash
-template-sync --init
+syn --init
 ```
 
-## 🧪 测试
+### 分支支持
+
+Tool 支持从任意分支同步模板：
+
+- **指定分支**: 使用 `--branch` 参数指定要同步的分支
+- **交互选择**: 如果不指定分支，工具会列出所有可用分支供你选择
+- **配置保存**: 可以在初始化配置时设置默认分支
 
 ```bash
-# 创建 vitesse-lite 测试项目
-npm test
+# 从 dev 分支同步
+syn --repo https://github.com/owner/repo.git --branch dev
 
-# 然后在测试项目中修改文件，运行同步命令查看效果
-```
+# 从 feature/new-ui 分支同步
+syn --repo https://github.com/owner/repo.git --branch feature/new-ui
 
-## 📝 文件处理类型
+# 不指定分支，工具会列出所有分支让你选择
+syn --repo https://github.com/owner/repo.git
+```
 
-- **merge** - 智能合并（主要用于 `package.json`）
-- **diff** - 显示差异并让用户选择是否更新
-- **overwrite** - 直接覆盖
 
 ## 🛡️ 安全性
 
@@ -60,4 +107,4 @@ npm test
 
 ## 📄 许可证
 
-MIT License
+[MIT License](./LICENSE)

package/bin/syn.js

@@ -0,0 +1,135 @@
+#!/usr/bin/env node
+
+const { Command } = require('commander');
+const { TemplateSyncer } = require('../lib/index');
+const pkg = require('../package.json');
+
+const program = new Command();
+
+program
+  .name('syn')
+  .description('智能模板同步工具 - 让你的项目与模板仓库保持同步')
+  .version(pkg.version)
+  .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 --smart            # 智能推荐模式
+  $ syn --repo https://github.com/IceyWu/cloud-template.git
+  $ syn --repo https://github.com/IceyWu/cloud-template.git --branch dev
+  $ syn --repo git@github.com:your/template.git --verbose
+
+支持的仓库格式:
+  • GitHub: https://github.com/owner/repo.git
+  • GitLab: https://gitlab.com/owner/repo.git  
+  • Bitbucket: https://bitbucket.org/owner/repo.git
+  • SSH: git@github.com:owner/repo.git
+
+分支支持:
+  • 指定分支: --branch dev
+  • 不指定分支时会列出所有分支供选择
+  • 支持任意分支名称
+
+功能特性:
+  ✅ 智能合并 package.json
+  ✅ 支持 Vue/React/Angular 项目
+  ✅ 文件差异对比
+  ✅ 交互式确认更新
+  ✅ Git 备份保护
+  ✅ 配置文件保存
+  ✅ 多分支支持
+
+更多信息: https://github.com/IceyWu/template-syncer
+`);
+
+// 主要执行逻辑
+async function main() {
+  try {
+    program.parse();
+    const options = program.opts();    // 显示启动信息
+    if (options.verbose) {
+      console.log('🔧 启动配置:');
+      if (options.repo) {
+        console.log(`   模板仓库: ${options.repo}`);
+      }
+      if (options.branch) {
+        console.log(`   指定分支: ${options.branch}`);
+      }
+      console.log(`   详细模式: 已启用`);
+      console.log('');
+    }    // 创建同步器实例
+    const syncerOptions = {
+      ...options,
+      templateRepo: options.repo,
+      branch: options.branch
+    };
+    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();
+      }
+    } else {
+      // 默认交互式同步
+      await syncer.sync();
+    }
+  } catch (error) {
+    console.error('❌ 程序执行失败:', error.message);
+    if (program.opts().verbose) {
+      console.error(error.stack);
+    }
+    process.exit(1);
+  }
+}
+
+// 处理未捕获的异常
+process.on('uncaughtException', (error) => {
+  console.error('💥 未捕获的异常:', error.message);
+  process.exit(1);
+});
+
+process.on('unhandledRejection', (reason, promise) => {
+  console.error('💥 未处理的 Promise 拒绝:', reason);
+  process.exit(1);
+});
+
+// 启动程序
+main();

package/lib/index.d.ts

@@ -0,0 +1,117 @@
+import { FileConfig, TemplateSyncerOptions, BatchResults } from './types';
+/**
+ * 智能模板同步工具
+ * 用于将项目与模板仓库保持同步
+ */
+export declare class TemplateSyncer {
+    private tempDir;
+    private templateRepo;
+    private branch;
+    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>;
+    /**
+     * 选择分支
+     */
+    private selectBranch;
+}
+//# sourceMappingURL=index.d.ts.map

package/lib/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAMA,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,MAAM,CAAqB;IACnC,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;gBACzC,OAAO,GAAE,qBAA0B;IAyK/C;;OAEG;IACH,YAAY,IAAI,IAAI;IAWpB;;OAEG;IACG,aAAa,IAAI,OAAO,CAAC,IAAI,CAAC,EA0CjC;;OAEA;IACG,eAAe,IAAI,OAAO,CAAC,MAAM,CAAC;IAqCxC;;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;IAqE9D;;OAEG;IACG,UAAU,IAAI,OAAO,CAAC,IAAI,CAAC;IA2DjC;;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;IA0DtC;;OAEG;YACW,YAAY;CAyD3B"}