dotnet formátum

Ez a cikk a következő verziókra vonatkozik: ✔️ .NET 6 SDK és újabb verziók

Név

dotnet format – A beállításoknak megfelelő editorconfig kód formázása.

Szinopszis

dotnet format [<PROJECT | SOLUTION>]
  [--binarylog <BINARY-LOG-PATH>] [--diagnostics <DIAGNOSTICS>]
  [--exclude <EXCLUDE>] [--exclude-diagnostics <EXCLUDE-DIAGNOSTICS>]
  [--include <INCLUDE>] [--include-generated]
  [--no-restore] [--report <REPORT-PATH>] [--severity <LEVEL>]
  [-v|--verbosity <LEVEL>] [--verify-no-changes] [--version]

dotnet format -h|--help

Leírás

dotnet format olyan kódformázás, amely stílusbeállításokat és statikus elemzési javaslatokat alkalmaz egy projektre vagy megoldásra. A beállítások egy .editorconfig fájlból lesznek beolvasva , ha vannak ilyenek, ellenkező esetben egy alapértelmezett beállításkészlet lesz használva. További információkért tekintse meg a EditorConfig dokumentációját.

Argumentumok

PROJECT | SOLUTION

Az MSBuild projekt vagy megoldás a kódformázás futtatásához. Ha nincs megadva projekt- vagy megoldásfájl, az MSBuild a jelenlegi munkakönyvtárban keres egy olyan fájlt, amely proj vagy sln végződésű fájlkiterjesztéssel rendelkezik, és ezt a fájlt használja.

Caution

A dotnet formátum visszaállíthatja, lefordíthatja és futtathatja az elemzőket a megadott projektből vagy megoldásból. Csak megbízható kóddal hívja meg az eszközt.

Beállítások

Az alábbi lehetőségek egyike sem szükséges a dotnet format parancs sikeres végrehajtásához, de a formázás és a szabályok további testreszabásához használhatja őket.

• --binarylog <BINARY-LOG-PATH>

  Naplózza az összes projekt- vagy megoldásbetöltési információt egy bináris naplófájlba.

• --diagnostics <DIAGNOSTICS>

  A szűrőként használandó diagnosztikai azonosítók szóközzel elválasztott listája kódstílusok vagy külső felektől származó problémák kijavításakor. Az alapértelmezett érték az, amelyik azonosító szerepel a .editorconfig fájlban. A megadható beépített elemzőszabály-azonosítók listáját a kódelemzési stílusszabályok azonosítóinak listájában találja.

• --exclude <EXCLUDE>

  A formázásból kizárandó relatív fájl- vagy mappaelérési utak szóközzel elválasztott listája. Az alapértelmezett érték a none.

• --exclude-diagnostics <EXCLUDE-DIAGNOSTICS>

  A kódstílusok vagy külső felektől származó problémák kijavításakor kizárandó diagnosztikai azonosítók szóközzel elválasztott listája. Az alapértelmezett érték nincs. A megadható beépített elemzőszabály-azonosítók listáját a kódelemzési stílusszabályok azonosítóinak listájában találja.

• --include <INCLUDE>

  A formázásba belefoglalandó relatív fájl- vagy mappaelérési utak szóközzel elválasztott listája. Az alapértelmezett érték a megoldás vagy projekt összes fájlja.

• --include-generated

  Formázja az SDK által létrehozott fájlokat.

• --no-restore

  Formázás előtt nem hajt végre implicit visszaállítást. Alapértelmezés szerint implicit visszaállítást kell végezni.

• --report <REPORT-PATH>

  JSON-jelentést hoz létre a megadott <REPORT_PATH>könyvtárban.

• --severity <LEVEL>

  A kijavítandó diagnosztikák minimális súlyossága. Az engedélyezett értékek a következőkinfo: és warnerror. Az alapértelmezett érték warn.

• --verify-no-changes

  Ellenőrzi, hogy nem történik-e formázási módosítás. Nem nulla kilépési kóddal végződik, ha bármilyen fájl formázva lett volna.

• --version

  A verzióinformációkat jeleníti meg.

• -v|--verbosity <LEVEL>

  A parancs részletességi szintjét állítja be. Az engedélyezett értékek a következőkq[uiet]: , m[inimal], n[ormal]d[etailed]és diag[nostic]. További információért lásd LoggerVerbosity.

• -?|-h|--help

  A parancs használatának leírását nyomtatja ki.

Alparancsok

Térköz

dotnet format whitespace – A szóköz beállításainak megfelelő editorconfig kód formázása.

Leírás

Az dotnet format whitespace alparancs csak a szóköz formázásához társított formázási szabályokat futtatja. A .editorconfig fájlban megadható lehetséges formázási beállítások teljes listájáért tekintse meg a C# formázási beállításait.

Beállítások

• --folder

  Az argumentumot <PROJECT | SOLUTION> a kódfájlok egyszerű mappájának elérési útjaként kezelje.

Stílus

dotnet format style – Kód formázása a kódstílus Szerkesztőkonfigurációs beállításainak megfelelően.

Leírás

Az dotnet format style alparancs csak a kódstílus-formázáshoz társított formázási szabályokat futtatja. A fájlban editorconfig megadható formázási beállítások teljes listáját a Kódstílus-szabályok című témakörben találja.

Beállítások

• --diagnostics <DIAGNOSTICS>

  A kódstílussal kapcsolatos problémák megoldásakor szűrőként használandó diagnosztikai azonosítók szóközzel elválasztott listája. Az alapértelmezett érték az, amelyik azonosító szerepel a .editorconfig fájlban. A megadható beépített kódstílus-elemzőszabály-azonosítók listájáért tekintse meg a kódelemzési stílusszabályok azonosítóinak listáját.

• --severity <LEVEL>

  A kijavítandó diagnosztikák minimális súlyossága. Az engedélyezett értékek a következőkinfo: és warnerror. Az alapértelmezett érték a következő: warn

Elemzők

dotnet format analyzers – Az elemzők beállításainak megfelelő editorconfig kódot formáz (a kódstílus-szabályok kivételével).

Leírás

Az dotnet format analyzers alparancs csak az elemzőkhöz társított formázási szabályokat futtatja. A fájlban editorconfig megadható elemzőszabályok listáját a Minőségi szabályok című témakörben találja.

Beállítások

• --diagnostics <DIAGNOSTICS>

  A nem kódstílussal kapcsolatos problémák megoldásakor szűrőként használandó diagnosztikai azonosítók szóközzel elválasztott listája. Az alapértelmezett érték az, amelyik azonosító szerepel a .editorconfig fájlban. A megadható beépített elemzőszabály-azonosítók listáját a minőségi szabályok azonosítóinak listájában találja. Külső elemzők esetében tekintse meg a dokumentációt.

• --severity <LEVEL>

  A kijavítandó diagnosztikák minimális súlyossága. Az engedélyezett értékek a következőkinfo: és warnerror. Az alapértelmezett érték warn.

Példák

• A megoldás összes kódjának formázása:

  dotnet format ./solution.sln
  

• Az alkalmazásprojekt összes kódjának törlése:

  dotnet format ./src/application.csproj
  

• Ellenőrizze, hogy az összes kód megfelelően van-e formázva:

  dotnet format --verify-no-changes
  

• Törölje az összes kódot az src-ben, és teszteli a könyvtárat, de nem az src/submodule-a fájlban:

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

• Adott kódstílussal kapcsolatos probléma megoldása:

  dotnet format style --diagnostics IDE0005 --severity info
  

• Kijavítottuk az összes olyan kódstílus-problémát , amely súlyos info, warning vagy error:

  dotnet format style --severity info
  

• Adott (nem kódstílusú) elemzővel kapcsolatos probléma kijavítása:

  dotnet format analyzers --diagnostics CA1831 --severity warn
  

• Kijavítottunk minden olyan nem kódstílussal kapcsolatos problémát, amely súlyos info, warning vagy error:

  dotnet format analyzers --severity info