dotnet format
Эта статья относится к: ✔️ пакету SDK для .NET 6.х и более поздних версий
dotnet format
— форматирует код в соответствии с параметрами editorconfig
.
dotnet format [<PROJECT | SOLUTION>] [command] [options]
dotnet format -h|--help
dotnet format
— это средство форматирования кода, которое применяет настройки стиля и статические рекомендации по анализу к проекту или решению. Предпочтения считываются из файла editorconfig, если они есть. В противном случае используется набор параметров по умолчанию. Дополнительные сведения см. в документации по EditorConfig.
PROJECT | SOLUTION
Проект или решение MSBuild для выполнения форматирования кода. Если файл проекта или решения не указан, MSBuild ищет в текущем рабочем каталоге файл с расширением, заканчивающимся на PROJ или SLN, и использует его.
Для выполнения команды dotnet format
не требуется ни один из перечисленных ниже параметров, но вы можете использовать их для подробной настройки того, что будет форматироваться и с помощью каких правил.
--diagnostics <DIAGNOSTICS>
Список идентификаторов диагностики, разделенных пробелами, для использования в качестве фильтра при исправлении стиля кода или проблем третьих сторон. Значение по умолчанию — это любой идентификатор, указанный в файле editorconfig. Список встроенных идентификаторов для правил анализатора, которые можно указать, см. в списке идентификаторов для правил анализа стиля кода.
--severity
Минимальная серьезность обнаруженной при диагностике проблемы, которая требует исправления. Допустимые значения:
info
,warn
иerror
. Значение по умолчанию —warn
.--no-restore
Не выполняет неявное восстановление перед форматированием. По умолчанию используется неявное восстановление.
--verify-no-changes
Проверяет, что не будут выполнены изменения форматирования. Завершается с ненулевым кодом выхода, если какие-либо файлы были бы отформатированы.
--include <INCLUDE>
Разделенный пробелами список относительных путей к файлам или папкам, которые нужно включить в форматирование. По умолчанию в нем указаны все файлы в решении или проекте.
--exclude <EXCLUDE>
Разделенный пробелами список относительных путей к файлам или папкам, которые нужно исключить из форматирования. Значение по умолчанию — none.
--include-generated
Форматирует файлы, созданные пакетом SDK.
-v|--verbosity <LEVEL>
Устанавливает уровень детализации. Допустимые значения:
q[uiet]
,m[inimal]
,n[ormal]
,d[etailed]
иdiag[nostic]
. Значение по умолчанию:m[inimal]
.--binarylog <BINARY-LOG-PATH>
Записывает сведения о загрузке проекта или решения в двоичный файл журнала.
--report <REPORT-PATH>
Создает отчет JSON в каталоге, указанном параметром
<REPORT_PATH>
.-h|--help
Отображает справку и сведения об использовании.
dotnet format whitespace
— форматирует код в соответствии с параметрами editorconfig
для пробелов.
dotnet format whitespace
Подкоманда выполняет только правила форматирования, связанные с форматированием пробелов. Полный список возможных параметров форматирования, которые можно указать в файле .editorconfig , см. в параметрах форматирования C#.
--folder
Рассмотрите аргумент
<PROJECT | SOLUTION>
как путь к простой папке файлов с кодом.
dotnet format style
— форматирует код в соответствии с параметрами EditorConfig для стиля кода.
Подкоманда dotnet format style
выполняет только правила форматирования, связанные с форматированием стиля кода. Полный список параметров форматирования, которые можно указать в файле editorconfig
, см. в статье Правила стиля кода.
--diagnostics <DIAGNOSTICS>
Разделенный пробелами список диагностических идентификаторов, используемых в качестве фильтра при устранении проблем с стилем кода. Значение по умолчанию — это любой идентификатор, указанный в файле editorconfig. Список идентификаторов встроенных правил анализатора стиля кода, которые можно указать, см . в списке идентификаторов правил стиля анализа кода.
--severity
Минимальная серьезность обнаруженной при диагностике проблемы, которая требует исправления. Допустимые значения:
info
,warn
иerror
. Значение по умолчанию —warn
.
dotnet format analyzers
— форматирует код для сопоставления editorconfig
параметров анализаторов (за исключением правил стиля кода).
dotnet format analyzers
Подкоманда выполняет только правила форматирования, связанные с анализаторами. Список правил анализатора, которые можно указать в файле, см. в editorconfig
разделе "Правила качества".
--diagnostics <DIAGNOSTICS>
Разделенный пробелами список диагностических идентификаторов, используемых в качестве фильтра при устранении проблем с стилем кода, отличных от кода. Значение по умолчанию — это любой идентификатор, указанный в файле editorconfig. Список встроенных идентификаторов правил анализатора, которые можно указать, см . в списке идентификаторов правил качества. Сторонние анализаторы см. в их документации.
--severity
Минимальная серьезность обнаруженной при диагностике проблемы, которая требует исправления. Допустимые значения:
info
,warn
иerror
. Значение по умолчанию —warn
.
Форматирование всего кода в решении:
dotnet format ./solution.sln
Очистка всего кода в проекте приложения:
dotnet format ./src/application.csproj
Проверка форматирования всего кода:
dotnet format --verify-no-changes
Очистка всего кода в каталоге src и tests, но не в src/submodule-a:
dotnet format --include ./src/ ./tests/ --exclude ./src/submodule-a/
Исправлена проблема с определенным стилем кода:
dotnet format style --diagnostics IDE0005 --severity info
Исправьте все проблемы с стилем кода, которые имеют серьезность
info
илиwarning
error
:dotnet format style --severity info
Исправлена проблема с определенным анализатором (не в стиле кода):
dotnet format analyzers --diagnostics CA1831 --severity warn
Исправлены все проблемы, не связанные с стилем кода, которые имеют серьезность
info
илиwarning
error
:dotnet format analyzers --severity info
Отзыв о .NET
.NET — это проект с открытым исходным кодом. Выберите ссылку, чтобы оставить отзыв: