EditorConfig — это инструмент, который помогает стандартизировать стиль кода в разных редакторах и IDE, обеспечивая консистентность форматирования.
EditorConfig использует конфигурационный файл .editorconfig, который определяет правила форматирования для разных типов файлов (например, для C#, JavaScript, HTML). Когда редактор или IDE открывает проект, он автоматически подхватывает настройки из этого файла и применяет их.
Основные принципы и возможности
➖ Определение правил для различных языков и файлов
EditorConfig позволяет настраивать правила форматирования для каждого типа файлов или каталогов.
Пример конфигурации:
[*.cs]
indent_style = space
indent_size = 4
tab_width = 4
trim_trailing_whitespace = true
end_of_line = lf
insert_final_newline = true
indent_style: cтиль отступов, может быть space или tab.
indent_size: количество пробелов для отступа.
tab_width: ширина табуляции (используется, если indent_style = tab).
trim_trailing_whitespace: удаление пробелов в конце строки.
end_of_line: стиль переноса строки (LF или CRLF).
insert_final_newline: добавление пустой строки в конце файла.
➖ Конфигурация для разных директорий
[*.js]
indent_style = space
indent_size = 2
[test/*.cs]
indent_style = tab
indent_size = 4
➖ Глобальные настройки для всех проектов
Вы можете создать глобальный .editorconfig, который будет применяться ко всем проектам на вашем компьютере, если он находится в домашней директории или в другом заданном месте. Это позволяет легко применять одни и те же стандарты к каждому новому проекту.
root = true
[*]
indent_style = space
indent_size = 4
trim_trailing_whitespace = true
➖ Использование с git
Если вы хотите гарантировать, что изменения в коде всегда соответствуют стандартам, можно интегрировать EditorConfig с Git Hooks. Таким образом, при каждом коммите можно автоматически проверять, чтобы все изменения соответствовали правилам форматирования.
💡 Если вы используете Visual Studio 2019 или более позднюю версию, EditorConfig будет работать без дополнительных настроек.
🐸Библиотека шарписта #буст