Использование editorconfig в подмодулях Git

У меня есть веб-приложение, которое зависит от внешнего модуля для проверки схемы JSON. Веб-приложение имеет свой репозиторий Git, в который модуль включен как подмодуль Git.

В веб-проекте у меня есть editorconfig для стандартизации синтаксиса. Для этого (поскольку я использую Sublime text) я использую editorconfig-sublime.

Модуль поддерживается другой командой, и у них есть свой собственный стиль кодирования. Я иногда способствую этому все же.

Проблема, с которой я сталкиваюсь, заключается в том, что когда я добавляю код в веб-папку в модуль, мой стиль кодирования совпадает с их стилем, так как у меня есть собственный .editorconfig файл. Они в настоящее время не используют editorconfig,

У меня вопрос такой:

Возможно ли и если да, желательно использовать один .editorconfig в базе Git репозиторий и другое .editorconfig в подмодуле Git? Какова лучшая практика здесь?

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
Другие вопросы по тегам