Git Cursor Rules Sync - VSCode插件

这是一个VSCode插件，用于自动同步Git仓库中的.mdc文件到当前项目的.cursor/rules目录。

功能特性

• 🔄 自动同步Git仓库中的.mdc文件
• 📁 支持配置多个Git仓库
• 🖥️ 提供可视化配置界面
• 🔄 支持手动刷新同步
• 🗂️ 保持目录结构一致性
• 🛡️ 安全的文件管理（不会影响其他文件）

安装方法

1. 下载插件VSIX文件
2. 在VSCode中安装：

   code --install-extension git-cursor-rules-sync-0.0.1.vsix
   

使用方法

1. 打开配置面板

打开命令面板：

• Mac: Cmd+Shift+P
• Windows/Linux: Ctrl+Shift+P

然后输入以下命令之一：

• Git Cursor Rules Sync: 打开配置
• 打开配置

2. 添加Git仓库

在配置面板中填写：

• 仓库名称: 用于在.cursor/rules下创建目录（如：project）
• 仓库地址: Git仓库的完整URL
• 分支: 可选，默认为master

3. 同步操作

自动同步：

• 插件启动时会自动同步所有配置的仓库

手动同步：

• 在配置界面点击"同步所有仓库"按钮
• 或使用命令面板（Cmd+Shift+P / Ctrl+Shift+P）输入：Git Cursor Rules Sync: 同步规则文件

配置方式

1. 可视化配置（推荐）

• 使用命令面板（Cmd+Shift+P / Ctrl+Shift+P）
• 输入：Git Cursor Rules Sync: 打开配置
• 在界面中添加、删除仓库配置

2. 手动编辑配置文件

配置文件位置：~/.vscode/git-mdc-rules-sync.json

配置文件示例：

{
  "repositories": [
    {
      "name": "project",
      "url": "https://github.com/PatrickJS/awesome-cursorrules.git",
      "branch": "master"
    },
    {
      "name": "private",
      "url": "https://github.com/user/private-rules",
      "branch": "main"
    }
  ]
}

注意：手动编辑配置文件后，插件会自动读取更新后的配置。

目录结构

同步后的文件结构：

.cursor/
└── rules/
    ├── project/
    │   ├── file1.mdc
    │   └── subdir/
    │       └── file2.mdc
    └── private/
        └── file3.mdc

注意事项

1. 只同步.mdc文件: 其他文件类型会被忽略
2. 保持目录结构: 文件路径与Git仓库中的路径保持一致
3. 安全清理: 每次同步前会清空对应目录，但不会影响其他目录
4. 错误处理: 如果Git仓库无法访问，会跳过该仓库并显示错误信息
5. 配置文件: 位于 ~/.vscode/git-mdc-rules-sync.json，支持手动编辑

许可证

MIT License