配置扩展同步 gitee-sync
由于github的gists访问受限,改了一个(syncing)的gitee版
1、多设备间同步配置和扩展(由于gitee gist改为了只能私有,所以该功能无法使用了)
2、方便团队统一开发环境。将Gist设置为public 即可,具体参考这里
功能
在本地和云端之间同步您的所有 VSCode 配置 ,包括:
1. 上传 VSCode 配置:
- 包括您的
用户设置 ,快捷键 ,扩展 ,语言设置 以及所有代码片段(Snippets) ;
- 因为
Mac 和非 Mac 设备的配置通常会有一些差异,所以快捷键 将会按照操作系统的不同分别上传;
- 自动帮您创建新的
Gist 来保存 VSCode 配置,例如当您第一次使用这个扩展上传配置时;
- 为了加快同步速度,整个同步过程都是
增量 的;
- 您可以
排除某些 VSCode 配置项和扩展 ,以防它们被上传,具体请参考这里。
2. 下载 VSCode 配置:
- 请注意,下载配置时会覆盖您的本地配置(以云端为准,精确同步);
- 自动帮您
安装 、升级 和删除 扩展;
- 您可以从一个
公开的 Gist 中下载配置。团队共享配置和扩展,只要一个公开的 Gist ID 就行了,具体请参考这里;
- 您可以
排除某些 VSCode 配置项和扩展 ,以防它们被下载,具体请参考这里。
命令
在 VSCode 的命令面板 中,您可以输入 upload 、download (或者 gitee )来快速搜索和执行 gitee-sync 的所有命令。
gitee-sync: Upload Settings
上传配置到 Gitee Gist。
gitee-sync: Download Settings
从 Gitee Gist 下载配置。
gitee-sync: Open Syncing Settings
设置 Gitee Personal Access Token 、Gist ID 。
快捷键
默认情况下所有的快捷键都是关闭的,但是您可以很轻松的在 VSCode 键盘快捷方式 中指定您想要的快捷键。截图是syncing 的,搜索gitee-sync :

VSCode 配置项
您可以在 VSCode 用户设置 中找到以下 gitee-sync 配置项。
giteeSync.excludedExtensions
通过这个配置项,您可以排除特定的 VSCode 扩展 ,以防它们被同步。那些不在此列表中的 VSCode 扩展将不受影响,依然会正常同步。
配置规则可以参考 Glob Patterns。
举个栗子:
"giteeSync.excludedExtensions" : [
"somepublisher.*",
"nonoroazoro.syncing"
]
要注意的是,这里被排除的扩展名称 其实是扩展的 ID (可在 VSCode 的扩展 页中找到),如下图所示:

这样一来 nonoroazoro.syncing (也就是本扩展)以及所有属于 somepublisher 这个作者的扩展就不会再被同步啦。
giteeSync.excludedSettings
通过这个配置项,您可以排除特定的 VSCode 配置项 ,以防它们被同步。那些不在此列表中的 VSCode 配置项将不受影响,依然会正常同步。
配置规则可以参考 Glob Patterns。
举个栗子:
"giteeSync.excludedSettings" : [
"editor.*",
"workbench.colorTheme"
]
这样一来您的 VSCode 主题(workbench.colorTheme )以及所有与编辑器(editor )相关的配置项就不会再被同步啦。
giteeSync.extensions.autoUpdate
通过这个配置项,可以让 gitee-sync 在同步时自动升级您的 VSCode 扩展。
这个功能是默认开启 的,当然您也可以在 VSCode 用户设置 中关掉它。
giteeSync.pokaYokeThreshold
通过配置这个阈值,每次同步配置时,gitee-sync 都会检查您的本地和云端配置间的差异量。如果超出这个阈值,就会显示一个确认对话框,以防错误的覆盖您的配置。
这个配置项的默认值是 10 。您可以将其设置为 0 来关闭这个功能(不再检查和显示确认对话框)。
举个栗子:
"giteeSync.pokaYokeThreshold" : 10
giteeSync.separateKeybindings
通过这个配置项,可以决定是否让 gitee-sync 按照设备操作系统 的不同来分开同步您的快捷键 配置。
鉴于 VSCode 从 1.27 版本开始提供了 Platform Specific Keybindings 功能,您现在可以关闭这个功能。注意:在关闭该功能之前,请务必确保您已经手动合并了现有的快捷键 配置。
这个功能是默认开启 的。您可以在 VSCode 用户设置 中关掉它。
快速开始
1. 创建你自己的Gitee Personal Access Token
码云 > 设置 > 私人令牌 > +生成新令牌
默认会有全部权限,这里只勾选gists即可,user_info权限是必选。
请务必备份你的令牌
2. 同步你的VSCode配置
在第一次使用时,会向您询问一些必要的信息并保存下来以供后续使用,主要就是前面申请的令牌 Access Token 。
上传配置
- 在VSCode的命令面板中输入
upload

- 填写申请的令牌(Access Token)
- 在下拉矿中选择或者手动输入一个
Gist ID
留空会自动创建一个新的Gist。
- 完成
- 上传完成后,Gitee的代码片段中可以找到对应Gist。可以设置为
public 公开给团队。
下载配置
- 在VSCode的命令面板中输入
download

- 填写你的令牌(Access Token)
留空,即可在下一步填写公开的Gist
- 在下拉框中选择或者手动输入一个
Gist ID (也可以输入一个公开的 Gist ID )。
- 完成
| |