mirror of
https://github.com/affaan-m/everything-claude-code.git
synced 2026-03-30 13:43:26 +08:00
bf7ed1fce2
Translate English prose inside plain text code blocks (```text, ```) across ja-JP documentation to Japanese, following the same approach as PR #753 (zh-CN translation). Translated content includes: - Output template labels and status messages - Folder tree inline comments - CLI workflow descriptions - Error/warning message examples - Commit message templates and PR title examples Technical identifiers, file paths, and actual code remain untranslated.
528 lines
12 KiB
Markdown
528 lines
12 KiB
Markdown
---
|
||
name: coding-standards
|
||
description: TypeScript、JavaScript、React、Node.js開発のための汎用コーディング標準、ベストプラクティス、パターン。
|
||
---
|
||
|
||
# コーディング標準とベストプラクティス
|
||
|
||
すべてのプロジェクトに適用される汎用的なコーディング標準。
|
||
|
||
## コード品質の原則
|
||
|
||
### 1. 可読性優先
|
||
|
||
* コードは書くよりも読まれることが多い
|
||
* 明確な変数名と関数名
|
||
* コメントよりも自己文書化コードを優先
|
||
* 一貫したフォーマット
|
||
|
||
### 2. KISS (Keep It Simple, Stupid)
|
||
|
||
* 機能する最もシンプルなソリューションを採用
|
||
* 過剰設計を避ける
|
||
* 早すぎる最適化を避ける
|
||
* 理解しやすさ > 巧妙なコード
|
||
|
||
### 3. DRY (Don't Repeat Yourself)
|
||
|
||
* 共通ロジックを関数に抽出
|
||
* 再利用可能なコンポーネントを作成
|
||
* ユーティリティ関数をモジュール間で共有
|
||
* コピー&ペーストプログラミングを避ける
|
||
|
||
### 4. YAGNI (You Aren't Gonna Need It)
|
||
|
||
* 必要ない機能を事前に構築しない
|
||
* 推測的な一般化を避ける
|
||
* 必要なときのみ複雑さを追加
|
||
* シンプルに始めて、必要に応じてリファクタリング
|
||
|
||
## TypeScript/JavaScript標準
|
||
|
||
### 変数の命名
|
||
|
||
```typescript
|
||
// ✅ GOOD: Descriptive names
|
||
const marketSearchQuery = 'election'
|
||
const isUserAuthenticated = true
|
||
const totalRevenue = 1000
|
||
|
||
// ❌ BAD: Unclear names
|
||
const q = 'election'
|
||
const flag = true
|
||
const x = 1000
|
||
```
|
||
|
||
### 関数の命名
|
||
|
||
```typescript
|
||
// ✅ GOOD: Verb-noun pattern
|
||
async function fetchMarketData(marketId: string) { }
|
||
function calculateSimilarity(a: number[], b: number[]) { }
|
||
function isValidEmail(email: string): boolean { }
|
||
|
||
// ❌ BAD: Unclear or noun-only
|
||
async function market(id: string) { }
|
||
function similarity(a, b) { }
|
||
function email(e) { }
|
||
```
|
||
|
||
### 不変性パターン（重要）
|
||
|
||
```typescript
|
||
// ✅ ALWAYS use spread operator
|
||
const updatedUser = {
|
||
...user,
|
||
name: 'New Name'
|
||
}
|
||
|
||
const updatedArray = [...items, newItem]
|
||
|
||
// ❌ NEVER mutate directly
|
||
user.name = 'New Name' // BAD
|
||
items.push(newItem) // BAD
|
||
```
|
||
|
||
### エラーハンドリング
|
||
|
||
```typescript
|
||
// ✅ GOOD: Comprehensive error handling
|
||
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: No error handling
|
||
async function fetchData(url) {
|
||
const response = await fetch(url)
|
||
return response.json()
|
||
}
|
||
```
|
||
|
||
### Async/Awaitベストプラクティス
|
||
|
||
```typescript
|
||
// ✅ GOOD: Parallel execution when possible
|
||
const [users, markets, stats] = await Promise.all([
|
||
fetchUsers(),
|
||
fetchMarkets(),
|
||
fetchStats()
|
||
])
|
||
|
||
// ❌ BAD: Sequential when unnecessary
|
||
const users = await fetchUsers()
|
||
const markets = await fetchMarkets()
|
||
const stats = await fetchStats()
|
||
```
|
||
|
||
### 型安全性
|
||
|
||
```typescript
|
||
// ✅ GOOD: Proper types
|
||
interface Market {
|
||
id: string
|
||
name: string
|
||
status: 'active' | 'resolved' | 'closed'
|
||
created_at: Date
|
||
}
|
||
|
||
function getMarket(id: string): Promise<Market> {
|
||
// Implementation
|
||
}
|
||
|
||
// ❌ BAD: Using 'any'
|
||
function getMarket(id: any): Promise<any> {
|
||
// Implementation
|
||
}
|
||
```
|
||
|
||
## Reactベストプラクティス
|
||
|
||
### コンポーネント構造
|
||
|
||
```typescript
|
||
// ✅ GOOD: Functional component with types
|
||
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: No types, unclear structure
|
||
export function Button(props) {
|
||
return <button onClick={props.onClick}>{props.children}</button>
|
||
}
|
||
```
|
||
|
||
### カスタムフック
|
||
|
||
```typescript
|
||
// ✅ GOOD: Reusable custom hook
|
||
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
|
||
}
|
||
|
||
// Usage
|
||
const debouncedQuery = useDebounce(searchQuery, 500)
|
||
```
|
||
|
||
### 状態管理
|
||
|
||
```typescript
|
||
// ✅ GOOD: Proper state updates
|
||
const [count, setCount] = useState(0)
|
||
|
||
// Functional update for state based on previous state
|
||
setCount(prev => prev + 1)
|
||
|
||
// ❌ BAD: Direct state reference
|
||
setCount(count + 1) // Can be stale in async scenarios
|
||
```
|
||
|
||
### 条件付きレンダリング
|
||
|
||
```typescript
|
||
// ✅ GOOD: Clear conditional rendering
|
||
{isLoading && <Spinner />}
|
||
{error && <ErrorMessage error={error} />}
|
||
{data && <DataDisplay data={data} />}
|
||
|
||
// ❌ BAD: Ternary hell
|
||
{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
|
||
```
|
||
|
||
### レスポンス形式
|
||
|
||
```typescript
|
||
// ✅ GOOD: Consistent response structure
|
||
interface ApiResponse<T> {
|
||
success: boolean
|
||
data?: T
|
||
error?: string
|
||
meta?: {
|
||
total: number
|
||
page: number
|
||
limit: number
|
||
}
|
||
}
|
||
|
||
// Success response
|
||
return NextResponse.json({
|
||
success: true,
|
||
data: markets,
|
||
meta: { total: 100, page: 1, limit: 10 }
|
||
})
|
||
|
||
// Error response
|
||
return NextResponse.json({
|
||
success: false,
|
||
error: 'Invalid request'
|
||
}, { status: 400 })
|
||
```
|
||
|
||
### 入力検証
|
||
|
||
```typescript
|
||
import { z } from 'zod'
|
||
|
||
// ✅ GOOD: Schema validation
|
||
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)
|
||
// Proceed with validated data
|
||
} 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
|
||
```
|
||
|
||
## コメントとドキュメント
|
||
|
||
### コメントを追加するタイミング
|
||
|
||
```typescript
|
||
// ✅ GOOD: Explain WHY, not WHAT
|
||
// Use exponential backoff to avoid overwhelming the API during outages
|
||
const delay = Math.min(1000 * Math.pow(2, retryCount), 30000)
|
||
|
||
// Deliberately using mutation here for performance with large arrays
|
||
items.push(newItem)
|
||
|
||
// ❌ BAD: Stating the obvious
|
||
// Increment counter by 1
|
||
count++
|
||
|
||
// Set name to user's name
|
||
name = user.name
|
||
```
|
||
|
||
### パブリックAPIのJSDoc
|
||
|
||
````typescript
|
||
/**
|
||
* Searches markets using semantic similarity.
|
||
*
|
||
* @param query - Natural language search query
|
||
* @param limit - Maximum number of results (default: 10)
|
||
* @returns Array of markets sorted by similarity score
|
||
* @throws {Error} If OpenAI API fails or Redis unavailable
|
||
*
|
||
* @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
|
||
}
|
||
````
|
||
|
||
## パフォーマンスベストプラクティス
|
||
|
||
### メモ化
|
||
|
||
```typescript
|
||
import { useMemo, useCallback } from 'react'
|
||
|
||
// ✅ GOOD: Memoize expensive computations
|
||
const sortedMarkets = useMemo(() => {
|
||
return markets.sort((a, b) => b.volume - a.volume)
|
||
}, [markets])
|
||
|
||
// ✅ GOOD: Memoize callbacks
|
||
const handleSearch = useCallback((query: string) => {
|
||
setSearchQuery(query)
|
||
}, [])
|
||
```
|
||
|
||
### 遅延読み込み
|
||
|
||
```typescript
|
||
import { lazy, Suspense } from 'react'
|
||
|
||
// ✅ GOOD: Lazy load heavy components
|
||
const HeavyChart = lazy(() => import('./HeavyChart'))
|
||
|
||
export function Dashboard() {
|
||
return (
|
||
<Suspense fallback={<Spinner />}>
|
||
<HeavyChart />
|
||
</Suspense>
|
||
)
|
||
}
|
||
```
|
||
|
||
### データベースクエリ
|
||
|
||
```typescript
|
||
// ✅ GOOD: Select only needed columns
|
||
const { data } = await supabase
|
||
.from('markets')
|
||
.select('id, name, status')
|
||
.limit(10)
|
||
|
||
// ❌ BAD: Select everything
|
||
const { data } = await supabase
|
||
.from('markets')
|
||
.select('*')
|
||
```
|
||
|
||
## テスト標準
|
||
|
||
### テスト構造（AAAパターン）
|
||
|
||
```typescript
|
||
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)
|
||
})
|
||
```
|
||
|
||
### テストの命名
|
||
|
||
```typescript
|
||
// ✅ GOOD: Descriptive test names
|
||
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: Vague test names
|
||
test('works', () => { })
|
||
test('test search', () => { })
|
||
```
|
||
|
||
## コードスメルの検出
|
||
|
||
以下のアンチパターンに注意してください。
|
||
|
||
### 1. 長い関数
|
||
|
||
```typescript
|
||
// ❌ BAD: Function > 50 lines
|
||
function processMarketData() {
|
||
// 100 lines of code
|
||
}
|
||
|
||
// ✅ GOOD: Split into smaller functions
|
||
function processMarketData() {
|
||
const validated = validateData()
|
||
const transformed = transformData(validated)
|
||
return saveData(transformed)
|
||
}
|
||
```
|
||
|
||
### 2. 深いネスト
|
||
|
||
```typescript
|
||
// ❌ BAD: 5+ levels of nesting
|
||
if (user) {
|
||
if (user.isAdmin) {
|
||
if (market) {
|
||
if (market.isActive) {
|
||
if (hasPermission) {
|
||
// Do something
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
|
||
// ✅ GOOD: Early returns
|
||
if (!user) return
|
||
if (!user.isAdmin) return
|
||
if (!market) return
|
||
if (!market.isActive) return
|
||
if (!hasPermission) return
|
||
|
||
// Do something
|
||
```
|
||
|
||
### 3. マジックナンバー
|
||
|
||
```typescript
|
||
// ❌ BAD: Unexplained numbers
|
||
if (retryCount > 3) { }
|
||
setTimeout(callback, 500)
|
||
|
||
// ✅ GOOD: Named constants
|
||
const MAX_RETRIES = 3
|
||
const DEBOUNCE_DELAY_MS = 500
|
||
|
||
if (retryCount > MAX_RETRIES) { }
|
||
setTimeout(callback, DEBOUNCE_DELAY_MS)
|
||
```
|
||
|
||
**覚えておいてください**: コード品質は妥協できません。明確で保守可能なコードにより、迅速な開発と自信を持ったリファクタリングが可能になります。
|