コーディング標準とベストプラクティス

すべてのプロジェクトに適用される汎用的なコーディング標準です。

コード品質の原則

1. 可読性を第一に

• コードは書かれるよりも読まれる機会が多い
• 明確な変数名と関数名
• コメントよりも自己ドキュメント化されたコードを推奨
• 一貫性のあるフォーマット

2. KISS（Keep It Simple, Stupid）

• 機能する最もシンプルなソリューション
• 過度な設計を避ける
• 早すぎる最適化をしない
• 理解しやすい > 巧妙なコード

3. DRY（Don't Repeat Yourself）

• 共通のロジックを関数に抽出する
• 再利用可能なコンポーネントを作成する
• モジュール間でユーティリティを共有する
• コピー&ペーストプログラミングを避ける

4. YAGNI（You Aren't Gonna Need It）

• 必要になるまで機能を構築しない
• 推測による一般化を避ける
• 必要な時だけ複雑さを追加する
• シンプルに始めて、必要に応じてリファクタリングする

TypeScript/JavaScript標準

変数の命名

// ✅ GOOD: 説明的な名前
const marketSearchQuery = 'election'
const isUserAuthenticated = true
const totalRevenue = 1000

// ❌ BAD: 不明確な名前
const q = 'election'
const flag = true
const x = 1000

関数の命名

// ✅ GOOD: 動詞-名詞パターン
async function fetchMarketData(marketId: string) { }
function calculateSimilarity(a: number[], b: number[]) { }
function isValidEmail(email: string): boolean { }

// ❌ BAD: 不明確または名詞のみ
async function market(id: string) { }
function similarity(a, b) { }
function email(e) { }

不変性パターン（重要）

// ✅ 常にスプレッド演算子を使用する
const updatedUser = {
  ...user,
  name: 'New Name'
}

const updatedArray = [...items, newItem]

// ❌ 直接変更しない
user.name = 'New Name'  // BAD
items.push(newItem)     // BAD

エラーハンドリング

// ✅ GOOD: 包括的なエラーハンドリング
async function fetchData(url: string) {
  try {
    const response = await fetch(url)

    if (!response.ok) {
      throw new Error(`HTTP ${response.status}: ${response.statusText}`)
    }

    return await response.json()
  } catch (error) {
    console.error('Fetch failed:', error)
    throw new Error('Failed to fetch data')
  }
}

// ❌ BAD: エラーハンドリングなし
async function fetchData(url) {
  const response = await fetch(url)
  return response.json()
}

Async/Awaitのベストプラクティス

// ✅ GOOD: 可能な場合は並列実行
const [users, markets, stats] = await Promise.all([
  fetchUsers(),
  fetchMarkets(),
  fetchStats()
])

// ❌ BAD: 不要な順序実行
const users = await fetchUsers()
const markets = await fetchMarkets()
const stats = await fetchStats()

型安全性

// ✅ GOOD: 適切な型
interface Market {
  id: string
  name: string
  status: 'active' | 'resolved' | 'closed'
  created_at: Date
}

function getMarket(id: string): Promise<Market> {
  // Implementation
}

// ❌ BAD: 'any'を使用
function getMarket(id: any): Promise<any> {
  // Implementation
}

Reactのベストプラクティス

コンポーネント構造

// ✅ GOOD: 型付き関数コンポーネント
interface ButtonProps {
  children: React.ReactNode
  onClick: () => void
  disabled?: boolean
  variant?: 'primary' | 'secondary'
}

export function Button({
  children,
  onClick,
  disabled = false,
  variant = 'primary'
}: ButtonProps) {
  return (
    <button
      onClick={onClick}
      disabled={disabled}
      className={`btn btn-${variant}`}
    >
      {children}
    </button>
  )
}

// ❌ BAD: 型なし、構造が不明確
export function Button(props) {
  return <button onClick={props.onClick}>{props.children}</button>
}

カスタムフック

// ✅ GOOD: 再利用可能なカスタムフック
export function useDebounce<T>(value: T, delay: number): T {
  const [debouncedValue, setDebouncedValue] = useState<T>(value)

  useEffect(() => {
    const handler = setTimeout(() => {
      setDebouncedValue(value)
    }, delay)

    return () => clearTimeout(handler)
  }, [value, delay])

  return debouncedValue
}

// 使用方法
const debouncedQuery = useDebounce(searchQuery, 500)

状態管理

// ✅ GOOD: 適切な状態更新
const [count, setCount] = useState(0)

// 前の状態に基づく関数的な状態更新
setCount(prev => prev + 1)

// ❌ BAD: 直接の状態参照
setCount(count + 1)  // 非同期シナリオで古い値になる可能性がある

条件付きレンダリング

// ✅ GOOD: 明確な条件付きレンダリング
{isLoading && <Spinner />}
{error && <ErrorMessage error={error} />}
{data && <DataDisplay data={data} />}

// ❌ BAD: 三項演算子地獄
{isLoading ? <Spinner /> : error ? <ErrorMessage error={error} /> : data ? <DataDisplay data={data} /> : null}

APIデザイン標準

REST API規約

GET    /api/markets              # すべてのマーケットをリスト
GET    /api/markets/:id          # 特定のマーケットを取得
POST   /api/markets              # 新しいマーケットを作成
PUT    /api/markets/:id          # マーケットを更新（全体）
PATCH  /api/markets/:id          # マーケットを更新（部分）
DELETE /api/markets/:id          # マーケットを削除

# フィルタリング用クエリパラメータ
GET /api/markets?status=active&limit=10&offset=0

レスポンスフォーマット

// ✅ GOOD: 一貫性のあるレスポンス構造
interface ApiResponse<T> {
  success: boolean
  data?: T
  error?: string
  meta?: {
    total: number
    page: number
    limit: number
  }
}

// 成功レスポンス
return NextResponse.json({
  success: true,
  data: markets,
  meta: { total: 100, page: 1, limit: 10 }
})

// エラーレスポンス
return NextResponse.json({
  success: false,
  error: 'Invalid request'
}, { status: 400 })

入力検証

import { z } from 'zod'

// ✅ GOOD: スキーマ検証
const CreateMarketSchema = z.object({
  name: z.string().min(1).max(200),
  description: z.string().min(1).max(2000),
  endDate: z.string().datetime(),
  categories: z.array(z.string()).min(1)
})

export async function POST(request: Request) {
  const body = await request.json()

  try {
    const validated = CreateMarketSchema.parse(body)
    // 検証されたデータで処理を進める
  } catch (error) {
    if (error instanceof z.ZodError) {
      return NextResponse.json({
        success: false,
        error: 'Validation failed',
        details: error.errors
      }, { status: 400 })
    }
  }
}

ファイル構成

プロジェクト構造

src/
├── app/                    # Next.js App Router
│   ├── api/               # APIルート
│   ├── markets/           # マーケットページ
│   └── (auth)/           # 認証ページ（ルートグループ）
├── components/            # Reactコンポーネント
│   ├── ui/               # 汎用UIコンポーネント
│   ├── forms/            # フォームコンポーネント
│   └── layouts/          # レイアウトコンポーネント
├── hooks/                # カスタムReactフック
├── lib/                  # ユーティリティと設定
│   ├── api/             # APIクライアント
│   ├── utils/           # ヘルパー関数
│   └── constants/       # 定数
├── types/                # TypeScript型定義
└── styles/              # グローバルスタイル

ファイル名の命名規則

components/Button.tsx          # コンポーネント用PascalCase
hooks/useAuth.ts              # 'use'プレフィックス付きcamelCase
lib/formatDate.ts             # ユーティリティ用camelCase
types/market.types.ts         # .types接尾辞付きcamelCase

コメントとドキュメント

コメントを書く時機

// ✅ GOOD: WHYを説明する、WHATではなく
// APIがダウンしている間に圧倒されるのを避けるため指数バックオフを使用
const delay = Math.min(1000 * Math.pow(2, retryCount), 30000)

// 大規模配列のパフォーマンスのため意図的に変更を使用
items.push(newItem)

// ❌ BAD: 明らかなことを述べている
// カウンターを1増やす
count++

// 名前をユーザーの名前に設定
name = user.name

公開APIのJSDoc

/**
 * 意味的類似性を使用してマーケットを検索します。
 *
 * @param query - 自然言語の検索クエリ
 * @param limit - 最大結果数（デフォルト: 10）
 * @returns 類似度スコアでソートされたマーケットの配列
 * @throws {Error} OpenAI APIが失敗した場合またはRedisが利用できない場合
 *
 * @example
 * ```typescript
 * const results = await searchMarkets('election', 5)
 * console.log(results[0].name) // "Trump vs Biden"
 * ```
 */
export async function searchMarkets(
  query: string,
  limit: number = 10
): Promise<Market[]> {
  // Implementation
}

パフォーマンスのベストプラクティス

メモ化

import { useMemo, useCallback } from 'react'

// ✅ GOOD: 計算量の多い処理をメモ化
const sortedMarkets = useMemo(() => {
  return markets.sort((a, b) => b.volume - a.volume)
}, [markets])

// ✅ GOOD: コールバックをメモ化
const handleSearch = useCallback((query: string) => {
  setSearchQuery(query)
}, [])

遅延ロード

import { lazy, Suspense } from 'react'

// ✅ GOOD: 重いコンポーネントを遅延ロード
const HeavyChart = lazy(() => import('./HeavyChart'))

export function Dashboard() {
  return (
    <Suspense fallback={<Spinner />}>
      <HeavyChart />
    </Suspense>
  )
}

データベースクエリ

// ✅ GOOD: 必要な列のみを選択
const { data } = await supabase
  .from('markets')
  .select('id, name, status')
  .limit(10)

// ❌ BAD: すべてを選択
const { data } = await supabase
  .from('markets')
  .select('*')

テスト標準

テスト構造（AAAパターン）

test('calculates similarity correctly', () => {
  // Arrange（準備）
  const vector1 = [1, 0, 0]
  const vector2 = [0, 1, 0]

  // Act（実行）
  const similarity = calculateCosineSimilarity(vector1, vector2)

  // Assert（検証）
  expect(similarity).toBe(0)
})

テストの命名

// ✅ GOOD: 説明的なテスト名
test('returns empty array when no markets match query', () => { })
test('throws error when OpenAI API key is missing', () => { })
test('falls back to substring search when Redis unavailable', () => { })

// ❌ BAD: 曖昧なテスト名
test('works', () => { })
test('test search', () => { })

コードスメル検出

以下のアンチパターンに注意してください：

1. 長すぎる関数

// ❌ BAD: 関数が50行を超える
function processMarketData() {
  // 100行のコード
}

// ✅ GOOD: より小さな関数に分割
function processMarketData() {
  const validated = validateData()
  const transformed = transformData(validated)
  return saveData(transformed)
}

2. 深いネスト

// ❌ BAD: 5レベル以上のネスト
if (user) {
  if (user.isAdmin) {
    if (market) {
      if (market.isActive) {
        if (hasPermission) {
          // 何かをする
        }
      }
    }
  }
}

// ✅ GOOD: 早期リターン
if (!user) return
if (!user.isAdmin) return
if (!market) return
if (!market.isActive) return
if (!hasPermission) return

// 何かをする

3. マジックナンバー

// ❌ BAD: 説明のない数字
if (retryCount > 3) { }
setTimeout(callback, 500)

// ✅ GOOD: 名前付き定数
const MAX_RETRIES = 3
const DEBOUNCE_DELAY_MS = 500

if (retryCount > MAX_RETRIES) { }
setTimeout(callback, DEBOUNCE_DELAY_MS)

覚えておきましょう: コード品質は譲歩できません。明確で保守性の高いコードは、迅速な開発と自信を持ったリファクタリングを可能にします。

使用時期

このスキルは、概要に説明されているワークフローまたはアクションを実行する際に適用できます。

制限事項

• このスキルは、上記で説明されたスコープと明確に一致するタスクでのみ使用してください。
• 出力を環境固有の検証、テスト、または専門家の評価の代わりとして扱わないでください。
• 必須入力、権限、安全境界、または成功基準が不足している場合は、説明を求めてください。