Генератор EditorConfig

Что делает файл .editorconfig

Файл с именем .editorconfig в корне проекта объявляет соглашения о форматировании. Редакторы с поддержкой EditorConfig (все основные IDE и большинство современных текстовых редакторов) применяют эти правила при открытии файла. Поиск идёт вверх по дереву каталогов от редактируемого файла и останавливается на первом файле, где указано root = true.

Пример вывода

При настройках по умолчанию (пробелы, размер отступа 4, LF, utf-8) и двух секциях, которые отмечены за вас, генератор выдаёт:

root = true

[*]
indent_style = space
indent_size = 4
end_of_line = lf
charset = utf-8
trim_trailing_whitespace = true
insert_final_newline = true
max_line_length = 120

[*.{md,markdown}]
trim_trailing_whitespace = false

[{Makefile,makefile,GNUmakefile,*.mk}]
indent_style = tab

Отметьте Python, Go или YAML, и ниже появится соответствующая секция, уже с тем соглашением, которого придерживается форматтер этой экосистемы.

Основные директивы

Три правила, которые ломают сборку, а не просто стайлгайд

Большинство записей в .editorconfig отражают предпочтения команды. Следующие три к предпочтениям не относятся, и именно ради них стоит заводить отдельные секции по языкам:

• YAML запрещает символ табуляции в отступах. Это ошибка разбора, а не замечание линтера. Если проект отбивается табами, а в нём есть workflow для GitHub Actions, файлы Docker Compose или манифесты Kubernetes, секция YAML обязана вернуть пробелы.
• make требует настоящий символ табуляции в начале каждой строки рецепта. Пробел даёт missing separator. Stop., и сборка прекращается. Поэтому в [{Makefile,makefile,GNUmakefile,*.mk}] перечислено несколько написаний: EditorConfig сопоставляет имена файлов с учётом регистра, а в репозиториях встречаются и Makefile, и makefile.
• Скрипт оболочки, сохранённый с CRLF, не запускается. Ядро считает возврат каретки частью пути к интерпретатору и сообщает что-то вроде /bin/bash^M: bad interpreter: No such file or directory. У пакетных файлов Windows зеркальная проблема: cmd.exe ищет goto и call :label по смещению в байтах, поэтому .bat только с LF может перейти не на ту строку или остановиться на полпути вообще без ошибки.

Две из этих проблем глобальный блок не решает, а как раз создаёт, поэтому генератор за ними следит. Если выбрать табы и не добавить секцию YAML или выбрать CRLF и не добавить секцию для скриптов оболочки, готовый файл сломает эти файлы, хотя ни разу их не упомянет. Генератор скажет об этом прямо над выводом, а не оставит вас выяснять это по упавшему пайплайну. То же касается кодировок utf-16: они распространяются на все файлы проекта, а make, интерпретаторы оболочки и Python не читают сохранённые так исходники.

Соглашения языков, которые пишет этот генератор

Обратите внимание, чего в этой таблице нет: длины строки. В PEP 8 это 79 символов, в Black 88, в PSR-12 мягкие 120, в rustfmt 100. Любое из этих чисел, записанное в секцию языка, незаметно переопределило бы ограничение, которое вы выбрали для всего проекта, поэтому генератор оставляет max_line_length только в блоке [*], а сами числа держит здесь, где вы можете применить их осознанно.

Поддерживает ли это ваш редактор?

Встроенная поддержка: VS Code, семейство IntelliJ от JetBrains, Visual Studio, Sublime Text, Xcode и Notepad++. Vim, Emacs, Neovim и ещё нескольким редакторам нужен небольшой плагин. Файл представляет собой обычный INI, поэтому его читают и линтеры, и форматтеры: именно так с ним согласуются Prettier и некоторые языковые серверы.