★ FEATURED ARTICLE 每次重装系统或者换新电脑最让人头大的事情之一就是重新配置VS Code。桌面外观调半天、快捷键恢复默认、十几个顺手的小插件全得重新搜一遍更夸张的是有些插件你甚至想不起来当初为什么装。这篇我来把我一直在用的“同步vscode配置和插件”完整方案写清楚核心思路就是导入导出一条命令导出插件清单几个JSON文件备份全部配置换电脑之后几分钟全部恢复。适用场景非常广不管是重装系统、公司家里两台机器来回切、还是团队里面统一开发环境这套操作都能用上。1. 方案选型为什么“导入导出”比“自动同步”更适合大多数人1.1 三种主流同步方案对比VS Code的配置同步其实有不止一种玩法。第一种是编辑器自带的“设置同步”功能登录你的产品账号之后它会自动把设置、快捷键、插件等同步到云端。这个方案优点是全自动把你所有设备拉平缺点是你得登录账号而且它同步的是“最新状态”偶尔会出现A电脑刚调好的配置B电脑一打开就被覆盖掉的情况。第二种是第三方的同步插件这类插件的逻辑通常是手动上传配置到一个存储位置然后在新机器上拉取。听起来不错但插件本身会过期、会兼容性出问题而且有时需要额外配置访问令牌反而给小白增加了门槛。第三种就是我这篇要讲的“命令行导入导出法”用code命令把插件列表导出成一个文本文件再把用户目录下的配置文件打包带走。新电脑上同样用code命令读取文本文件批量安装插件把配置文件放到对应位置。整个过程完全离线、不依赖账号、不依赖网络服务所见即所得脚本可控性强。1.2 为什么我最终选择命令行导入导出我个人的使用习惯比较务实我不希望VS Code“擅自”帮我把所有电脑的配置合并成一个样子。比如我在台式机上用的是大显示器字体是16px在笔记本上可能只有14px如果强制同步每次打开都要手动调一遍。另外不同项目组需要的插件集合不同用一份完全统一的插件列表反而累赘。命令行导入导出最大的优势是“主动权在自己手里”。导出的是静态文件放在自己的U盘、网盘或者代码仓库里想什么时候同步就什么时候同步想同步哪几项就同步哪几项。尤其是离线环境或者网络状况不佳的时候这个方案几乎是唯一的选择。对于非程序员背景但日常依赖VS Code写文档、跑脚本的朋友来说不需要注册账号、不需要理解云端同步的各种选项复制几个文件、敲两行命令就完事理解成本非常低。1.3 需要同步的核心文件清单在动手导出之前得先搞清楚VS Code的配置到底存在哪里、需要备份哪些东西。配置项文件位置说明用户设置settings.json主题、字体、行号、自动保存等核心配置快捷键keybindings.json自定义快捷键绑定换了新环境不重新设置代码片段snippets/目录自己定义的各种代码片段插件列表通过命令导出不直接存为文件需要执行导出命令生成清单打开VS Code之后按CtrlShiftP调出命令面板输入“settings”选择“偏好设置打开用户设置(JSON)”就能看到settings.json本体。如果要快速找到它的文件路径可以点开右上角的文件图标选“在资源管理器中显示”这样就能看到完整的用户配置目录。这个目录下面有一个snippets文件夹和一个keybindings.json这几个东西加起来就是完整的个性化配置。2. 导出端旧电脑上把配置完整提取出来2.1 一键导出插件列表先确保VS Code的code命令能用。装好编辑器之后如果没有自动加入环境变量最简单的办法是在VS Code里按CtrlShiftP输入“shell command”找到“在PATH中安装‘code’命令”并执行一般在macOS/Linux上这条命令会用得比较多。在Windows上安装时通常会自动勾选“添加到PATH”如果你发现命令行里敲code没反应优先检查这一步。插件导出的命令特别简单code --list-extensions extensions.txt这条命令会把当前环境所有已安装插件的ID按行写入extensions.txt。每个插件ID的格式是“发布者.插件名”例如ms-python.python esbenp.prettier-vscode dbaeumer.vscode-eslint如果你还想把插件对应的版本号也记录下来方便之后精确恢复旧版本可以加一个参数code --list-extensions --show-versions extensions.txt输出就会变成类似ms-python.python2023.20.0这样的带版本号格式。我自己平时只导ID因为绝大多数插件装最新版问题不大不过如果你依赖的某个插件在新版本里有破坏性更新那带版本号导出是更稳妥的做法。2.2 定位配置文件目录插件清单只是第一步接下来要把配置目录完整拷出来。不同操作系统下用户配置目录的位置不一样我整理了一份常用的路径参考操作系统配置文件目录Windows%APPDATA%\Code\UsermacOS~/Library/Application Support/Code/UserLinux~/.config/Code/User进入这个目录之后重点拷贝三个东西settings.json、keybindings.json、snippets文件夹。如果是Windows平台%APPDATA%默认是当前用户下的AppData\Roaming资源管理器地址栏直接输入%APPDATA%\Code\User回车就能跳转过去。2.3 给配置“瘦身”和脱敏直接复制整个settings.json虽然能用但我会建议先花一分钟扫一眼里面的内容。因为settings.json可能包含一些机器相关的绝对路径——比如某个插件的自定义路径、Python解释器路径、终端shell路径这些在别的电脑上大概率不存在。你不一定要删掉这些项但要心里有数等新电脑恢复配置之后再针对性地改成新环境。比较重要的是脱敏。如果settings.json里有代理服务器地址、带token的下载镜像地址或者任何账号相关的信息导出之后请注意不要随便上传到公开的代码仓库。我见过有人把配置仓库传到公开平台结果把内网代理地址和密码一起暴露了。这里我的习惯是配置文件进私有仓库文件里绝不保存密码类信息。另外一个经验是检查settings.json里有没有“files.exclude”或者“search.exclude”这类列表这些配置通常随着项目不同而不同容易在新电脑上造成“咦我的文件怎么不见了”的假象建议同步前暂时先注释或者删掉。2.4 手工整理增量配置看到这里你可能会问settings.json里面默认配置一大串为什么都要备份其实你可以只备份跟默认不一样的项但手动整理非常容易漏不如全量备份。我个人的做法是把settings.json整个文件保留但新建一个自己的“核心配置片段清单”作为备忘。比如{ editor.fontSize: 15, editor.formatOnSave: true, editor.minimap.renderCharacters: false, workbench.colorTheme: One Dark Pro, files.autoSave: onFocusChange, terminal.integrated.defaultProfile.windows: Git Bash, emmet.triggerExpansionOnTab: true }这十几项是我每次重装后必须恢复的其他默认配置项其实不恢复也不影响使用。有了这个清单之后我同步配置时就能快速检查新机器是不是所有核心项都到位了而不是对着几百行的JSON文件心理没底。自动格式化、自动保存这类设置对每天写代码的效率影响非常大建议每个人都整理一份属于自己的“必恢复清单”。3. 导入端新电脑几分钟内恢复全套环境3.1 批量安装插件新电脑上装好VS Code之后先确认code命令可用然后把旧电脑上传过来的extensions.txt放到一个方便访问的路径根据你新机器所用的操作系统执行对应的批量安装命令。如果你在Windows PowerShell里操作最顺手的写法是Get-Content extensions.txt | ForEach-Object { code --install-extension $_ }如果用的还是老式CMD窗口可以直接这样写for /F %i in (extensions.txt) do code --install-extension %imacOS或Linux下用Bashfor i in $(cat extensions.txt); do code --install-extension $i; done执行过程中终端会逐条显示正在安装哪个插件如果有的插件拉取失败会直接报错。等跑完之后可以打开VS Code左侧的扩展面板看一眼数量对不对一目了然。这里有一个小细节code --install-extension如果遇到已经安装过的同名插件它不会报错只是提示已安装所以这套命令放心重复执行。安装全部插件之后我建议先不要立刻开始写代码而是重启一次VS Code让所有插件的激活逻辑正常加载。特别是那种需要依赖多个插件协作的比如代码格式化体系、语言服务器重启之后才能真正工作。3.2 配置文件覆盖到正确位置插件装好之后接下来把配置文件放到新电脑对应的目录。如果新电脑之前已经打开过VS Code系统会自动生成一个默认的用户目录里面已经有snippets文件夹和可能空白的JSON文件。这时候注意不要直接整个覆盖目录否则容易把VS Code自身的统计缓存也搞乱。稳妥做法是分别操作settings.json用备份文件替换现有文件keybindings.json用备份文件替换现有文件snippets把备份的snippets里的内容合并进现有目录替换之前建议先看一下现有文件里有没有特殊内容。比如有些插件会在settings.json里写自己的配置项如果新电脑已经装过插件且生成过配置直接覆盖会导致这些插件需要重新初始化。对于新电脑、新安装的VS Code来说直接用备份覆盖基本没问题。3.3 恢复后的第一轮检查你以为文件放进去就完事了我见过太多人恢复完设置之后一打开编辑器发现字体还是默认的、主题没变第一反应是“配置丢了”其实是配置文件放错位置或者文件没有正确加载。这里的排查顺序很重要按CtrlShiftP输入“reload window”手动重载一次编辑器窗口再按CtrlShiftP输入“settings”确认打开的是User级别的设置文件看编辑器左下角齿轮确认不是进入了某个文件夹级别的.vscode/settings.json覆盖了用户设置大部分情况下前三步做完了配置就生效了。如果某个设置项始终不对可以单独打开settings.json查找该项是否真的存在再检查该项的数值单位是否合理。比如我遇到过editor.fontSize设置成8以上但界面上看起来依然很小结果发现新电脑的分辨率缩放比普通笔记本高实际视觉大小被系统的显示缩放吃掉了这种情况下不是VS Code的配置问题而是系统显示比例问题。3.4 其他容易被忽略的同步项除了上面讲的用户配置和插件列表还想提醒几个容易被忽略的东西。第一个是workspaceStorage里面的工作区数据但这些数据往往是缓存类信息不建议同步同步了反而可能在新机器上打开旧路径报错。第二个是tasks.json和launch.json这两个文件通常存在于项目级别的.vscode目录里虽然不属于用户级别配置但如果你在多个项目里反复使用同一套构建和调试任务建议也复制一份模板备用。第三个是profiles较新版本的VS Code支持多配置文件切换如果你的工作流依赖不同profile切换导出时需要对应处理对应目录下的profile文件夹。4. 进阶玩法把同步脚本化和差异化4.1 打造一键导出/一键导入脚本命令行操作虽然不复杂但每次都打开终端敲几行命令也显得有些机械。我更推荐把常用的导入导出操作写成小脚本放到配置文件备份目录里一起管理。在macOS/Linux下我写了一个export.sh#!/bin/bash code --list-extensions extensions.txt cp $HOME/Library/Application Support/Code/User/settings.json . cp $HOME/Library/Application Support/Code/User/keybindings.json . cp -R $HOME/Library/Application Support/Code/User/snippets . echo 配置导出完成对应地import.sh负责新电脑恢复#!/bin/bash for i in $(cat extensions.txt); do code --install-extension $i done cp settings.json $HOME/Library/Application Support/Code/User/settings.json cp keybindings.json $HOME/Library/Application Support/Code/User/keybindings.json cp -R snippets $HOME/Library/Application Support/Code/User/ echo 配置导入完成Windows PowerShell版也完全同理就是路径换成$env:APPDATA\Code\User。脚本的好处是避免手工操作漏掉文件而且可以加上时间戳自动备份历史版本。我一般会在执行导入之前先用Copy-Item把现有配置移动到一个带日期的备份目录这样万一新配置有问题还能回滚这个习惯救过我很多次。4.2 多设备“差异化”同步如果你跟我一样需要同时维护台式机和笔记本两套环境就不太适合把所有配置无脑复制。这里分享一个更细致的思路公共配置全量同步设备特有配置单独处理。公共配置通常包括主题、字体、格式化的默认规则、常用快捷方式。设备特有配置包括字体大小、窗口缩放、终端选择等。操作上也很简单先导出一份基础配置应用到所有设备然后每个设备在settings.json中额外追加自己需要的项。比如台式机上我额外指定了大字体和两栏布局笔记本上我指定了小字体和单栏布局这样既保留了同步的便利性又不会让某一台机器的使用体验打折扣。4.3 把配置文件纳入版本管理配置文件既然已经导出成普通文本文件最佳的保管方式就是放进代码仓库里做版本管理。我自己是把整个备份目录做成一个私有仓库目录结构大概是vscode-backup/ ├── extensions.txt ├── settings.json ├── keybindings.json ├── snippets/ │ ├── vue.code-snippets │ └── javascript.code-snippets ├── export.sh └── import.sh这样有一个额外好处每次对VS Code做了重大调整比如换了主题、加了一组快捷键可以把改动的diff看得很清楚。哪天想回退到上个版本直接git revert就行。把配置当作代码来维护思路转变之后整个配置管理流程会变得非常可靠。用不用远程仓库看个人需要如果只用一台电脑本地仓库也完全够用。4.4 团队环境的批量统一多人协作的项目经常碰到“为什么你那边能编译我这边不行”的争论一查往往就是某人的VS Code装了某个格式化插件另一个人没装。这种场景下把这份导入导出方案包装成团队标准操作是很有效的手段。团队里可以约定插件清单放进项目仓库的.vscode/extensions.txt新人加入时先执行批量安装命令再让项目仓库里的远程容器或开发环境配置接管后续设置。这样能显著降低环境不一致带来的问题。当然要注意不是所有插件都适合全团队统一比如个人主题、个人趣味性插件就没必要强行统一。5. 常见问题与排查技巧实录5.1code命令提示无法识别这个问题的出现频率最高原因基本是PATH没配置好。在VS Code中按CtrlShiftP执行“在PATH中安装‘code’命令”然后重启终端一般就能解决。Windows用户如果是在安装VS Code之后第一次使用命令行可能还需要新开一个窗口才能让环境变量生效这个是老生常谈但真的很容易被忽略。5.2 批量安装插件时一直失败批量安装插件的过程中如果一直报网络类错误往往是因为网络原因导致扩展市场访问不稳定。这个不是配置本身的问题建议先单独试一下直接安装一个插件是否成功比如code --install-extension ms-python.python如果单独安装也失败那就是环境联网问题。如果是离线内网环境可以考虑从有网的机器上把.vsix插件包全部下载下来再用code --install-extension local/path.vsix方式离线安装。5.3 恢复设置后某个插件设置不见了有些插件的配置存在settings.json中有些存在插件自己的数据目录里。恢复settings.json只能解决前一部分插件自身产生的数据比如普通用户级别的Token、某些工具的自定义映射无法通过这份方案同步。如果一定需要可以把整个用户配置目录一起备份但这样做往往会带来大量无用数据在效率和完整度之间需要做取舍。我的选择是优先同步显性配置插件内的数据随用随配不追求100%还原。5.4 新旧版本差异导致设置不生效VS Code大版本更新之后偶尔会废弃一些旧设置项。比如曾经有段时间“workbench.iconTheme”的某些主题被官方调整过老的配置值不再生效。遇到这种情况在settings.json里会看到相关配置项虽然存在但不生效。排查方法是打开设置界面找到对应功能在界面里重新设置一次并观察新值写入文件的变化。靠拉齐版本可以从根本上减少这类问题让新旧电脑都升级到相同主版本导出配置的时候心理上也更有底。5.5 问题速查表问题现象可能原因处理方式code命令不存在PATH未配置执行“在PATH中安装code命令”插件安装一直卡住网络问题或来源不可达重试验证网络或改用离线VSIX安装配置恢复后与预期不符工作区配置覆盖用户配置检查项目根目录.vscode/settings.json某个设置项失效新旧版本设置项变更去设置界面重新确认并生成新配置对应项主题正常但快捷键不对快捷键没有同步或插件冲突确认keybindings.json已覆盖且没有重复绑定以上是我长期使用下来的一套实测可行的配置同步方案。最后再分享一个小技巧每次大版本更新或者插件大调整之后花一分钟重新执行一次导出把备份目录的日期改掉再提交一次版本记录时间成本几乎可以忽略但能保证你手里的备份永远是最接近当前习惯的状态。用这套方案换电脑真的不用再头疼了。
阅读完成 · 觉得有帮助？
