format dotnet

Cet article s’applique à : ✔️ SDK .NET Core 6 et versions ultérieures

Nom

dotnet format - Met en forme le code pour qu’il corresponde aux paramètres de editorconfig.

Synopsis

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

Description

dotnet format est un formateur de code qui applique les préférences de style et les recommandations d’analyse statique à un projet ou une solution. Les préférences seront lues à partir d’un fichier .editorconfig, le cas échéant, sinon un ensemble de préférences par défaut sera utilisé. Pour plus d’informations, consultez la documentation EditorConfig.

Arguments

PROJECT | SOLUTION

Projet ou solution MSBuild sur lequel exécuter la mise en forme du code. Si vous ne spécifiez pas de fichier projet ou solution, MSBuild recherche dans le répertoire de travail actif un fichier dont l’extension se termine par proj ou sln et l’utilise.

Caution

Le format dotnet peut restaurer, compiler et exécuter des analyseurs à partir du projet ou de la solution spécifié. Appelez uniquement l’outil par rapport au code approuvé.

Options

Aucune des options ci-dessous n’est requise pour que la commande dotnet format réussisse, mais vous pouvez les utiliser pour personnaliser davantage ce qui est mis en forme et selon quelles règles.

• --binarylog <BINARY-LOG-PATH>

  Consigne toutes les informations de chargement de projet ou de solution dans un fichier journal binaire.

• --diagnostics <DIAGNOSTICS>

  Liste d’ID de diagnostic séparés par des espaces à utiliser comme un filtre lors de la résolution des problèmes liés à des tiers ou au style de code. La valeur par défaut correspond à celle des ID répertoriés dans le fichier .editorconfig. Pour obtenir la liste des ID de règle d’analyseur intégré que vous pouvez spécifier, consultez la liste des ID pour les règles de style d’analyse de code.

• --exclude <EXCLUDE>

  Liste séparée par des espaces qui indique le chemin d’accès relatif aux fichiers ou dossiers à exclure de la mise en forme. La valeur par défaut est aucune gestion.

• --exclude-diagnostics <EXCLUDE-DIAGNOSTICS>

  Liste séparée par un espace des ID de diagnostic à exclure lors de la résolution du style de code ou des problèmes tiers. La valeur par défaut n’est aucune. Pour obtenir la liste des ID de règle d’analyseur intégré que vous pouvez spécifier, consultez la liste des ID pour les règles de style d’analyse de code.

• --include <INCLUDE>

  Liste séparée par des espaces qui indique le chemin d’accès relatif aux fichiers ou dossiers à inclure dans la mise en forme. La valeur par défaut correspond à tous les fichiers de la solution ou du projet.

• --include-generated

  Met en forme les fichiers générés par le Kit de développement logiciel (SDK).

• --no-restore

  N’exécute pas de restauration implicite avant la mise en forme. La valeur par défaut consiste à effectuer une restauration implicite.

• --report <REPORT-PATH>

  Génère un rapport JSON dans le répertoire spécifié par <REPORT_PATH>.

• --severity <LEVEL>

  Gravité minimale des diagnostics à corriger. Les valeurs autorisées sont info, warn et error. La valeur par défaut est warn.

• --verify-no-changes

  Vérifie qu’aucune modification de mise en forme n’est effectuée. Se termine par un code de sortie différent de zéro si des fichiers ont été mis en forme.

• --version

  Affiche les informations de version.

• -v|--verbosity <LEVEL>

  Définit le niveau de détail de la commande. Les valeurs autorisées sont q[uiet], m[inimal], n[ormal], d[etailed] et diag[nostic]. Pour plus d’informations, consultez LoggerVerbosity.

• -?|-h|--help

  Imprime une description de l’utilisation de la commande.

Sous-commandes

Espace blanc

dotnet format whitespace - Met en forme le code pour qu’il corresponde aux paramètres de editorconfig pour l’espace blanc.

Description

La dotnet format whitespace sous-commande exécute uniquement les règles de mise en forme associées à la mise en forme d’espace blanc. Pour obtenir la liste complète des options de mise en forme possibles que vous pouvez spécifier dans votre fichier .editorconfig, consultez les options de mise en forme C#.

Options

• --folder

  Traitez l’argument <PROJECT | SOLUTION> comme un chemin d’accès à un dossier simple de fichiers de code.

Style

dotnet format style - Met en forme le code pour qu’il corresponde aux paramètres EditorConfig pour le style de code.

Description

La dotnet format style sous-commande exécute uniquement les règles de mise en forme associées à la mise en forme du style de code. Pour obtenir la liste complète des options de mise en forme que vous pouvez spécifier dans votre fichier editorconfig, consultez Règles de style de code.

Options

• --diagnostics <DIAGNOSTICS>

  Liste séparée par un espace des ID de diagnostic à utiliser comme filtre lors de la résolution des problèmes de style de code. La valeur par défaut correspond à celle des ID répertoriés dans le fichier .editorconfig. Pour obtenir la liste des ID de règle d’analyseur de style de code intégrés que vous pouvez spécifier, consultez la liste des ID pour les règles de style d’analyse du code.

• --severity <LEVEL>

  Gravité minimale des diagnostics à corriger. Les valeurs autorisées sont info, warn et error. La valeur par défaut est warn.

Analyseurs

dotnet format analyzers - Met en forme le code pour qu’il corresponde editorconfig aux paramètres des analyseurs (à l’exclusion des règles de style de code).

Description

La dotnet format analyzers sous-commande exécute uniquement les règles de mise en forme associées aux analyseurs. Pour obtenir la liste des règles d’analyseur que vous pouvez spécifier dans votre editorconfig fichier, consultez Règles de qualité.

Options

• --diagnostics <DIAGNOSTICS>

  Liste séparée par un espace des ID de diagnostic à utiliser comme filtre lors de la résolution des problèmes de style non de code. La valeur par défaut correspond à celle des ID répertoriés dans le fichier .editorconfig. Pour obtenir la liste des ID de règle d’analyseur intégrés que vous pouvez spécifier, consultez la liste des ID pour les règles de qualité. Pour les analyseurs tiers, reportez-vous à leur documentation.

• --severity <LEVEL>

  Gravité minimale des diagnostics à corriger. Les valeurs autorisées sont info, warn et error. La valeur par défaut est warn.

Exemples

• Mettez en forme tout le code dans la solution :

  dotnet format ./solution.sln
  

• Nettoyez tout le code dans le projet d’application :

  dotnet format ./src/application.csproj
  

• Vérifiez que tout le code est correctement mis en forme :

  dotnet format --verify-no-changes
  

• Nettoyez tout le code dans le répertoire src et tests , mais pas dans src/submodule-a :

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

• Résolution d’un problème spécifique de style de code :

  dotnet format style --diagnostics IDE0005 --severity info
  

• Corrigez tous les problèmes de style de code qui ont une infogravité, warning ou error:

  dotnet format style --severity info
  

• Résolution d’un problème d’analyseur spécifique (non de style de code) :

  dotnet format analyzers --diagnostics CA1831 --severity warn
  

• Corrigez tous les problèmes de style non de code qui ont une infogravité, warning ou error:

  dotnet format analyzers --severity info