mcpField
C
cmd-clean-code

cmd-clean-code

github.com/olshansk開発935 回インストール1 日前に更新
リポジトリ

cmd-clean-code について

cmd-clean-codeは、コードの読みやすさを整えるスキルです。ファイル、関数、コード片を扱う開発者向けで、識別子と既存のロジックを保ち、整形した内容をコードブロックで返します。

主な機能

  1. 01コードを読む際の認知負荷の軽減
  2. 02ビジネスロジックと識別子の保持
  3. 03空白とコード構成の整理
  4. 04段落形式のコメントを箇条書きに変換
  5. 05リンク、マーカー、参照の維持

活用シーン

  1. 01関数やコード片の可読性向上
  2. 02コメントやリスト形式の内容の整形
  3. 03動作を変えずにコードを整理

インストール

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

$npx skills add https://github.com/olshansk/agent-skills --skill cmd-clean-code

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

詳細

クリーンコード

明示的に求められていない限り、機能を変更せずにコードの可読性を高めるため、以下のルールを使用してください。

基本原則

  • 人間やエージェントの認知負荷を最小限に抑えます。
  • 適用できる箇所では、慣用的なベストプラクティスを取り入れます。
  • 指示がない限り、すべてのビジネスロジックを保持します。
  • 可能な場合は箇条書きを使って、コメントと構成を明確にします。

受け付ける入力

  • ソースファイル全体(.proto、.go、.py、.md など)。
  • 部分的なコメント:パッケージヘッダー、メソッドのドキュメント、インラインのメモ。
  • 関数全体または一部。
  • 任意のコードスニペット(または上記の組み合わせ)。

応答要件

  • 整理したコードをトリプルバッククォートで囲んで返します。
  • 識別子(フィールド、パラメーター、クラス、メソッドなど)はすべて保持します。
  • 読みやすくなるよう、適切な箇所に空白を追加します。
  • 可能な場合は、段落形式のコメントを箇条書きに変換します。
  • 指示がない限り、元の内容を削除または変更しないでください。
  • 情報がリスト形式の場合は、箇条書きを優先します。

チーム固有の例外事項

  • TODO_???(???) タグはそのまま残します。
  • IMPORTANT、DEV_NOTE などのコールアウトは保持します。
  • GitHub の Issue/PR への参照(例:「As of #XX ...」)は維持します。
  • すべてのリンクと外部参照を保持します。
  • CRITICAL、NB、DEV_NOTE、NOTE などのマーカーはそのまま残し、その後のテキストのみを整理します。
長いスニペットの扱い
  • 空行の前にコードがまとまっている場合(約5行)、ブロックの先頭に簡潔なコメントを追加します。
  • 既存のコメントの階層は維持し、読みやすさだけを高めます。

細かな調整

  • 項目が1つだけのリストは作らず、通常の文章として記述します。
  • 編集時に既存のリンクを削除しないでください。

コメント