code-format について
code-formatは、.NETや一般的なテキスト・Webファイルの整形手順を案内するスキルです。個別ファイルからコードベース全体まで扱い、検証モードと.editorconfigに対応します。
主な機能
- 01dotnet formatでC#を整形
- 02PrettierでJSON、YAML、Markdown、JS、TSを整形
- 03コードベース全体で両方のフォーマッターを実行
- 04ファイルを変更せず整形を検証
- 05.editorconfigとコミット前フックに対応
活用シーン
- 01コミット前にチームの書式ルールを適用
- 02指定ファイルまたはコードベース全体を整形
- 03CIでファイルを変更せず書式を確認
インストール
コマンドをコピーしてターミナルで実行します。
npx skills add https:/ / github.com/ icartsh/ icartsh_plugin --skill code-formatインストール後、Claude Code で/code-formatを入力して読み込まれたか確認します。
同梱ファイル
SKILL.md と一緒にインストールされる参考資料やスクリプト。
references/dotnet-format.mdfix-all.mdprettier-format.mdscripts/format-all.sh詳細
コードフォーマットスキル(エントリーマップ)
目標: エージェントが必要なフォーマット手順を正確に見つけられるように案内します。
クイックスタート(1つ選択してください)
- .NET コードのフォーマット(C#) →
references/dotnet-format.md - JSON/YAML/Markdown のフォーマット →
references/prettier-format.md - すべての項目をフォーマット →
references/fix-all.md
使用する場面
- コードスタイル違反の修正(インデント、空白、改行など)
- .editorconfig のルールを一貫して適用
- コミットに向けたコードの準備(pre-commit hook によるフォーマット)
- チームのコーディング標準の遵守
- 特定のファイルまたはコードベース全体のフォーマット
対象外: ビルド(dotnet-build)、テスト(dotnet-test)、またはリンティング(code-analyze)
入力と出力
入力: target(dotnet/prettier/all)、files(特定のファイルまたはディレクトリ)、verify(チェック専用モード)
出力: フォーマットされたファイル(ファイルを直接変更)、終了コード(0=成功、0以外=違反あり)
ガードレール: 非破壊的な方法(変更せずに確認する --verify-no-changes が可能)、.editorconfig を尊重、pre-commit と統合
ナビゲーション
1. .NET コードをフォーマット → references/dotnet-format.md
- C# ファイル(.cs)をフォーマットし、dotnet format のルールを適用して、コードスタイルの問題を修正
2. Prettier でフォーマット → references/prettier-format.md
- JSON、YAML、Markdown、JavaScript、TypeScript ファイルをフォーマット
3. すべてのコードをフォーマット → references/fix-all.md
- すべてのフォーマッター(dotnet + prettier)を順番に実行し、包括的にフォーマット
よくあるパターン
クイックフォーマット(.NET)
cd ./dotnet
dotnet format PigeonPea.sln
クイックフォーマット(Prettier)
npx prettier --write "**/*.{json,yml,yaml,md}"
すべてをフォーマット
./.agent/skills/code-format/scripts/format-all.sh
検証のみ(チェックモード)
cd ./dotnet
dotnet format PigeonPea.sln --verify-no-changes
特定のファイルをフォーマット
# .NET
dotnet format --include ./console-app/Program.cs
# Prettier
npx prettier --write ./README.md
トラブルシューティング
フォーマットに失敗する: エラーメッセージを確認してください。エラー処理の詳細については、関連する参照ファイルを確認してください。
ファイルがフォーマットされない: .editorconfig のルール、ファイル拡張子、ignore パターンを確認してください。
Pre-commit hook が失敗する: 先にフォーマッターを手動で実行してからコミットしてください。references/fix-all.mdを参照してください。
スタイルが競合する: .editorconfig が優先されます。構成ファイルを確認してください。
パフォーマンスの問題: ソリューション全体ではなく、特定のプロジェクトまたはファイルをフォーマットしてください。
成功の指標
dotnet format
Format complete in X ms.
すでにフォーマット済みの場合は、変更されたファイルがないか、フォーマットされたファイルの一覧が表示されます。
prettier
✔ Formatted X files
または、すべてのファイルがすでにフォーマット済みの場合は、出力はありません。
統合
コミット前: pre-commit hook を使用して自動フォーマット(.pre-commit-config.yamlで構成)
手動フォーマット: コードをプッシュする前、PR を作成する前に実行
CI/CD: CI でフォーマットを検証(--verify-no-changes / --check モードを使用)
他の SKILL と併用:
- 前の段階:code-analyze(先にスタイルを修正)
- 次の段階:dotnet-build(整ったコードをビルド)
構成ファイル
.editorconfig:フォーマットルールを定義(インデントサイズ、行末など).prettierrc.json:Prettier の構成(行の最大幅、引用符など).pre-commit-config.yaml:Pre-commit hook の構成.prettierignore:Prettier によるフォーマットから除外するファイル
関連項目
.editorconfig- フォーマットルール.prettierrc.json- Prettier の設定.pre-commit-config.yaml- Pre-commit hookssetup-pre-commit.sh- Pre-commit 設定スクリプト