VSCode 如何保持配置文件一致

  1. vscode 的配置文件

    1. 设置-->用户的设置一致
    2. 设置-->工作区的设置一致
  2. 安装相同的插件
  3. 多个插件会对保存时使用的格式产生冲突,查看保存时使用哪个规则
  4. 更快捷的保持一致的方法,通过使用 gist

VSCode设置类别

VSCode 的设置是分权重的,我们使用快捷键 common+,进入后,可以看到两个tab签,一个是用户级别,另一个是工作区级别,下面我们来分别看一下。

用户级别的设置

用户级别会对当前用户使用 vscode 提供一个统一的配置,可以认为是用户的默认设置,对当前所有的工程生效。

工作区级别的设置

工作区级别的设置面板和用户级别的设置控制面板完全一致,只是你的配置只会针对当前工作区生效,当用户级别的某项设置和工作区完全一致时,工作区的设置会覆盖掉用户级别设置,也就是工作区级别的设置权重更高。

VSCode设置方法

前面提到用户级别的设置和工作区级别的设置,拥有完全相同的控制面板,也就是他们的设置方法是没有差异的,所有通过控制面板设置的属性最终都会保存到一个.json文件中,差异的地方就是他们设置完后文件保存的路径,我们可以通过在某一项设置下面看到在settings.json中编辑,这样我们就能打开所对应的文件,你也能清楚的看到在用户tab签和工作区tab签分别是两个不同的文件。

用户级别设置的配置文件路径

我在 mac 上的文件地址是 ~/Library/Application Support/Code/User/settings.json,可以看到这是一个绝对地址,保证我们在什么地方都能引用的到。后面我们会介绍如何保存这个文件让我们在不同的电脑上保持这个文件的一致。

工作区级别设置的配置文件路径

工作区级别的设置是比较有意思的,他是基于你在 vscode 打开的文件的目录,比如你的文件在 /A/B/C文件下,你将/A直接在 VScode 中打开,那 VSCode 就会在 /A 目录下创建一个 .vscode 的文件夹,里面包含一个 setting.json 文件,这也就是你的工作区级别的配置文件,当然你下次直接使用 /A/B/C 打开你的项目,你的项目也不会使用到你工作区的配置文件了,这个小点还是要关注的。个人建议除非维护古董代码,通过工作区的设置覆盖掉用户级别设置,否则使用不要配置工作区级别的配置。

配置差异的原因

VSCode 之所以强大,是因为它可以方便的集成插件,我们在项目开发中会不时的增加一些插件,这就造成我们产生差异的最大原因,所以保持组内插件一致能规避这些问题。

保持配置文件的统一

在初始化的时候,我们通过拷贝的方式都能方便的保持配置的统一,但是随着时间的推移,因某些原因渐渐产生了差异,最好的方式还是大家都能从一个地方动态的获取到这个配置文件,比如我们可以通过git工具。
配置文件不过是一个 .json 文件,github 的 https://gist.github.com/ 可以提供这种简单的功能。
如果你访问不到上面的地址,你可以试试改一下 hosts 文件

192.30.253.118 gist.github.com

后面我们将会安装一个插件,他可以将文件自动的保持更新。

通过VSCode插件动态获取配置文件

在插件列表中搜索 Settings Sync,你将会在列表中有 Shan Khan 开发的插件,安装即可。

Key Features


1. Use your GitHub account token and Gist.
2. Easy to Upload and Download on one click.
3. Show a summary page at the end with details about config and extensions effected.
4. Auto download Latest Settings on Startup.
5. Auto upload Settings on file change.
6. Share the Gist with other users and let them download your settings.
7. Supports GitHub Enterprise
8. Support pragmas with @sync keywords: host, os and env are supported.
9. GUI for changing settings / logging in
10. Allows you to Sync any file across your machines.

It Syncs

All extensions and complete User Folder that Contains
1. Settings File
2. Keybinding File
3. Launch File
4. Snippets Folder
5. VSCode Extensions & Extensions Configurations
6. Workspaces Folder

Shortcuts

1. Upload Key : Shift + Alt + U
2. Download Key : Shift + Alt + D

(on macOS: Shift + Option + U / Shift + Option + D)

详细的介绍可以看这里,
https://github.com/shanalikhan/code-settings-sync
至此我们就能创建一致的配置文件了,里面配置的插件如 eslint 等就是插件安装的层面了。

你可能感兴趣的:(VSCode 如何保持配置文件一致)