Formato dotnet

Este artigo se aplica a: ✔️ SDK do .NET 6 e versões posteriores

Nome

dotnet format - Formata o código para corresponder editorconfig às configurações.

Sinopse

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

dotnet format -h|--help

Descrição

dotnet format é um formatador de código que aplica preferências de estilo e recomendações de análise estática a um projeto ou solução. As preferências serão lidas de um arquivo .editorconfig, caso contrário, um conjunto padrão de preferências será usado. Para saber mais, confira a Documentação do EditorConfig.

Argumentos

PROJECT | SOLUTION

O projeto ou solução do MSBuild no qual executar a formatação de código. Se um arquivo de solução ou projeto não for especificado, o MSBuild pesquisará no diretório de trabalho atual por um arquivo que tenha uma extensão terminada em proj ou sln e usará esse arquivo.

Cuidado

O formato dotnet pode restaurar, compilar e executar analisadores do projeto ou da solução especificados. Invoque apenas a ferramenta em relação ao código confiável.

Opções

Nenhuma das opções abaixo é necessária para que o comando dotnet format tenha êxito, mas você pode usá-las para personalizar ainda mais o que está formatado e por quais regras.

• --binarylog <BINARY-LOG-PATH>

  Registrar em logs todas as informações de carregamento do projeto ou da solução em um arquivo de log binário.

• --diagnostics <DIAGNOSTICS>

  Uma lista separada por espaço de IDs de diagnóstico para usar como um filtro ao corrigir o estilo de código ou problemas de terceiros. O valor padrão é qualquer ID listada no arquivo .editorconfig. Para obter uma lista de IDs de regra internas do analisador que você pode especificar, consulte a lista de IDs para regras de estilo de análise de código.

• --exclude <EXCLUDE>

  Uma lista separada por espaço de caminhos relativos de arquivo ou pasta a serem incluídos na formatação. O padrão é none.

• --exclude-diagnostics <EXCLUDE-DIAGNOSTICS>

  Uma lista separada por espaço de IDs de diagnóstico a serem excluídas ao corrigir problemas de estilo de código ou de terceiros. O valor padrão é nenhum. Para obter uma lista de IDs de regra internas do analisador que você pode especificar, consulte a lista de IDs para regras de estilo de análise de código.

• --framework <FRAMEWORK>

  Especifica o TFM (moniker de estrutura de destino), como net11.0, para formatar em um projeto de vários destinos. Se você não especificar essa opção, dotnet format formata todas as estruturas de destino. Disponível a partir do .NET 11.

• --include <INCLUDE>

  Uma lista separada por espaço de caminhos relativos de arquivo ou pasta a serem incluídos na formatação. O padrão são todos os arquivos na solução ou no projeto.

• --include-generated

  Formata arquivos gerados pelo SDK.

• --no-restore

  Não executa uma restauração implícita antes da formatação. O padrão é fazer a restauração implícita.

• --report <REPORT-PATH>

  Produz um relatório JSON no diretório especificado por <REPORT_PATH>.

• --severity <LEVEL>

  A gravidade mínima do diagnóstico a ser corrigido. Os valores permitidos são info, warn e error. O valor padrão é warn.

• --verify-no-changes

  Verifica se nenhuma alteração de formatação seria executada. Termina com um código de saída diferente de zero se algum arquivo tiver sido formatado.

• --version

  Exibe informações de versão.

• -v|--verbosity <LEVEL>

  Define o nível de detalhes do comando. Os valores permitidos são q[uiet], m[inimal], n[ormal], d[etailed] e diag[nostic]. Para obter mais informações, consulte LoggerVerbosity.

• -?|-h|--help

  Imprime uma descrição de como usar o comando.

Subcomandos

Espaço em branco

dotnet format whitespace - Formata o código para corresponder às configurações editorconfig do espaço em branco.

Descrição

O dotnet format whitespace subcomando executa apenas regras de formatação associadas à formatação de espaço em branco. Para obter uma lista completa de possíveis opções de formatação que você pode especificar em seu arquivo .editorconfig , consulte Opções de formatação em C#.

Opções

• --folder

  Trate o argumento <PROJECT | SOLUTION> como um caminho para uma pasta simples de arquivos de código.

Estilo

dotnet format style - Formata o código para corresponder às configurações do estilo de código.

Descrição

O dotnet format style subcomando executa apenas regras de formatação associadas à formatação de estilo de código. Para obter uma lista completa de opções de formatação que você pode especificar em seu arquivo editorconfig, consulte Regras de estilo de código.

Opções

• --diagnostics <DIAGNOSTICS>

  Uma lista separada por espaços de IDs de diagnóstico a serem usadas como filtro ao corrigir problemas de estilo de código. O valor padrão é qualquer ID listada no arquivo .editorconfig. Para obter uma lista de IDs de regra do analisador de estilo de código interno que você pode especificar, consulte a lista de IDs para regras de estilo de análise de código.

• --severity <LEVEL>

  A gravidade mínima do diagnóstico a ser corrigido. Os valores permitidos são info, warn e error. O valor padrão é warn

Analisadores

dotnet format analyzers - Formata o código para corresponder editorconfig às configurações dos analisadores (excluindo regras de estilo de código).

Descrição

O dotnet format analyzers subcomando executa apenas regras de formatação associadas a analisadores. Para obter uma lista de regras de analisador que você pode especificar em seu editorconfig arquivo, consulte Regras de qualidade.

Opções

• --diagnostics <DIAGNOSTICS>

  Uma lista separada por espaços de IDs de diagnóstico a serem usadas como filtro ao corrigir problemas de estilo sem código. O valor padrão é qualquer ID listada no arquivo .editorconfig. Para obter uma lista de IDs de regra de analisador interno que você pode especificar, consulte a lista de IDs para regras de qualidade. Para analisadores de terceiros, consulte sua documentação.

• --severity <LEVEL>

  A gravidade mínima do diagnóstico a ser corrigido. Os valores permitidos são info, warn e error. O valor padrão é warn.

Exemplos

• Formate todo o código na solução:

  dotnet format ./solution.sln
  

• Limpe todo o código no projeto do aplicativo:

  dotnet format ./src/application.csproj
  

• Verifique se todo o código está formatado corretamente:

  dotnet format --verify-no-changes
  

• Limpe todo o código no diretório src e tests, mas não em src/submodule-a:

  dotnet format --include ./src/ ./tests/ --exclude ./src/submodule-a/
  

• Corrija um problema específico de estilo de código :

  dotnet format style --diagnostics IDE0005 --severity info
  

• Corrija todos os problemas de estilo de código que têm gravidade infoouwarning: error

  dotnet format style --severity info
  

• Corrija um problema específico do analisador (sem estilo de código):

  dotnet format analyzers --diagnostics CA1831 --severity warn
  

• Corrija todos os problemas de estilo que não são de código que têm gravidade infoouwarning: error

  dotnet format analyzers --severity info