Должны ли файлы конфигурации линтеров быть в .gitignore? - PullRequest
1 голос
/ 04 апреля 2020

Файлы типа eslintr c, prettierr c или .editorconfig должны быть в .gitignore? Существуют ли хорошие практики, связанные с настройкой линтеров?

1 Ответ

4 голосов
/ 04 апреля 2020

Вы должны зарегистрировать (то есть зафиксировать, а не игнорировать) файлы конфигурации линтера и независимые от редактора файлы конфигурации и стиля (например, .editorconfig или .clang-format). Важно, чтобы они находились в репозитории, потому что они устанавливают стиль, применимый ко всем разработчикам, и позволяют всем разработчикам применять одинаковые стандарты со своими инструментами. Это важно для автоматической проверки сглаживания и форматирования (например, с помощью CI).

Однако вы должны , а не проверять любой файл конфигурации, указанный редактором или разработчиком c. Например, вы не будете регистрировать файл конфигурации для Vim, потому что не все разработчики используют Vim. (Вы не должны делать это, даже если все ваши разработчики do используют один и тот же редактор, поскольку настройки могут отличаться.) Точно так же вы не будете проверять файл подписи кода, который указывает тестовый сертификат конкретного разработчика, потому что это изменится на разработчика, работающего над проектом. Эти вещи должны быть перечислены в пользовательском c .gitignore, если только они не будут присутствовать в каждой системе разработчика (например, в конфигурационном файле c для конкретного проекта), в этом случае в репозитории лучший.

...