mcpField
F
format

format

github.com/managedcode開発49843 回インストール今日更新
リポジトリ

format について

リポジトリ既存の設定に沿って、.NET SDK の dotnet format を安全に使うスキルです。コーディングエージェントが対象を絞り、既存変更を保ちながら修正を検証できるよう支援します。

主な機能

  1. 01リポジトリとフォーマッター設定の確認
  2. 02空白・スタイル・アナライザー範囲の選択
  3. 03対象ファイルやルールの限定
  4. 04既存差分の保持と生成ファイルの除外
  5. 05フォーマット検証と変更内容の確認

活用シーン

  1. 01変更を加えずにフォーマットを確認
  2. 02範囲を絞ったフォーマット修正
  3. 03フォーマッターによる変更の安全なレビュー

インストール

コマンドをコピーしてターミナルで実行します。

$npx skills add https://github.com/managedcode/dotnet-skills --skill format

インストール後、Claude Code で/formatを入力して読み込まれたか確認します。

同梱ファイル

SKILL.md と一緒にインストールされる参考資料やスクリプト。

manifest.json
references/
commands.md
config.md

詳細

dotnet format

選択した .NET SDK に付属するフォーマッターを使用してください。新たな設定を追加するのではなく、リポジトリでのフォーマッターの担当範囲、既存の変更、および設定済みのスタイルを維持してください。

診断出力の上限

警告/エラーと簡潔な結果のみを表示し、通常の冗長な出力や診断用コンソール出力は避けてください。テストの実行時は、標準の進行状況表示や ANSI 出力を維持してください。失敗時は、関連する診断とスタックフレームのみを表示し、重複を除去したうえで、1 回の応答につき 80 行/8 KiB を上限としてください。未解決の問題について追加の診断が必要な場合に限り、サイズを制限した成果物にモデルコンテキスト外で収集してください。その成果物へのリンクを示し、範囲を正確に区切って内容を確認してください。ログやレポート全体を出力したり、フィルタリングによってコマンドの終了コードを隠したりしないでください。

ワークフロー

  1. 最も近い AGENTS.md、global.json、ソリューション/プロジェクトファイル、.editorconfig、現在の Git ステータスを確認してください。
  2. 読み込む対象の信頼済みワークスペースを正確に確認してください。dotnet format は、そのワークスペースから復元、コンパイル、アナライザーの実行を行う場合があります。
  3. 依頼が読み取り専用の検証なのか、修正の適用を許可するものなのかを判断してください。レビュー、説明、診断の依頼では、変更を加えるコマンドを実行しないでください。
  4. フォーマットを実行する前に、現在の差分を維持してください。対象範囲が不明な場合は、まず --verify-no-changes または対象を絞った --include リストを使用してください。
  5. 依頼に合う、最小範囲のフォーマッターを選択してください。
    • whitespace:インデント、空白、改行コードの規則
    • style:組み込みの .NET コードスタイル診断
    • analyzers:修正可能な、スタイル以外のアナライザー診断
    • 適用可能なすべての範囲を対象にする場合のみ、サブコマンドを指定せずに実行
  6. --include と --exclude の値は、シェルのグロブではなく、ワークスペースを基準としたファイルまたはディレクトリのパスとして扱ってください。スタイルまたはアナライザーの修正対象をルール ID で絞るには、--diagnostics を使用してください。
  7. 変更を加える実行の後に、git diff --stat、代表的な差分、改行コード、および変更されたすべてのファイルを確認してください。対象範囲が予想外に広い場合は停止してコマンドの範囲を絞り、既存のユーザー変更は決して破棄しないでください。
  8. 対応するコマンドを --verify-no-changes 付きで再実行してください。アナライザーによる修正を適用した場合は、変更された動作に関連するビルドとテストも実行してください。

不変条件

  • .editorconfig と既存の MSBuild アナライザー設定を正としてください。ユーザーが求めない限り、任意のスタイルテンプレートを追加しないでください。
  • 依存関係の復元に成功している場合に限り、--no-restore を使用してください。
  • 生成ファイルは、リポジトリが明示的に管理しフォーマットしている場合を除き、対象から除外してください。
  • フォーマッタープロセスが成功しても、すべての診断に自動修正が適用されたことにはなりません。出力または JSON レポートを確認し、最終的な根拠としてビルド/アナライザーの結果を使用してください。
  • CSharpier、ReSharper のクリーンアップ、コード生成ツール、またはその他のフォーマッターが併用されている場合は、各フォーマッターの担当範囲を明確にしてください。

参考資料

  • ローカル、CI、フィルタリング、トラブルシューティング用の正確なコマンドについては、references/commands.md を参照してください。
  • .editorconfig、アナライザーの重大度、またはフォーマッターの担当範囲を変更する場合は、references/config.md を参照してください。

コメント