Генератор EditorConfig
Создайте файл .editorconfig, который обеспечивает единообразие отступов, окончаний строк, кодировки и пробелов в разных редакторах. Выберите пробелы или табуляцию, размер отступа, LF или CRLF, кодировку, правила для конечных пробелов и перевода строки в конце файла, а также необязательную максимальную длину строки. Предусмотрены стандартные исключения для Markdown и Makefiles.
Часто задаваемые вопросы
Что такое файл .editorconfig?
Обычный текстовый файл в корне проекта, который указывает редакторам, как форматировать файлы: задает отступы, окончания строк, кодировку и пробелы. Многие редакторы читают его напрямую, в том числе Visual Studio Code с расширением EditorConfig, среды разработки JetBrains и Visual Studio.
Почему файл начинается с root = true?
root = true указывает редакторам прекратить поиск файлов .editorconfig в родительских папках, чтобы настройки этого проекта не смешивались с другими.
Зачем сохранять конечные пробелы в Markdown?
Два пробела в конце строки Markdown создают принудительный разрыв строки. В разделе [*.md] отключено удаление конечных пробелов, поэтому такие разрывы сохраняются.
Почему в Makefiles используются табуляции?
make требует табуляцию в начале каждой строки правила. Раздел [Makefile] сохраняет табуляции, даже если в остальной части проекта используются пробелы. Если вы уже выбрали табуляции, этот раздел не добавляется.
Что делает max_line_length?
Он указывает поддерживающим его редакторам, где переносить строки или показывать направляющую. Многие редакторы его игнорируют, а некоторые форматтеры, например Prettier, используют это значение как ширину вывода. Укажите 0, чтобы не включать параметр.
Переформатирует ли EditorConfig существующие файлы?
Нет. Он меняет способ сохранения новых изменений в редакторах и поведение некоторых операций сохранения. Один раз запустите форматтер, чтобы привести существующие файлы к этим настройкам.