在Git子模块中使用editorconfig

Question

我有一个Web应用程序，它依赖外部模块进行JSON模式验证。Web应用程序有自己的Git存储库，在其中包含了该模块作为Git子模块。

对于语法规范化，我在Web项目中使用editorconfig。（因为我使用Sublime Text），我使用editorconfig-sublime 。

该模块由另一个团队维护，他们有自己的编码风格，尽管我偶尔会做出贡献。

我的问题是，当我在Web文件夹中将代码添加到模块时，我的编码风格与他们的风格不一致，因为我有自己的.editorconfig文件。他们目前没有使用editorconfig。

我的问题是：

是否可以并且如果可以的话，在基本Git存储库中使用一个.editorconfig文件和在Git子模块中使用另一个.editorconfig文件？这里有什么最佳实践？

- nikjohn

---

这可能不是你想要的答案，但如果他们真的关心保持自己的编码风格，那么我认为要求他们在repo中添加editorconfig文件或其他格式化进程并不过分。 - Jon z

Answer 1

最佳实践是为子模块使用.editorconfig文件。

即使主要开发人员不使用它，为每个存储库设置一个.editorconfig文件也是一种好的做法。

这是一种很好的方式，可以在不强制任何特定IDE的情况下，传达模块的编码风格。如果任何协作者使用与.editorconfig兼容的工具，他们甚至可能不知道自己正在使用它，但仍然从中受益。

但是，如果存储库不在您的控制范围内或者他们不想添加.editorconfig文件，则可以在主.editorconfig文件中执行一些操作。

其中一种选择是为该特定目录添加规则：

[/submodule-directory/**/*.js]
charset = utf-8
indent_style = space
indent_size = 2

另一个选项是使用unset忽略特定目录的规则：

[/submodule-directory/**]
charset = unset
indent_style = unset
indent_size = unset

- Jens