Przeczytaj w języku angielskim

Udostępnij za pośrednictwem


format dotnet

Ten artykuł dotyczy: ✔️ zestaw .NET 6.x SDK i nowsze wersje

Nazwisko

dotnet format - Formatuje kod zgodny z editorconfig ustawieniami.

Streszczenie

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

dotnet format -h|--help

opis

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.

Argumenty

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.

Opcje

Ż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, warni error. Domyślna wartość to warn.

  • --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], i diag[nostic]. Wartość domyślna to m[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

Podpoleceń polecenia

Whitespace

dotnet format whitespace - Formatuje kod, aby dopasować editorconfig ustawienia białych znaków.

opis

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#.

Opcje

  • --folder

    <PROJECT | SOLUTION> Traktuj argument jako ścieżkę do prostego folderu plików kodu.

Styl

dotnet format style - Formatuje kod zgodny z ustawieniami EditorConfig stylu kodu.

opis

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.

Opcje

  • --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, warni error. Domyślna wartość to warn

Analizatory

dotnet format analyzers - Formatuje kod, aby dopasować editorconfig ustawienia analizatorów (z wyłączeniem reguł stylu kodu).

opis

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.

Opcje
  • --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, warni error. Domyślna wartość to warn.

Przykłady

  • 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ść infolub warning 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 infolub errorwarning :

    dotnet format analyzers --severity info