codebase-auditor は何をしますか？
コードベースの複雑性、セキュリティ、アーキテクチャ、依存関係、パフォーマンス監査のためのCodexスキルおよびCLI。
概要
このスキルを使用すると、AIエージェントがコードベースを分析し、以下の監査を実行できます。
- コード複雑性分析
- セキュリティ脆弱性スキャン
- アーキテクチャ評価
- 依存関係の監査
- パフォーマンス分析
インストール
codex install twinedge-ai/codebase-auditor
またはCLIから直接使用:
npx codebase-auditor
使用方法
Codex エージェントとして
エージェントに以下のような指示を与えてください:
このコードベースの完全な監査を実行してください。コード複雑性、セキュリティ問題、アーキテクチャの懸念事項を報告してください。
CLI として
# 現在のディレクトリを監査
codebase-auditor
# 特定のディレクトリを指定
codebase-auditor --path ./src
# 監査タイプを指定
codebase-auditor --checks complexity,security,dependencies
# 出力形式を指定 (json, markdown, html)
codebase-auditor --format json
設定
プロジェクトのルートに codebase-auditor.config.js を作成してカスタマイズできます:
module.exports = {
checks: ['complexity', 'security', 'architecture', 'dependencies', 'performance'],
ignorePatterns: ['**/node_modules/**', '**/dist/**', '**/test/**'],
complexity: {
maxCyclomaticComplexity: 10,
maxFileLines: 500
},
security: {
severityThreshold: 'medium'
},
output: {
format: 'markdown',
path: './audit-report.md'
}
};
監査項目
| 監査タイプ | 説明 |
|---|---|
| 複雑性 | 循環的複雑度、行数、関数の長さ |
| セキュリティ | 脆弱性、ハードコードされたシークレット、危険なパターン |
| アーキテクチャ | レイヤー違反、循環依存、結合度 |
| 依存関係 | 古いパッケージ、ライセンス問題、トランスパイル依存 |
| パフォーマンス | N+1クエリ、メモリリーク、未使用コード |
出力例
# 監査レポート: プロジェクト名
## 複雑性
- 平均循環的複雑度: 4.2 (良好)
- 最も複雑なファイル: `src/parser.js` (複雑度 15)
- しきい値を超えるファイル: 3
## セキュリティ
- 重大: 1 (CVE-2024-1234)
- 高: 3
- 中: 7
...
環境変数
CODEBASE_AUDITOR_TOKEN- プライベートな監査ルールをフェッチするためのAPIトークンCODEBASE_AUDITOR_VERBOSE- 詳細なログ出力を有効にする (true/false)
注意事項
- 大量のコードベースでは監査に時間がかかる場合があります
- セキュリティ監査は初歩的なチェックであり、本格的な専門家監査の代わりにはなりません
- 監査結果は常に人間がレビューすることを推奨します
ライセンス
MIT