Formato dotnet
Este artigo se aplica a: ✔️ SDK do .NET 6.x e versões posteriores
dotnet format
- Formata o código para corresponder editorconfig
às configurações.
dotnet format [<PROJECT | SOLUTION>] [command] [options]
dotnet format -h|--help
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.
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.
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.
--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.
--severity
A gravidade mínima do diagnóstico a ser corrigido. Os valores permitidos são
info
,warn
eerror
. O valor padrão éwarn
.--no-restore
Não executa uma restauração implícita antes da formatação. O padrão é fazer a restauração implícita.
--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.
--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.
--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.
--include-generated
Formata arquivos gerados pelo SDK.
-v|--verbosity <LEVEL>
Define o nível de detalhamento. Os valores permitidos são
q[uiet]
,m[inimal]
,n[ormal]
,d[etailed]
ediag[nostic]
. O valor padrão ém[inimal]
.--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.
--report <REPORT-PATH>
Produz um relatório JSON no diretório especificado por
<REPORT_PATH>
.-h|--help
Mostra informações de ajuda e uso
dotnet format whitespace
- Formata o código para corresponder às configurações editorconfig
do espaço em branco.
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#.
--folder
Trate o argumento
<PROJECT | SOLUTION>
como um caminho para uma pasta simples de arquivos de código.
dotnet format style
- Formata o código para corresponder às configurações do estilo de código.
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.
--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
A gravidade mínima do diagnóstico a ser corrigido. Os valores permitidos são
info
,warn
eerror
. O valor padrão éwarn
dotnet format analyzers
- Formata o código para corresponder editorconfig
às configurações dos analisadores (excluindo regras de estilo de código).
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.
--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
A gravidade mínima do diagnóstico a ser corrigido. Os valores permitidos são
info
,warn
eerror
. O valor padrão éwarn
.
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
info
ouerror
:warning
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
info
ouerror
:warning
dotnet format analyzers --severity info
Comentários do .NET
O .NET é um projeto código aberto. Selecione um link para fornecer comentários: