Формат dotnet

Эта статья относится к: ✔️ пакету SDK для .NET 6 и более поздних версий

Имя.

dotnet format — форматирует код в соответствии с параметрами editorconfig.

Краткие сведения

dotnet format [<PROJECT | SOLUTION>]
  [--binarylog <BINARY-LOG-PATH>] [--diagnostics <DIAGNOSTICS>]
  [--exclude <EXCLUDE>] [--exclude-diagnostics <EXCLUDE-DIAGNOSTICS>]
  [--include <INCLUDE>] [--include-generated]
  [--no-restore] [--report <REPORT-PATH>] [--severity <LEVEL>]
  [-v|--verbosity <LEVEL>] [--verify-no-changes] [--version]

dotnet format -h|--help

Description

dotnet format — это средство форматирования кода, которое применяет настройки стиля и статические рекомендации по анализу к проекту или решению. Предпочтения считываются из файла editorconfig, если они есть. В противном случае используется набор параметров по умолчанию. Дополнительные сведения см. в документации по EditorConfig.

Аргументы

PROJECT | SOLUTION

Проект или решение MSBuild для выполнения форматирования кода. Если файл проекта или решения не указан, MSBuild ищет в текущем рабочем каталоге файл с расширением, заканчивающимся на PROJ или SLN, и использует его.

Caution

Формат dotnet может восстанавливать, компилировать и запускать анализаторы из указанного проекта или решения. Вызывается только средство для доверенного кода.

Параметры

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

• --binarylog <BINARY-LOG-PATH>

  Записывает сведения о загрузке проекта или решения в двоичный файл журнала.

• --diagnostics <DIAGNOSTICS>

  Список идентификаторов диагностики, разделенных пробелами, для использования в качестве фильтра при исправлении стиля кода или проблем третьих сторон. Значение по умолчанию — это любой идентификатор, указанный в файле editorconfig. Список встроенных идентификаторов для правил анализатора, которые можно указать, см. в списке идентификаторов для правил анализа стиля кода.

• --exclude <EXCLUDE>

  Разделенный пробелами список относительных путей к файлам или папкам, которые нужно исключить из форматирования. Значение по умолчанию — none.

• --exclude-diagnostics <EXCLUDE-DIAGNOSTICS>

  Разделенный пробелами список диагностических идентификаторов, которые следует исключить при исправлении стиля кода или сторонних проблем. Значение по умолчанию — нет. Список встроенных идентификаторов для правил анализатора, которые можно указать, см. в списке идентификаторов для правил анализа стиля кода.

• --include <INCLUDE>

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

• --include-generated

  Форматирует файлы, созданные пакетом SDK.

• --no-restore

  Не выполняет неявное восстановление перед форматированием. По умолчанию используется неявное восстановление.

• --report <REPORT-PATH>

  Создает отчет JSON в каталоге, указанном параметром <REPORT_PATH>.

• --severity <LEVEL>

  Минимальная серьезность обнаруженной при диагностике проблемы, которая требует исправления. Допустимые значения: info, warn и error. Значение по умолчанию — warn.

• --verify-no-changes

  Проверяет, что не будут выполнены изменения форматирования. Завершается с ненулевым кодом выхода, если какие-либо файлы были бы отформатированы.

• --version

  Отображает сведения о версии.

• -v|--verbosity <LEVEL>

  Задает уровень детализации команды. Допустимые значения: q[uiet], m[inimal], n[ormal], d[etailed] и diag[nostic]. Дополнительные сведения см. в разделе LoggerVerbosity.

• -?|-h|--help

  Выводит описание использования команды.

Подкоманды

Пробел

dotnet format whitespace — форматирует код в соответствии с параметрами editorconfig для пробелов.

Description

dotnet format whitespace Подкоманда выполняет только правила форматирования, связанные с форматированием пробелов. Полный список возможных параметров форматирования, которые можно указать в файле .editorconfig , см. в параметрах форматирования C#.

Параметры

• --folder

  Рассмотрите аргумент <PROJECT | SOLUTION> как путь к простой папке файлов с кодом.

Стиль

dotnet format style — форматирует код в соответствии с параметрами EditorConfig для стиля кода.

Description

Подкоманда dotnet format style выполняет только правила форматирования, связанные с форматированием стиля кода. Полный список параметров форматирования, которые можно указать в файле editorconfig, см. в статье Правила стиля кода.

Параметры

• --diagnostics <DIAGNOSTICS>

  Разделенный пробелами список диагностических идентификаторов, используемых в качестве фильтра при устранении проблем с стилем кода. Значение по умолчанию — это любой идентификатор, указанный в файле editorconfig. Список идентификаторов встроенных правил анализатора стиля кода, которые можно указать, см . в списке идентификаторов правил стиля анализа кода.

• --severity <LEVEL>

  Минимальная серьезность обнаруженной при диагностике проблемы, которая требует исправления. Допустимые значения: info, warn и error. Значение по умолчанию — warn.

Анализаторы

dotnet format analyzers — форматирует код для сопоставления editorconfig параметров анализаторов (за исключением правил стиля кода).

Description

dotnet format analyzers Подкоманда выполняет только правила форматирования, связанные с анализаторами. Список правил анализатора, которые можно указать в файле, см. в editorconfig разделе "Правила качества".

Параметры

• --diagnostics <DIAGNOSTICS>

  Разделенный пробелами список диагностических идентификаторов, используемых в качестве фильтра при устранении проблем с стилем кода, отличных от кода. Значение по умолчанию — это любой идентификатор, указанный в файле editorconfig. Список встроенных идентификаторов правил анализатора, которые можно указать, см . в списке идентификаторов правил качества. Сторонние анализаторы см. в их документации.

• --severity <LEVEL>

  Минимальная серьезность обнаруженной при диагностике проблемы, которая требует исправления. Допустимые значения: 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или warningerror:

  dotnet format style --severity info
  

• Исправлена проблема с определенным анализатором (не в стиле кода):

  dotnet format analyzers --diagnostics CA1831 --severity warn
  

• Исправлены все проблемы, не связанные с стилем кода, которые имеют серьезность infoили warningerror:

  dotnet format analyzers --severity info