互联网上的大多数来源建议将.editorconfig
文件检查到每个存储库中,就像package.json
或Nuget.config
文件一样。这对于团队或开源项目绝对有效,其中多个开发人员以不同的个人编码风格进行协作。但是,您可能会为您自己的所有个人/私人项目/存储库使用相同的质量/风格偏好。因此,为了避免将这些首选项复制到每个新存储库中(如果您的质量/风格首选项发生变化,更新将是一场噩梦),您可以在其自己的存储库中创建一个.editorconfig
文件,并让您的各个存储库使用该文件。本质上, .editorconfig
成为定义您自己的个人编码环境的众多“点文件”之一。
该存储库包含这样一个.editorconfig
。我为自己的项目开发了它,但我希望我的风格偏好足够通用,可以用于任何存储库中的任何 Visual Studio 项目。如果没有,也许这个存储库将作为您制作自己的.editorconfig
的参考点!
假设您有以下目录结构:
root-directory
VisualStudioEditorConfig
.editorconfig
Repo1
Repo2
RepoGroup
Repo3
Repo4
...
如果您想在所有存储库(Repo1、Repo2、Repo3、Repo4 等)中使用相同的样式首选项,那么您应该将 .editorconfig 文件放在“root-directory”文件夹中。不幸的是,.editorconfig 文件被克隆到子文件夹“VsEditorConfig”中。您可以将该文件复制到根目录,但每次样式首选项更改时都必须重新复制它。解决方案是在根目录中创建指向版本化 .editorconfig 的符号链接。
在 Windows 上,在提升的命令提示符处运行以下命令。如果您不使用提升的命令提示符(即以“以管理员身份运行”打开的命令提示符),那么您将收到错误: You do not have sufficient privilege to perform this operation.
MKLINK " root-directory.editorconfig " " root-directoryVsEditorConfig.editorconfig "
在 MacOS/Linux 上,运行以下命令:
ln -s " root-directory/VsEditorConfig/.editorconfig " " root-directory/.editorconfig "
将上述路径替换为您的特定目录结构所需的路径(绝对路径效果最佳)。创建链接后,您将能够像平常一样使用git pull
更新.editorconfig
,然后最新的样式首选项将可用于您的所有存储库(重新启动 Visual Studio 后)。
如果您不喜欢我的任何样式/格式首选项,那么您可以分叉我的.editorconfig
以将其用作起点并修改它以适合您的特定约定,或者添加一个单独的.editorconfig
以及您对个人的覆盖需要这些覆盖的存储库。