mcpField
C
codebase-cleanup-audit

codebase-cleanup-audit

github.com/gil-1開発0272 回インストール10 週間前に更新
リポジトリ

codebase-cleanup-audit について

変更に着手する前に整理候補を特定する、開発者向けのコードベース監査スキルです。範囲を指定したスナップショットを作成し、根拠・リスク・検証手順を報告してから編集を行います。

主な機能

  1. 01リポジトリやディレクトリ単位の監査
  2. 02HTML・JSON・Markdown形式のスナップショット
  3. 03重複・古い項目・未使用項目の検索
  4. 04整理候補とリスクの分類
  5. 05編集前の根拠と検証手順の報告

活用シーン

  1. 01アプリやパッケージ内の不要ファイル確認
  2. 02古い文書・重複設定・一時ファイルの検索
  3. 03未使用のエクスポートや依存関係の確認
  4. 04安全な整理作業の順序立て

インストール

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

$npx skills add https://github.com/gil-1/skills --skill codebase-cleanup-audit

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

同梱ファイル

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

agents/
openai.yaml
scripts/
cleanup-snapshot.mjs
scripts/cleanup-snapshot/
cli.mjs
config.mjs
duplicates.mjs
function-scanner.mjs
inventory.mjs
renderers.mjs
shared.mjs
snapshot.mjs

詳細

コードベースの整理監査

削除、統合、名前変更、アーカイブ、または管理しやすくできるものを探します。まず監査を行い、実装を求められた場合にのみ編集します。

クイックスタート

ローカルのルールを確認してから、同梱のスナップショットを実行します。

node scripts/cleanup-snapshot.mjs --root /path/to/project

対象を絞った整理では、リポジトリ全体ではなく、必要最小限のディレクトリをスキャンします。

node scripts/cleanup-snapshot.mjs --root /path/to/project/apps/admin
node scripts/cleanup-snapshot.mjs --root /path/to/project/packages/auth
node scripts/cleanup-snapshot.mjs --root /path/to/project/docs

デフォルトのレポート出力先は、スキャン対象のルート配下の .scratch/<datetime>-cleanup-snapshot.html です。.scratch 内に書き出される HTML レポートには、タイムスタンプがプレフィックスとして付きます。機械処理専用のスナップショットを標準出力に出す場合は、--format json|markdown --out - を使用します。

整理の対象に、浅いモジュール、ノイズの多いインターフェース、適切でない位置にある境界、削除テストの判断、またはテスト容易性／局所性の問題が含まれる場合は、codebase-design を使用します。整理の指摘を安全な整理作業ではなく、視覚的なアーキテクチャ候補として扱うべき場合は、improve-codebase-architecture にエスカレーションします。

ワークフロー

  1. 対象範囲を定めます。リポジトリ全体、パッケージ、アプリ領域、ドキュメント、テスト、スクリプト、アセット、生成物、またはワークスペース内の不要なファイルなどが対象です。依頼で領域が指定されている場合は、--root で対象を絞ります。
  2. ローカルの正規情報を確認します。AGENTS.md、CLAUDE.md、README.md、CONTEXT.md、ADR、マニフェスト、スクリプト、CI、パッケージのエクスポート、ルート一覧、デプロイ設定、ドキュメントなどが対象です。
  3. cleanup-snapshot.mjs、rg --files、パッケージのマニフェスト、テスト設定、ルート一覧、およびプロジェクトで利用できる依存関係ツールを使って、リポジトリの構成を把握します。
  4. 整理の兆候を検索します。legacy、old、deprecated、unused、dead、backup、copy、tmp、wip、内容にバリエーションがある重複ファイル名、本文が重複する関数、本文に違いがある同名関数、汎用的な格納場所、空のフォルダー、古いドキュメント、無効化されたテスト、スキップされたスクリプト、TODO／FIXME／HACK の集中、ソース内の生成ファイル、およびツールが対応している場合は未使用のエクスポートや依存関係を探します。
  5. 各指摘を分類します。
    • delete：安全に削除できる不要な成果物、生成物、重複コピー、古い一時ファイル
    • merge：重複するドキュメント、繰り返し使われる設定、浅いモジュールに分割された同じ概念
    • rename/reword：曖昧な名前、誤解を招くスキルの説明、古い用語
    • archive：履歴としては有用だが、アクティブなソースには不要なもの
    • defer：プロダクト上の判断、外部との契約、移行計画、または追加の根拠が必要なもの
  6. codebase-design の削除テストを適用します。モジュールを削除すると複雑さが減る場合は、整理候補です。複雑さが呼び出し元に広がる場合は、より深いモジュールを提案します。アーキテクチャの検討が必要な指摘は、improve-codebase-architecture に回します。
  7. 編集前に報告します。リスク、根拠、安全な作業順、検証コマンド、および移動してはならないものを含めます。

出力

## Cleanup Audit
- Scope:
- Local rules:
- Snapshot:
- Safe deletes:
- Merge/dedupe:
- Rename/reword:
- Architecture candidates:
- Keep because:
- Risks/blockers:
- Suggested first batch:
- Verification:

直接的な表現を使います。一般論よりも、具体的なファイルパスと正確な検索結果を優先します。

コメント

Markdown 対応