format dotnet
Ten artykuł dotyczy: ✔️ zestaw .NET 6.x SDK i nowsze wersje
dotnet format
- Formatuje kod zgodny z editorconfig
ustawieniami.
dotnet format [<PROJECT | SOLUTION>] [command] [options]
dotnet format -h|--help
dotnet format
to program formatujący kod, który stosuje preferencje stylu i zalecenia dotyczące analizy statycznej do projektu lub rozwiązania. Preferencje będą odczytywane z pliku .editorconfig , jeśli jest obecny, w przeciwnym razie zostanie użyty domyślny zestaw preferencji. Aby uzyskać więcej informacji, zobacz dokumentację EditorConfig.
PROJECT | SOLUTION
Projekt lub rozwiązanie programu MSBuild do uruchamiania formatowania kodu. Jeśli nie określono pliku projektu lub rozwiązania, program MSBuild przeszukuje bieżący katalog roboczy dla pliku z rozszerzeniem pliku kończącym się na pliku proj lub sln i używa tego pliku.
Żadna z poniższych opcji nie jest wymagana, dotnet format
aby polecenie powiodło się, ale można ich użyć do dalszego dostosowywania formatowanych elementów i reguł.
--diagnostics <DIAGNOSTICS>
Rozdzielona spacjami lista identyfikatorów diagnostycznych do użycia jako filtr podczas rozwiązywania problemów ze stylem kodu lub problemami innych firm. Wartość domyślna to identyfikatory wymienione w pliku .editorconfig . Aby uzyskać listę wbudowanych identyfikatorów reguł analizatora, które można określić, zobacz listę identyfikatorów reguł stylu analizy kodu.
--severity
Minimalna ważność diagnostyki do naprawienia. Dozwolone wartości to
info
,warn
ierror
. Domyślna wartość towarn
.--no-restore
Nie wykonuje niejawnego przywracania przed formatowaniem. Ustawieniem domyślnym jest wykonywanie niejawnego przywracania.
--verify-no-changes
Sprawdza, czy nie zostaną wykonane żadne zmiany formatowania. Kończy się kodem zakończenia innym niż zero, jeśli jakiekolwiek pliki zostały sformatowane.
--include <INCLUDE>
Rozdzielona spacjami lista względnych ścieżek plików lub folderów do uwzględnienia w formatowaniu. Wartość domyślna to wszystkie pliki w rozwiązaniu lub projekcie.
--exclude <EXCLUDE>
Rozdzielona spacjami lista względnych ścieżek plików lub folderów do wykluczenia z formatowania. Wartość domyślna to Brak.
--include-generated
Formatuje pliki generowane przez zestaw SDK.
-v|--verbosity <LEVEL>
Ustawia poziom szczegółowości. Dozwolone wartości to
q[uiet]
, ,n[ormal]
m[inimal]
,d[etailed]
, idiag[nostic]
. Wartość domyślna tom[inimal]
.--binarylog <BINARY-LOG-PATH>
Rejestruje wszystkie informacje o projekcie lub rozwiązaniu do pliku dziennika binarnego.
--report <REPORT-PATH>
Tworzy raport JSON w katalogu określonym przez
<REPORT_PATH>
.-h|--help
Pokazuje informacje pomocy i użycia
dotnet format whitespace
- Formatuje kod, aby dopasować editorconfig
ustawienia białych znaków.
Podpolecenia dotnet format whitespace
uruchamia tylko reguły formatowania skojarzone z formatowaniem białych znaków. Aby uzyskać pełną listę możliwych opcji formatowania, które można określić w pliku .editorconfig , zobacz opcje formatowania języka C#.
--folder
<PROJECT | SOLUTION>
Traktuj argument jako ścieżkę do prostego folderu plików kodu.
dotnet format style
- Formatuje kod zgodny z ustawieniami EditorConfig stylu kodu.
Podpolecenia dotnet format style
uruchamia tylko reguły formatowania skojarzone z formatowaniem stylu kodu. Aby uzyskać pełną listę opcji formatowania, które można określić w editorconfig
pliku, zobacz Reguły stylu kodu.
--diagnostics <DIAGNOSTICS>
Rozdzielona spacjami lista identyfikatorów diagnostycznych, które mają być używane jako filtr podczas rozwiązywania problemów ze stylem kodu. Wartość domyślna to identyfikatory wymienione w pliku .editorconfig . Aby uzyskać listę wbudowanych identyfikatorów reguł analizatora stylu kodu, które można określić, zobacz listę identyfikatorów reguł stylu analizy kodu.
--severity
Minimalna ważność diagnostyki do naprawienia. Dozwolone wartości to
info
,warn
ierror
. Domyślna wartość towarn
dotnet format analyzers
- Formatuje kod, aby dopasować editorconfig
ustawienia analizatorów (z wyłączeniem reguł stylu kodu).
Podpolecenia dotnet format analyzers
uruchamia tylko reguły formatowania skojarzone z analizatorami. Aby uzyskać listę reguł analizatora, które można określić w editorconfig
pliku, zobacz Reguły jakości.
--diagnostics <DIAGNOSTICS>
Rozdzielona spacjami lista identyfikatorów diagnostycznych, które mają być używane jako filtr podczas rozwiązywania problemów ze stylem innym niż kod. Wartość domyślna to identyfikatory wymienione w pliku .editorconfig . Aby uzyskać listę wbudowanych identyfikatorów reguł analizatora, które można określić, zobacz listę identyfikatorów reguł jakości. W przypadku analizatorów innych firm zapoznaj się z ich dokumentacją.
--severity
Minimalna ważność diagnostyki do naprawienia. Dozwolone wartości to
info
,warn
ierror
. Domyślna wartość towarn
.
Sformatuj cały kod w rozwiązaniu:
dotnet format ./solution.sln
Wyczyść cały kod w projekcie aplikacji:
dotnet format ./src/application.csproj
Sprawdź, czy cały kod jest poprawnie sformatowany:
dotnet format --verify-no-changes
Wyczyść cały kod w katalogu src i testach , ale nie w pliku src/submodule-a:
dotnet format --include ./src/ ./tests/ --exclude ./src/submodule-a/
Rozwiązano problem z określonym stylem kodu:
dotnet format style --diagnostics IDE0005 --severity info
Rozwiąż wszystkie problemy ze stylem kodu, które mają ważność
info
lubwarning
error
:dotnet format style --severity info
Rozwiązano problem z określonym analizatorem (bez stylu kodu):
dotnet format analyzers --diagnostics CA1831 --severity warn
Rozwiąż wszystkie problemy ze stylem innym niż kod o ważności
info
luberror
warning
:dotnet format analyzers --severity info
Opinia o produkcie .NET
.NET to projekt typu open source. Wybierz link, aby przekazać opinię: