DAA コードレビュースキル
Pythonコード、Markdownドキュメント、Mermaid図を解析し、品質問題を検出します。外部リンター(ruff)とClaudeの分析を組み合わせ、修正提案を含む包括的なコードレビューを提供します。 ruffや他のリンターを単に実行するだけではなく、コードが優れたソフトウェア工学的実践(SOLID、DRY、YAGNI、シンプルさを複雑さよりも重視)に準拠しているか、セキュリティ脆弱性がないか、変数名が適切かをチェックします(例)。 次のようなコードは避けてください:
pkb = p_key.private_bytes(
encoding=serialization.Encoding.DER,
format=serialization.PrivateFormat.PKCS8,
encryption_algorithm=serialization.NoEncryption(),
)
代わりに次のようにします:
private_key_bytes = p_key.private_bytes(
encoding=serialization.Encoding.DER,
format=serialization.PrivateFormat.PKCS8,
encryption_algorithm=serialization.NoEncryption(),
)
クイックスタート
Pythonコードを分析する
from python_analyzer import analyze_python, analyze_python_file
from report_generator import generate_console_report, generate_markdown_report
from models import ReviewReport
# コードスニペットを分析
result = analyze_python(code_string)
# ファイルを分析
result = analyze_python_file(Path("src/module.py"))
# レポートを生成
report = ReviewReport(results=[result], title="Code Review")
generate_console_report(report) # コンソール出力
markdown = generate_markdown_report(report) # Markdown文字列
Markdownを分析する
from markdown_analyzer import analyze_markdown, analyze_markdown_file
result = analyze_markdown(content)
# または
result = analyze_markdown_file(Path("README.md"))
Mermaid図を分析する
Mermaidの検証には、Claudeの理解と最新の構文に関するWeb検索を組み合わせて使用します。詳細は mermaid-checks.md を参照してください。
ワークフロー
- コードを受け取る - ファイルパスまたはペーストされたスニペットから
- ファイルタイプを検出する - Python (.py)、Markdown (.md)、または Mermaid (.mmd、コードブロック)
- 分析を実行する - 外部リンターを最初に実行し、次にClaudeの分析
- レポートを生成する - コンソールとMarkdownの両方の形式
- レポートを保存する - Markdownレポートを
docs/code_reviews/{YYYY-MM-DD}_{file_name}.mdに書き込む(必要に応じてディレクトリを作成) - 修正を確認する - 修正案をユーザーに提示
- 修正を適用する - ユーザーの承認を得て(柔軟な承認モード)
- READMEを確認する - プッシュ前に、README.mdが現在の変更を反映していることを確認する(新機能、変更されたAPI、更新された依存関係、変更された設定)
分析機能
Python(ruff + Claude経由)
| カテゴリ | 例 | 重大度 |
|---|---|---|
| PEP8 | 行の長さ、インデント、空白 | WARNING/INFO |
| 未使用コード | 未使用のインポート、変数、引数 | WARNING |
| 型ヒント | 関数のアノテーション欠落 | INFO |
| ドキュメント文字列 | 欠落または不適切なnumpy形式のドキュメント文字列 | INFO |
| 複雑性 | サイクロマティック複雑性が高い関数 | INFO |
| 実行時エラー | 未定義の名前、構文エラー | ERROR |
| インポート | 未ソートのインポート、禁止されたインポート | INFO |
Markdown
| チェック | 説明 | 重大度 |
|---|---|---|
| 見出し構造 | 適切なh1→h2→h3の並び | WARNING |
| リンク切れ | 存在しないファイルリンク | ERROR |
| 代替テキスト欠落 | アクセシビリティテキストのない画像 | WARNING |
| フォーマット | 末尾の空白、空行 | INFO |
| コードブロック | 言語識別子の欠落 | INFO |
| エンコーディング破損 | UTF-8文字が×、âœ"などとして表示される | ERROR |
Mermaid
検証前に、最新のMermaid.jsドキュメントをWeb検索します。以下をチェック:
- 図のタイプ宣言
- ノード/エッジの構文
- 構造の正しさ
- 関係定義
出力形式
コンソール(対話型)
重大度インジケータ付きの色付き出力:
- ✗ ERROR(赤) - 修正必須
- ⚠ WARNING(黄) - 修正推奨
- ℹ INFO(青) - 修正を検討
Markdownレポート
docs/code_reviews/{YYYY-MM-DD}_{file_name}.md に保存されます。複数ファイルのレビューの場合は、説明的な名前を使用します(例:2026-03-02_full_repo_review.md)。
構造化レポートの内容:
- サマリー統計
- ステータスバッジ(合格/不合格)
- ファイルごとの問題テーブル
- 展開可能な問題詳細
- カテゴリ別内訳
修正適用
修正は次の方法で承認できます:
- すべて一度に - 自動修正可能なすべての問題を適用
- カテゴリ別 - PEP8修正はすべて適用、ドキュメント文字列はスキップ
- 重大度別 - エラーを最初に修正、次に警告
- ファイル別 - 特定のファイルのみ修正
- 個別に - 各修正を確認
詳細なワークフローについては fix-workflow.md を参照してください。
リファレンスドキュメント
- python-checks.md - Pythonルールの詳細
- markdown-checks.md - Markdownルールの詳細
- mermaid-checks.md - Mermaid検証ガイド
- fix-workflow.md - 修正承認ワークフロー
使用例
完全なリポジトリレビュー
ユーザー: "プロジェクトのコード品質をレビューして"
1. PythonファイルとMarkdownファイルを一覧表示
2. 各ファイルを分析
3. ReviewReportに集約
4. コンソールサマリーを表示
5. レポートを docs/code_reviews/{YYYY-MM-DD}_full_repo_review.md に保存
6. 修正の適用を提案
クイックコードチェック
ユーザー: [コードスニペットをペースト]
"これに問題はある?"
1. スニペットを直接分析
2. 問題をインラインで報告
3. 具体的な修正を提案
コミット前レビュー
ユーザー: "コミットする前にこれらのファイルをチェックして"
1. 指定されたファイルを分析
2. エラーと警告に焦点を当てる
3. エラーがあればブロック
4. 承認されればクイック修正を適用
5. 変更に基づいてREADMEの更新が必要か確認
6. 新機能、API、依存関係が変更された場合はREADMEを更新
スクリプト
| スクリプト | 目的 |
|---|---|
models.py | データ構造(Issue、Severity、AnalysisResult) |
python_analyzer.py | ruffを使ったPython分析 |
markdown_analyzer.py | Markdown品質チェック |
report_generator.py | コンソールおよびMarkdownレポート生成 |
要件
- Python 3.10以上
- ruff(pipでインストール)
- Mermaidドキュメント検索用のWebアクセス