dotnet format

  • [アーティクル]

この記事の対象: ✔️ .NET 6.x SDK 以降のバージョン

Name

dotnet format -editorconfig 設定に一致するようにコードを書式設定します。

構文

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

dotnet format -h|--help

[説明]

dotnet format は、プロジェクトまたはソリューションにスタイル設定を適用するコード フォーマッタです。 設定は、editorconfig ファイルから読み取られます (存在する場合)。それ以外の場合は、既定の設定セットが使用されます。 詳細については、EditorConfig のドキュメントを参照してください。

引数

PROJECT | SOLUTION

コードの書式設定を実行する MSBuild プロジェクトまたはソリューション。 プロジェクトまたはソリューションのファイルを指定しない場合、MSBuild は、現在の作業ディレクトリから proj または sln のどちらかで終わるファイル拡張子を持つファイルを検索して、そのファイルを使います。

オプション

以下のオプションは、dotnet format コマンドを正常に実行するためには必要ありませんが、書式設定の内容および適用する規則をさらにカスタマイズするために使用できます。

  • --diagnostics <DIAGNOSTICS>

    コード スタイルまたはサードパーティの問題を修正するときにフィルターとして使用する診断 ID のスペース区切りのリスト。 既定値は、 .editorconfig ファイル内に列挙されている ID のいずれかです。 指定できる組み込みアナライザーの規則 ID の一覧については、コード分析のスタイル規則の ID の一覧を参照してください。

  • --severity

    修正する診断の最小重要度。 使用できる値は、info、warn、および error です。 既定値は warn です。

  • --no-restore

    書式設定の前に暗黙的な復元は実行されません。 既定では、暗黙的な復元が行われます。

  • --verify-no-changes

    書式設定の変更が実行されないことを確認します。 いずれかのファイルが書式設定されている場合は、ゼロ以外の終了コードで終了します。

  • --include <INCLUDE>

    書式設定に含めるファイルまたはフォルダーの相対パスのスペース区切りの一覧。 既定値は、ソリューションまたはプロジェクト内のすべてのファイルです。

  • --exclude <EXCLUDE>

    書式設定から除外するファイルまたはフォルダーの相対パスのスペース区切りの一覧。 既定値は none です。

  • --include-generated

    SDK によって生成されたファイルを書式設定します。

  • -v|--verbosity <LEVEL>

    詳細レベルを設定します。 指定できる値は、q[uiet]、m[inimal]、n[ormal]、d[etailed]、および diag[nostic] です。 既定値は m[inimal]にする必要があります。

  • --binarylog <BINARY-LOG-PATH>

    すべてのプロジェクトまたはソリューションの読み込み情報をバイナリ ログ ファイルに記録します。

  • --report <REPORT-PATH>

    <REPORT_PATH> によって指定されたディレクトリに JSON レポートを生成します。

  • -h|--help

    ヘルプと使用状況の情報を表示します

サブコマンド

空白

dotnet format whitespace - 空白の editorconfig 設定に一致するようにコードを書式設定します。

[説明]

dotnet format whitespace サブコマンドでは、空白の書式設定に関連付けられている書式設定規則のみを実行します。 .editorconfig ファイルで指定できる書式設定オプションの完全な一覧については、「C# 書式設定オプション」をご覧ください。

オプション

  • --folder

    <PROJECT | SOLUTION> 引数を、コード ファイルのシンプルなフォルダーへのパスとして扱います。

Style

dotnet format style - コード スタイルの EditorConfig 設定に一致するようにコードを書式設定します。

[説明]

dotnet format style サブコマンドでは、コード スタイルの書式設定に関連付けられている書式設定規則のみを実行します。 editorconfig ファイルで指定できる書式設定オプションの完全な一覧については、コード スタイルに関する規則を参照してください。

オプション

  • --diagnostics <DIAGNOSTICS>

    コード スタイルまたはサードパーティの問題を修正するときにフィルターとして使用する診断 ID のスペース区切りのリスト。 既定値は、 .editorconfig ファイル内に列挙されている ID のいずれかです。 指定できる組み込みアナライザーの規則 ID の一覧については、コード分析のスタイル規則の ID の一覧を参照してください。

  • --severity

    修正する診断の最小重要度。 使用できる値は、info、warn、および error です。 既定値は warn

アナライザー

dotnet format analyzers - アナライザーの editorconfig 設定に一致するようにコードを書式設定します。

[説明]

dotnet format analyzers サブコマンドでは、アナライザーに関連付けられている書式設定規則のみを実行します。 editorconfig ファイルで指定できるアナライザー規則の一覧については、コード スタイルに関する規則を参照してください。

オプション

  • --diagnostics <DIAGNOSTICS>

    コード スタイルまたはサードパーティの問題を修正するときにフィルターとして使用する診断 ID のスペース区切りのリスト。 既定値は、 .editorconfig ファイル内に列挙されている ID のいずれかです。 指定できる組み込みアナライザーの規則 ID の一覧については、コード分析のスタイル規則の ID の一覧を参照してください。

  • --severity

    修正する診断の最小重要度。 使用できる値は、info、warn、および error です。 既定値は warn です。

例

  • ソリューションのすべてのコードを書式設定します。

    dotnet format ./solution.sln

  • アプリケーション プロジェクトのすべてのコードをクリーンアップします。

    dotnet format ./src/application.csproj

  • すべてのコードが正しく書式設定されていることを確認します。

    dotnet format --verify-no-changes

  • src と tests ディレクトリのすべてのコードのクリーンアップを行いますが、src/submodule-a では行いません。

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