dotnet-format

Den här artikeln gäller för: ✔️ .NET 6 SDK och senare versioner

Name

dotnet format – Formaterar kod för att matcha editorconfig inställningarna.

Sammanfattning

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

beskrivning

dotnet format är en kodformaterare som tillämpar stilinställningar och statiska analysrekommendationer för ett projekt eller en lösning. Inställningar kommer att läsas från en .editorconfig-fil , annars används en standarduppsättning med inställningar. Mer information finns i dokumentationen för EditorConfig.

Argument

PROJECT | SOLUTION

MSBuild-projektet eller lösningen som kodformatering ska köras på. Om ett projekt eller en lösningsfil inte har angetts söker MSBuild i den aktuella arbetskatalogen efter en fil som har ett filnamnstillägg som slutar i proj eller sln och använder den filen.

Alternativ

Inget av alternativen nedan krävs för dotnet format att kommandot ska lyckas, men du kan använda dem för att ytterligare anpassa vad som är formaterat och med vilka regler.

• --binarylog <BINARY-LOG-PATH>

  Loggar all information om projekt- eller lösningsinläsning till en binär loggfil.

• --diagnostics <DIAGNOSTICS>

  En blankstegsavgränsad lista över diagnostik-ID:t som ska användas som ett filter när du åtgärdar kodformat eller problem från tredje part. Standardvärdet är det ID som visas i .editorconfig-filen . En lista över inbyggda analysregel-ID:er som du kan ange finns i listan över ID:er för regler för kodanalysstil.

• --exclude <EXCLUDE>

  En blankstegsavgränsad lista över relativa fil- eller mappsökvägar som ska undantas från formatering. Standardvärdet är none.

• --exclude-diagnostics <EXCLUDE-DIAGNOSTICS>

  En blankstegsavgränsad lista över diagnostik-ID:er som ska undantas när du åtgärdar kodformat eller problem från tredje part. Standardvärdet är inget. En lista över inbyggda analysregel-ID:er som du kan ange finns i listan över ID:er för regler för kodanalysstil.

• --include <INCLUDE>

  En blankstegsavgränsad lista över relativa fil- eller mappsökvägar som ska inkluderas i formateringen. Standardvärdet är alla filer i lösningen eller projektet.

• --include-generated

  Formaterar filer som genereras av SDK:et.

• --no-restore

  Kör inte en implicit återställning innan formateringen. Standard är att göra implicit återställning.

• --report <REPORT-PATH>

  Skapar en JSON-rapport i katalogen som anges av <REPORT_PATH>.

• --severity <LEVEL>

  Minsta allvarlighetsgrad för diagnostik som ska åtgärdas. Tillåtna värden är info, warnoch error. Standardvärdet är warn.

• --verify-no-changes

  Verifierar att inga formateringsändringar skulle utföras. Avslutas med en slutkod som inte är noll om några filer skulle ha formaterats.

• --version

  Visar versionsinformation.

• -v|--verbosity <LEVEL>

  Anger kommandots verbositetsnivå. Tillåtna värden är q[uiet], m[inimal], n[ormal], d[etailed]och diag[nostic]. Mer information finns i LoggerVerbosity.

• -?|-h|--help

  Skriver ut en beskrivning av hur du använder kommandot.

Underkommandon

Tomt utrymme

dotnet format whitespace – Formaterar kod för att matcha editorconfig inställningarna för blanksteg.

beskrivning

Underkommandot dotnet format whitespace kör endast formateringsregler som är associerade med blankstegsformatering. En fullständig lista över möjliga formateringsalternativ som du kan ange i .editorconfig-filen finns i formateringsalternativen för C#.

Alternativ

• --folder

  <PROJECT | SOLUTION> Behandla argumentet som en sökväg till en enkel mapp med kodfiler.

Format

dotnet format style – Formaterar kod som matchar EditorConfig-inställningar för kodformat.

beskrivning

Underkommandot dotnet format style kör endast formateringsregler som är associerade med formatering av kodformatering. En fullständig lista över formateringsalternativ som du kan ange i filen finns i editorconfig Regler för kodformat.

Alternativ

• --diagnostics <DIAGNOSTICS>

  En blankstegsavgränsad lista över diagnostik-ID:er som ska användas som ett filter när du åtgärdar problem med kodformat. Standardvärdet är det ID som visas i .editorconfig-filen . En lista över inbyggda kodformatsanalysregel-ID:er som du kan ange finns i listan över ID:er för regler för kodanalysstil.

• --severity <LEVEL>

  Minsta allvarlighetsgrad för diagnostik som ska åtgärdas. Tillåtna värden är info, warnoch error. Standardvärdet är warn

Analysverktyg

dotnet format analyzers – Formaterar kod för att matcha editorconfig inställningar för analysverktyg (exklusive regler för kodformat).

beskrivning

Underkommandot dotnet format analyzers kör endast formateringsregler som är associerade med analysverktyg. En lista över analysregler som du kan ange i filen finns i editorconfig Kvalitetsregler.

Alternativ

• --diagnostics <DIAGNOSTICS>

  En blankstegsavgränsad lista över diagnostik-ID:er som ska användas som ett filter när problem med icke-kodformat åtgärdas. Standardvärdet är det ID som visas i .editorconfig-filen . En lista över inbyggda analysregel-ID:t som du kan ange finns i listan över ID:er för kvalitetsregler. För analysverktyg från tredje part, se deras dokumentation.

• --severity <LEVEL>

  Minsta allvarlighetsgrad för diagnostik som ska åtgärdas. Tillåtna värden är info, warnoch error. Standardvärdet är warn.

Exempel

• Formatera all kod i lösningen:

  dotnet format ./solution.sln
  

• Rensa all kod i programprojektet:

  dotnet format ./src/application.csproj
  

• Kontrollera att all kod är korrekt formaterad:

  dotnet format --verify-no-changes
  

• Rensa all kod i katalogen src och tests men inte i src/submodule-a:

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

• Åtgärda ett specifikt kodformatsproblem :

  dotnet format style --diagnostics IDE0005 --severity info
  

• Åtgärda alla problem med kodformat som har allvarlighetsgrad info, warning eller error:

  dotnet format style --severity info
  

• Åtgärda ett specifikt (icke-kodformat) analysproblem:

  dotnet format analyzers --diagnostics CA1831 --severity warn
  

• Åtgärda alla problem med icke-kodformat som har allvarlighetsgrad info, warning eller error:

  dotnet format analyzers --severity info