dotnet-indeling

Dit artikel is van toepassing op: ✔️ .NET 6 SDK en latere versies

Naam

dotnet format - Hiermee wordt code opgemaakt zodat deze overeenkomt met editorconfig de instellingen.

Samenvatting

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

Beschrijving

dotnet format is een codeopmaaker die stijlvoorkeuren en aanbevelingen voor statische analyse toepast op een project of oplossing. Voorkeuren worden gelezen uit een .editorconfig-bestand , indien aanwezig, anders wordt een standaardset voorkeuren gebruikt. Zie de EditorConfig-documentatie voor meer informatie.

Argumenten

PROJECT | SOLUTION

Het MSBuild-project of de oplossing voor het uitvoeren van codeopmaak. Als er geen project- of oplossingsbestand is opgegeven, zoekt MSBuild in de huidige werkmap naar een bestand met een bestandsextensie die eindigt op proj of sln, en gebruikt dat bestand.

Waarschuwing

Dotnet-indeling kan analyses herstellen, compileren en uitvoeren vanuit het opgegeven project of de opgegeven oplossing. Roep het hulpprogramma alleen aan op basis van vertrouwde code.

Opties

Er zijn geen van de onderstaande opties vereist om de dotnet format opdracht te voltooien, maar u kunt deze gebruiken om verder aan te passen wat is opgemaakt en door welke regels.

• --binarylog <BINARY-LOG-PATH>

  Registreert alle project- of oplossingsinformatie voor het laden van gegevens in een binair logboekbestand.

• --diagnostics <DIAGNOSTICS>

  Een door spaties gescheiden lijst met diagnostische id's die moeten worden gebruikt als filter bij het oplossen van codestijl of problemen van derden. De standaardwaarde is de id's die worden vermeld in het .editorconfig-bestand . Zie de lijst met id's voor codeanalysestijlregels voor een lijst met ingebouwde regel-id's die u kunt opgeven.

• --exclude <EXCLUDE>

  Een door spaties gescheiden lijst met relatieve bestands- of mappaden die moeten worden uitgesloten van opmaak. De standaardwaarde is geen.

• --exclude-diagnostics <EXCLUDE-DIAGNOSTICS>

  Een door spaties gescheiden lijst met diagnostische id's die moeten worden uitgesloten bij het oplossen van codestijl of problemen van derden. De standaardwaarde is geen. Zie de lijst met id's voor codeanalysestijlregels voor een lijst met ingebouwde regel-id's die u kunt opgeven.

• --include <INCLUDE>

  Een door spaties gescheiden lijst met relatieve bestands- of mappaden die moeten worden opgenomen in opmaak. De standaardwaarde is alle bestanden in de oplossing of het project.

• --include-generated

  Hiermee worden bestanden opgemaakt die zijn gegenereerd door de SDK.

• --no-restore

  Voert geen impliciete herstelbewerking uit vóór opmaak. Standaard is impliciet herstellen.

• --report <REPORT-PATH>

  Produceert een JSON-rapport in de map die is opgegeven door <REPORT_PATH>.

• --severity <LEVEL>

  De minimale ernst van diagnostische gegevens die moet worden opgelost. Toegestane waarden zijn info, warnen error. De standaardwaarde is warn.

• --verify-no-changes

  Controleert of er geen opmaakwijzigingen worden uitgevoerd. Eindigt met een niet-nul afsluitcode als bestanden zouden zijn opgemaakt.

• --version

  Geeft versiegegevens weer.

• -v|--verbosity <LEVEL>

  Hiermee stelt u het uitgebreidheidsniveau van de opdracht in. Toegestane waarden zijnq[uiet], , , m[inimal]en n[ormal]d[etailed]diag[nostic]. Zie LoggerVerbosity voor meer informatie.

• -?|-h|--help

  Hiermee wordt een beschrijving afgedrukt van hoe de opdracht gebruikt moet worden.

Subopdrachten

Whitespace

dotnet format whitespace - Hiermee wordt code opgemaakt zodat deze overeenkomt met editorconfig de instellingen voor witruimte.

Beschrijving

In dotnet format whitespace de subopdracht worden alleen opmaakregels uitgevoerd die zijn gekoppeld aan witruimteopmaak. Zie de C#-opmaakopties voor een volledige lijst met mogelijke opmaakopties die u kunt opgeven in uw .editorconfig-bestand.

Opties

• --folder

  <PROJECT | SOLUTION> Het argument behandelen als een pad naar een eenvoudige map met codebestanden.

Stijl

dotnet format style - Hiermee wordt code opgemaakt zodat deze overeenkomt met de EditorConfig-instellingen voor de codestijl.

Beschrijving

In dotnet format style de subopdracht worden alleen opmaakregels uitgevoerd die zijn gekoppeld aan codestijlopmaak. Zie Codestijlregels voor een volledige lijst met opmaakopties die u in uw editorconfig bestand kunt opgeven.

Opties

• --diagnostics <DIAGNOSTICS>

  Een door spaties gescheiden lijst met diagnostische id's die moeten worden gebruikt als filter bij het oplossen van problemen met de codestijl. De standaardwaarde is de id's die worden vermeld in het .editorconfig-bestand . Voor een lijst met ingebouwde regel-id's voor codestijlanalyse die u kunt opgeven, raadpleegt u de lijst met id's voor regels voor codeanalyse.

• --severity <LEVEL>

  De minimale ernst van diagnostische gegevens die moet worden opgelost. Toegestane waarden zijn info, warnen error. De standaardwaarde is warn.

Analyses

dotnet format analyzers - Hiermee wordt code opgemaakt zodat deze overeenkomt met editorconfig instellingen voor analyses (met uitzondering van regels voor codestijlen).

Beschrijving

De dotnet format analyzers subopdracht voert alleen opmaakregels uit die zijn gekoppeld aan analysen. Zie Kwaliteitsregels voor een lijst met analyseregels die u in uw editorconfig bestand kunt opgeven.

Opties

• --diagnostics <DIAGNOSTICS>

  Een door spaties gescheiden lijst met diagnostische id's die moeten worden gebruikt als filter bij het oplossen van problemen met niet-codestijlen. De standaardwaarde is de id's die worden vermeld in het .editorconfig-bestand . Zie de lijst met id's voor kwaliteitsregels voor een lijst met ingebouwde regel-id's die u kunt opgeven. Raadpleeg hun documentatie voor analyse van derden.

• --severity <LEVEL>

  De minimale ernst van diagnostische gegevens die moet worden opgelost. Toegestane waarden zijn info, warnen error. De standaardwaarde is warn.

Voorbeelden

• Alle code in de oplossing opmaken:

  dotnet format ./solution.sln
  

• Alle code in het toepassingsproject opschonen:

  dotnet format ./src/application.csproj
  

• Controleer of alle code correct is opgemaakt:

  dotnet format --verify-no-changes
  

• Alle code opschonen in de map src en tests , maar niet in src/submodule-a:

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

• Probleem met een specifieke codestijl oplossen:

  dotnet format style --diagnostics IDE0005 --severity info
  

• Los alle codestijlproblemen op met ernst infoof warningerror:

  dotnet format style --severity info
  

• Los een specifiek analyseprobleem (niet-codestijl) op:

  dotnet format analyzers --diagnostics CA1831 --severity warn
  

• Los alle problemen met niet-codestijl op met ernst infoofwarningerror:

  dotnet format analyzers --severity info