dotnet format

Dieser Artikel gilt für: ✔️ .NET 6.x SDK und höhere Versionen

Name

dotnet format: Formatiert Code so, dass er mit den editorconfig-Einstellungen übereinstimmt.

Übersicht

dotnet format [<PROJECT | SOLUTION>] [command] [options]

dotnet format -h|--help

Beschreibung

dotnet format ist ein Codeformatierer, der Stileinstellungen und statische Analyseempfehlungen auf ein Projekt oder eine Lösung anwendet. Einstellungen werden aus einer EDITORCONFIG-Datei gelesen, sofern vorhanden, andernfalls wird ein Standardsatz von Einstellungen verwendet. Weitere Informationen finden Sie in der EditorConfig-Dokumentation.

Argumente

PROJECT | SOLUTION

Das MSBuild-Projekt oder die Projektmappe, worauf die Codeformatierung angewendet werden soll. Wenn Sie keine Projekt- oder Projektmappendatei angeben, durchsucht MSBuild das aktuelle Arbeitsverzeichnis nach einer Dateierweiterung, die mit proj oder sln endet, und verwendet diese.

Optionen

Keine der folgenden Optionen ist für die erfolgreiche Ausführung des dotnet format-Befehls erforderlich. Sie können damit jedoch weiter anpassen, was nach welchen Regeln formatiert wird.

• --diagnostics <DIAGNOSTICS>

  Eine durch Leerzeichen getrennte Liste von Diagnose-IDs, die beim Beheben von Codeformat- oder Drittanbieterproblemen als Filter verwendet werden. Der Standardwert gibt an, welche IDs in der .editorconfig-Datei aufgelistet sind. Eine Liste der integrierten Analyseregel-IDs, die Sie angeben können, finden Sie in der Liste der IDs für Codeanalyse-Formatregeln.

• --severity

  Der zu behebende diagnostizierte Mindestschweregrad. Zulässige Werte sind info, warn und error. Der Standardwert ist warn.

• --no-restore

  Vor der Formatierung wird keine implizite Wiederherstellung ausgeführt. Die Standardeinstellung ist die implizite Wiederherstellung.

• --verify-no-changes

  Es wird überprüft, ob keine Formatierungsänderungen vorgenommen werden. Wenn Dateien formatiert wurden, ist der Exitcode nicht 0 (null) ist.

• --include <INCLUDE>

  Eine durch Leerzeichen getrennte Liste relativer Datei- oder Ordnerpfade, die in die Formatierung aufgenommen werden. Standardmäßig werden alle Dateien in der Projektmappe oder im Projekt einbezogen.

• --exclude <EXCLUDE>

  Eine durch Leerzeichen getrennte Liste relativer Datei- oder Ordnerpfade, die von der Formatierung ausgeschlossen werden. Der Standardwert ist „none“.

• --include-generated

  Vom SDK generierte Dateien werden formatiert.

• -v|--verbosity <LEVEL>

  Legt den Ausführlichkeitsgrad fest. Zulässige Werte sind q[uiet], m[inimal], n[ormal], d[etailed] und diag[nostic]. Der Standardwert ist m[inimal]sein.

• --binarylog <BINARY-LOG-PATH>

  Protokolliert alle Projekt- oder Projektmappen-Ladeinformationen in einer binären Protokolldatei.

• --report <REPORT-PATH>

  Erzeugt einen JSON-Bericht in dem durch <REPORT_PATH> angegebenen Verzeichnis.

• -h|--help

  Zeigt Hilfe- und Nutzungsinformationen an.

Unterbefehle

Leerraum

dotnet format whitespace: Formatiert Code so, dass er mit den editorconfig-Einstellungen für Leerraum übereinstimmt.

Beschreibung

Der dotnet format whitespace Unterbefehl führt nur Formatierungsregeln aus, die der Leerzeichenformatierung zugeordnet sind. Eine vollständige Liste der möglichen Formatierungsoptionen, die Sie in Ihrer EDITORCONFIG-Datei angeben können, finden Sie unter C#-Formatierungsoptionen.

Tastatur

• --folder

  Behandeln Sie das Argument <PROJECT | SOLUTION> als einen Pfad zu einem einfachen Ordner mit Codedateien.

Style

dotnet format style: Formatiert Code so, dass er mit EditorConfig-Einstellungen für das Codeformat übereinstimmt.

Beschreibung

Der dotnet format style Unterbefehl führt nur Formatierungsregeln aus, die mit der Formatierung von Codeformaten verknüpft sind. Eine vollständige Liste der Formatierungsoptionen, die Sie in Ihrer editorconfig-Datei angeben können, finden Sie in den Codeformatregeln.

Optionen

• --diagnostics <DIAGNOSTICS>

  Eine durch Leerzeichen getrennte Liste von Diagnose-IDs, die beim Beheben von Codeformatproblemen als Filter verwendet werden sollen. Der Standardwert gibt an, welche IDs in der .editorconfig-Datei aufgelistet sind. Eine Liste der integrierten Regel-IDs der Codeformatanalyse, die Sie angeben können, finden Sie in der Liste der IDs für Codeanalysestilregeln.

• --severity

  Der zu behebende diagnostizierte Mindestschweregrad. Zulässige Werte sind info, warn und error. Der Standardwert ist warn

Analysemodule

dotnet format analyzers - Formatiert Code, der den Einstellungen für Analysegeräte entspricht editorconfig (mit Ausnahme von Codestilregeln).

Beschreibung

Der dotnet format analyzers Unterbefehl führt nur Formatierungsregeln aus, die Analysegeräten zugeordnet sind. Eine Liste der Analyseregeln, die Sie in Ihrer editorconfig Datei angeben können, finden Sie unter "Qualitätsregeln".

Optionen

• --diagnostics <DIAGNOSTICS>

  Eine durch Leerzeichen getrennte Liste von Diagnose-IDs, die beim Beheben von Problemen mit nicht-Codeformatvorlagen als Filter verwendet werden sollen. Der Standardwert gibt an, welche IDs in der .editorconfig-Datei aufgelistet sind. Eine Liste der integrierten Analyseregel-IDs, die Sie angeben können, finden Sie in der Liste der IDs für Qualitätsregeln. Informationen zu Drittanbieteranalysatoren finden Sie in ihrer Dokumentation.

• --severity

  Der zu behebende diagnostizierte Mindestschweregrad. Zulässige Werte sind info, warn und error. Der Standardwert ist warn.

Beispiele

• Formatieren des gesamten Codes in der Projektmappe:

  dotnet format ./solution.sln
  

• Bereinigen des gesamten Codes im Anwendungsprojekt:

  dotnet format ./src/application.csproj
  

• Überprüfen des gesamten Codes auf ordnungsgemäße Formatierung:

  dotnet format --verify-no-changes
  

• Bereinigen des gesamten Codes in den Verzeichnissen src und tests, aber nicht in src/submodule-a:

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

• Behebung eines bestimmten Codestilproblems :

  dotnet format style --diagnostics IDE0005 --severity info
  

• Beheben aller Codestilprobleme mit schwerem infowarning Schweregrad oder error:

  dotnet format style --severity info
  

• Behebung eines bestimmten (nicht codefreien) Analyseproblems:

  dotnet format analyzers --diagnostics CA1831 --severity warn
  

• Beheben Sie alle Probleme im Nicht-Codeformat, die schweregrad infohaben, warning oder error:

  dotnet format analyzers --severity info