dotnet format

Tento článek se vztahuje na: ✔️ .NET 6.x SDK a novější verze

Název

dotnet format - Formátuje kód tak, aby odpovídal editorconfig nastavení.

Synopse

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

dotnet format -h|--help

Popis

dotnet format je formátovací modul kódu, který na projekt nebo řešení používá předvolby stylu a doporučení pro statickou analýzu. Předvolby se budou číst ze souboru .editorconfig , pokud je k dispozici, jinak se použije výchozí sada předvoleb. Další informace najdete v dokumentaci editorconfig.

Argumenty

PROJECT | SOLUTION

Projekt nebo řešení NÁSTROJE MSBuild pro spuštění formátování kódu Pokud není zadán soubor projektu nebo řešení, nástroj MSBuild vyhledá aktuální pracovní adresář pro soubor, který má příponu souboru končící proj nebo sln, a použije tento soubor.

Možnosti

K úspěšnému dotnet format provedení příkazu není potřeba žádná z níže uvedených možností, ale můžete je použít k dalšímu přizpůsobení formátování a podle pravidel.

• --diagnostics <DIAGNOSTICS>

  Seznam diagnostických ID oddělených mezerami, který se má použít jako filtr při opravě stylu kódu nebo problémů třetích stran. Výchozí hodnota je podle toho, která ID jsou uvedena v souboru .editorconfig . Seznam předdefinovaných ID pravidel analyzátoru, které můžete zadat, najdete v seznamu ID pravidel stylu analýzy kódu.

• --severity

  Minimální závažnost diagnostiky, která se má opravit. Povolené hodnoty jsou info, warna error. Výchozí hodnota je warn.

• --no-restore

  Před formátováním nespustí implicitní obnovení. Výchozí nastavení je provést implicitní obnovení.

• --verify-no-changes

  Ověřuje, že se neprovedou žádné změny formátování. Ukončí se nenulovým ukončovacím kódem, pokud by byly nějaké soubory naformátované.

• --include <INCLUDE>

  Seznam relativních cest k souboru nebo složek oddělených mezerami, které chcete zahrnout do formátování. Výchozí hodnota je všechny soubory v řešení nebo projektu.

• --exclude <EXCLUDE>

  Seznam relativních cest k souborům nebo složkám oddělených mezerami, které se mají vyloučit z formátování. Výchozí hodnota je none.

• --include-generated

  Formátuje soubory generované sadou SDK.

• -v|--verbosity <LEVEL>

  Nastaví úroveň podrobností. Povolené hodnoty jsou q[uiet], , n[ormal]m[inimal], d[etailed]a diag[nostic]. Výchozí hodnota je m[inimal].

• --binarylog <BINARY-LOG-PATH>

  Zaznamená všechny informace o načtení projektu nebo řešení do souboru binárního protokolu.

• --report <REPORT-PATH>

  Vytvoří sestavu JSON v adresáři určeném parametrem <REPORT_PATH>.

• -h|--help

  Zobrazuje informace o nápovědě a využití.

Podpříkazy

Whitespace

dotnet format whitespace - Formátuje kód tak, aby odpovídal editorconfig nastavení prázdných znaků.

Popis

Podpříkaz dotnet format whitespace spouští pouze pravidla formátování přidružená k formátování prázdných znaků. Úplný seznam možných možností formátování, které můžete zadat v souboru .editorconfig, najdete v možnostech formátování jazyka C#.

Možnosti

• --folder

  <PROJECT | SOLUTION> Považovat argument za cestu k jednoduché složce souborů kódu.

Styl

dotnet format style - Formátuje kód tak, aby odpovídal nastavení EditorConfig pro styl kódu.

Popis

Podpříkaz dotnet format style spouští pouze pravidla formátování přidružená k formátování stylu kódu. Úplný seznam možností formátování, které můžete zadat v souboru, najdete v editorconfig tématu Pravidla stylu kódu.

Možnosti

• --diagnostics <DIAGNOSTICS>

  Seznam diagnostických ID oddělených mezerami, který se má použít jako filtr při řešení problémů se stylem kódu. Výchozí hodnota je podle toho, která ID jsou uvedena v souboru .editorconfig . Seznam předdefinovaných ID pravidel analyzátoru stylu kódu, které můžete zadat, najdete v seznamu ID pravidel stylu analýzy kódu.

• --severity

  Minimální závažnost diagnostiky, která se má opravit. Povolené hodnoty jsou info, warna error. Výchozí hodnota je warn

Analyzátory

dotnet format analyzers - Formátuje kód tak, aby odpovídal editorconfig nastavení analyzátorů (s výjimkou pravidel stylu kódu).

Popis

Podpříkaz dotnet format analyzers spouští pouze pravidla formátování přidružená k analyzátorům. Seznam pravidel analyzátoru, která můžete zadat v souboru, naleznete v editorconfig tématu Pravidla kvality.

Možnosti

• --diagnostics <DIAGNOSTICS>

  Seznam diagnostických ID oddělených mezerami, který se má použít jako filtr při opravě problémů s jiným stylem kódu. Výchozí hodnota je podle toho, která ID jsou uvedena v souboru .editorconfig . Seznam předdefinovaných ID pravidel analyzátoru, které můžete zadat, najdete v seznamu ID pravidel kvality. Analyzátory třetích stran najdete v jejich dokumentaci.

• --severity

  Minimální závažnost diagnostiky, která se má opravit. Povolené hodnoty jsou info, warna error. Výchozí hodnota je warn.

Příklady

• Naformátujte veškerý kód v řešení:

  dotnet format ./solution.sln
  

• Vyčistěte veškerý kód v projektu aplikace:

  dotnet format ./src/application.csproj
  

• Ověřte, že je veškerý kód správně naformátovaný:

  dotnet format --verify-no-changes
  

• Vyčistěte veškerý kód v adresáři src a testech, ale ne v src/submodule-a:

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

• Oprava konkrétního problému se stylem kódu:

  dotnet format style --diagnostics IDE0005 --severity info
  

• Oprava všech problémů se stylem kódu, které mají závažnost infonebo warning error:

  dotnet format style --severity info
  

• Oprava konkrétního problému s analyzátorem (bez stylu kódu):

  dotnet format analyzers --diagnostics CA1831 --severity warn
  

• Oprava všech problémů se stylem kódu, které mají závažnost infoneboerrorwarning:

  dotnet format analyzers --severity info