在Git子模块中使用editorconfig

时间:2016-07-11 07:12:30

标签: git sublimetext git-submodules sublime-text-plugin editorconfig

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

在Web项目中,我有editorconfig用于语法标准化。为此(我使用Sublime文本),我使用editorconfig-sublime

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

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

我的问题是:

是否可以,如果是,建议在基本Git存储库中使用一个.editorconfig,在Git子模块中使用另一个.editorconfig?这里的最佳做法是什么?

1 个答案:

答案 0 :(得分:0)

最佳做法是为子模块使用.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