dotnet format
Questo articolo si applica a: ✔️ .NET Core 6 SDK e versioni successive
dotnet format
: formatta il codice in modo che corrisponda alle impostazioni di editorconfig
.
dotnet format [<PROJECT | SOLUTION>] [command] [options]
dotnet format -h|--help
dotnet format
è un formattatore di codice che applica le preferenze di stile e le raccomandazioni per l'analisi statica a un progetto o a una soluzione. Le preferenze verranno lette da un file .editorconfig, se presente, altrimenti verrà usato un set predefinito di preferenze. Per altre informazioni, vedere la documentazione di EditorConfig.
PROJECT | SOLUTION
Progetto o soluzione MSBuild in cui eseguire la formattazione del codice. Se non viene specificato alcun file di progetto o di soluzione, MSBuild cercherà nella directory di lavoro corrente un file con estensione proj o sln e userà questo file.
Nessuna delle opzioni seguenti è necessaria affinché il comando dotnet format
abbia esito positivo, ma è possibile usarle per personalizzare ulteriormente ciò che viene formattato e in base a quali regole.
--diagnostics <DIAGNOSTICS>
Elenco di ID di diagnostica separati da spazi da usare come filtro per la correzione dello stile del codice o di problemi di terze parti. Il valore predefinito corrisponde agli ID elencati nel file .editorconfig. Per un elenco degli ID regola dell'analizzatore predefinito che è possibile specificare, vedere l'elenco degli ID per le regole di stile di analisi del codice.
--severity
Gravità minima della diagnostica da correggere. I valori consentiti sono
info
,warn
eerror
. Il valore predefinito èwarn
.--no-restore
Non esegue un ripristino implicito prima della formattazione. L'impostazione predefinita consiste nell'eseguire il ripristino implicito.
--verify-no-changes
Verifica che non vengano eseguite modifiche di formattazione. Termina con un codice di uscita diverso da zero in presenza di file formattati.
--include <INCLUDE>
Elenco separato da spazi di percorsi relativi di file o cartelle da includere dalla formattazione. Il valore predefinito è tutti i file nella soluzione o nel progetto.
--exclude <EXCLUDE>
Elenco separato da spazi di percorsi relativi di file o cartelle da escludere dalla formattazione. Il valore predefinito è Nessuno.
--include-generated
Formatta i file generati dall'SDK.
-v|--verbosity <LEVEL>
Imposta il livello di dettaglio. I valori consentiti sono
q[uiet]
,m[inimal]
,n[ormal]
,d[etailed]
ediag[nostic]
. Il valore predefinito èm[inimal]
.--binarylog <BINARY-LOG-PATH>
Registra tutte le informazioni di caricamento del progetto o della soluzione in un file di log binario.
--report <REPORT-PATH>
Produce un report JSON nella directory specificata da
<REPORT_PATH>
.-h|--help
Mostra informazioni sulla Guida e sull'utilizzo
dotnet format whitespace
: formatta il codice in modo che corrisponda alle impostazioni di editorconfig
per gli spazi vuoti.
Il dotnet format whitespace
sottocomando esegue solo regole di formattazione associate alla formattazione degli spazi vuoti. Per un elenco completo delle possibili opzioni di formattazione che è possibile specificare nel file .editorconfig, vedere le opzioni di formattazione C#.
--folder
Considerare l'argomento
<PROJECT | SOLUTION>
come percorso di una semplice cartella di file di codice.
dotnet format style
: formatta il codice in modo che corrisponda alle impostazioni di EditorConfig per lo stile del codice.
Il dotnet format style
sottocomando esegue solo regole di formattazione associate alla formattazione dello stile del codice. Per un elenco completo delle opzioni di formattazione che è possibile specificare nel file editorconfig
, vedere Regole di stile del codice.
--diagnostics <DIAGNOSTICS>
Elenco delimitato da spazi di ID di diagnostica da usare come filtro per la risoluzione dei problemi di stile del codice. Il valore predefinito corrisponde agli ID elencati nel file .editorconfig. Per un elenco degli ID regola dell'analizzatore dello stile di codice predefiniti che è possibile specificare, vedere l'elenco di ID per le regole di stile di analisi del codice.
--severity
Gravità minima della diagnostica da correggere. I valori consentiti sono
info
,warn
eerror
. Il valore predefinito èwarn
.
dotnet format analyzers
- Formatta il codice in modo che corrisponda editorconfig
alle impostazioni per gli analizzatori (escluse le regole di stile del codice).
Il dotnet format analyzers
sottocomando esegue solo regole di formattazione associate agli analizzatori. Per un elenco delle regole dell'analizzatore che è possibile specificare nel editorconfig
file, vedere Regole di qualità.
--diagnostics <DIAGNOSTICS>
Elenco delimitato da spazi di ID di diagnostica da usare come filtro per la correzione di problemi di stile non di codice. Il valore predefinito corrisponde agli ID elencati nel file .editorconfig. Per un elenco degli ID regola dell'analizzatore predefiniti che è possibile specificare, vedere l'elenco degli ID per le regole di qualità. Per gli analizzatori di terze parti, vedere la relativa documentazione.
--severity
Gravità minima della diagnostica da correggere. I valori consentiti sono
info
,warn
eerror
. Il valore predefinito èwarn
.
Formattare tutto il codice nella soluzione:
CLI .NETdotnet format ./solution.sln
Cancellare tutto il codice nel progetto dell'applicazione:
CLI .NETdotnet format ./src/application.csproj
Verificare che tutto il codice sia formattato correttamente:
CLI .NETdotnet format --verify-no-changes
Pulire tutto il codice nella directory src e test, ma non in src/submodule-a:
CLI .NETdotnet format --include ./src/ ./tests/ --exclude ./src/submodule-a/
Correzione di un problema di stile del codice specifico:
CLI .NETdotnet format style --diagnostics IDE0005 --severity info
Risolvere tutti i problemi di stile del codice con gravità
info
owarning
error
:CLI .NETdotnet format style --severity info
Correzione di un problema specifico dell'analizzatore (non dello stile del codice):
CLI .NETdotnet format analyzers --diagnostics CA1831 --severity warn
Risolvere tutti i problemi di stile non del codice con gravità
info
owarning
error
:CLI .NETdotnet format analyzers --severity info
Feedback su .NET
.NET è un progetto di open source. Selezionare un collegamento per fornire feedback: