tomevault-io コードレビュー基準
プロジェクトのコーディング規約に基づいてコードレビューを実施するためのスキル。 PATTERNS.md および MASTER.md で定義された基準を適用する。
1. 命名規則
| 要素 | パターン | 例 |
|---|---|---|
| クラス | PascalCase | UserService |
| インターフェース | PascalCase + I prefix | IUserRepository |
| メソッド | camelCase | getUserById() |
| 変数 | camelCase | userName |
| 定数 | UPPER_SNAKE_CASE | MAX_RETRY_COUNT |
| ファイル | kebab-case | user-service.ts |
2. ファイル構造の標準パターン
すべてのファイルは以下の順序で構成すること：
// 1. imports
import { Injectable } from '@nestjs/common';
// 2. constants
const MAX_RETRY_COUNT = 3;
// 3. types/interfaces
interface UserData {
id: string;
name: string;
}
// 4. main class/function
@Injectable()
export class UserService {
// implementation
}
// 5. exports
export { UserService, UserData };
3. マジックナンバー禁止（必須）
すべての意味のある数値・文字列は名前付き定数に抽出すること。これはプロジェクトの必須ルール。
// ❌ 禁止: マジックナンバー
if (retryCount > 3) {
throw new Error('Max retries exceeded');
}
setTimeout(callback, 30000);
// ✅ 正しい: 名前付き定数
const MAX_RETRY_COUNT = 3;
if (retryCount > MAX_RETRY_COUNT) {
throw new Error('Max retries exceeded');
}
const API_CONFIG = {
TIMEOUT_MS: 30000,
MAX_RETRIES: 3,
RATE_LIMIT: 100,
} as const;
setTimeout(callback, API_CONFIG.TIMEOUT_MS);
定数は用途別にグループ化し、as const で型安全性を確保する。
4. ファイルサイズ制限
| 基準 | 行数 | アクション |
|---|---|---|
| ソフトリミット | 500行 | 分割を検討 |
| ハードリミット | 800行 | 分割を実施（生成コード・スキーマは例外） |
800行を超えるファイルは、責務の分離を基準に複数ファイルに分割する。
5. セキュリティパターン
レビュー時に以下を確認すること：
- 入力サニタイゼーション: ユーザー入力は必ずサニタイズ（HTML エスケープ、特殊文字除去）
- パラメタライズドクエリ: SQL は文字列結合ではなくプレースホルダーを使用
- 認証ミドルウェア: JWT トークンの検証は専用ミドルウェアで実施
- 認可チェック: ロールベースのアクセス制御をデコレーターまたはガードで実装
// ✅ パラメタライズドクエリ
const data = await db.query('SELECT * FROM users WHERE id = ?', [id]);
// ❌ 文字列結合（SQLインジェクション脆弱性）
const data = await db.query(`SELECT * FROM users WHERE id = '${id}'`);
6. デザインパターン
プロジェクトで推奨されるデザインパターン：
| パターン | 用途 |
|---|---|
| Repository | データアクセスの抽象化（インターフェース経由） |
| Factory | 型に基づくオブジェクト生成の一元化 |
| Singleton | 設定マネージャー等の単一インスタンス管理 |
| Decorator | キャッシング、認証、ロール検証の横断的関心事 |
7. 禁止事項チェックリスト
コードレビュー時に以下が含まれていないか確認する：
-
any型の使用（型安全性の喪失） -
console.logの本番コードへの残存（構造化ログを使用） - マジックナンバー・ハードコード値
- 未使用の import 文
- サイレントなエラー握りつぶし（空の catch ブロック）
- 文字列結合による SQL クエリ構築
- 非 null アサーション（
!）の無条件使用 - テストのない新規ビジネスロジック
Converted and distributed by TomeVault — claim your Tome and manage your conversions.