Применение стиля кода .NET с помощью .editorconfig

Сохраняйте единый стиль написания кода в своих редакторах.

Чистая кодовая база необходима, и, честно говоря, никто не хочет читать неструктурированный и беспорядочный код. Убирать последствия утомительно, отнимает много времени и не очень весело.

Некоторые редакторы кода имеют встроенную функцию очистки, которая делает всю работу за вас. Это может хорошо сработать при работе над кодовой базой в одиночку. Однако при работе в команде крайне важно иметь общую конфигурацию, чтобы не перезаписывать код друг друга с помощью этой функции очистки.

К счастью, большинство IDE поддерживают файл .editorconfig, который обеспечивает согласованность между IDE и разработчиками.

Добавление .editorconfig в ваш проект .NET

Visual Studio предоставляет удобный способ добавить этот файл в проект и предоставляет поддержку пользовательского интерфейса для изменения конфигурации. Кроме того, файл также можно изменить вручную без использования Visual Studio. Microsoft также предоставляет хорошие шаблоны для .NET и C# для начала.

Вы можете добавить файл, выполнив следующие действия:

1. Щелкните правой кнопкой мыши свой проект в обозревателе решений в Visual Studio.
2. Нажмите Добавить.
3. Выберите Новый элемент.
4. Найдите "editorconfig"
5. Выберите «файл Editorconfig (.NET)» или «файл Editorconfig (C#)».

Теперь файл должен быть добавлен в ваш проект с некоторыми настройками по умолчанию для .NET. Двойной щелчок по файлу откроет вид, в котором вы можете просмотреть предустановленные настройки и настроить их так, как вам нравится. После завершения первоначальной настройки вы должны зафиксировать и отправить ее, чтобы поделиться ею со своей командой.

Примечание. У вас может не быть идеальной конфигурации с самого начала, и иногда это зависит от того, как работает ваша команда. Когда в .editorconfig вносятся изменения, для меня было очень ценно сохранять изменения как можно более изолированными и требовать проверки каждым членом команды. Это должно повысить осведомленность об изменениях и их последствиях.

Применить стиль кода и очистку

Запустите его в Visual Studio

Чтобы применить стиль и настройки, определенные в вашем файле .editorconfig, вы можете либо щелкнуть маленькую кнопку с метлой в Visual Studio, либо нажать комбинацию клавиш Ctrl+K, Ctrl+E. Нажатие Ctrl+K, Ctrl+D переформатирует ваш код.

Запустить через командную строку

Для запуска очистки из CLI требуется инструмент, который можно установить через интерфейс командной строки dotnet.

dotnet tool install -g dotnet-format

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

dotnet format

Отловить нарушения во время сборки

Очистка кода — это уже хорошо, но безопасный способ применить стиль кода — просто позволить вашей сборке завершиться ошибкой, если она не соответствует вашему стилю кода. Этого можно добиться, добавив в свои проекты пакет Microsoft.CodeAnalysis.CSharp.CodeStyle NuGet.

dotnet add package Microsoft.CodeAnalysis.CSharp.CodeStyle

Если вы настроили обработку неиспользуемых переменных как ошибок в файле .editorconfig, сборка завершится ошибкой и отобразит соответствующие строки в выводе сборки. Таким образом, вы можете быть абсолютно уверены, что разработанный код соответствует вашему стилю кода.

Дополнительная литература и ссылки