Coding Standards

// PASS: 良好：描述性名稱const marketSearchQuery = 'election'const isUserAuthenticated = trueconst totalRevenue = 1000
// FAIL: 不良：不清楚的名稱const q = 'election'const flag = trueconst x = 1000

// PASS: 良好：動詞-名詞模式async function fetchMarketData(marketId: string) { }function calculateSimilarity(a: number[], b: number[]) { }function isValidEmail(email: string): boolean { }
// FAIL: 不良：不清楚或只有名詞async function market(id: string) { }function similarity(a, b) { }function email(e) { }

// PASS: 總是使用展開運算符const updatedUser = {  ...user,  name: 'New Name'}
const updatedArray = [...items, newItem]
// FAIL: 永遠不要直接修改user.name = 'New Name'  // 不良items.push(newItem)     // 不良

// PASS: 良好：完整的錯誤處理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')  }}
// FAIL: 不良：無錯誤處理async function fetchData(url) {  const response = await fetch(url)  return response.json()}

// PASS: 良好：可能時並行執行const [users, markets, stats] = await Promise.all([  fetchUsers(),  fetchMarkets(),  fetchStats()])
// FAIL: 不良：不必要的順序執行const users = await fetchUsers()const markets = await fetchMarkets()const stats = await fetchStats()

// PASS: 良好：正確的型別interface Market {  id: string  name: string  status: 'active' | 'resolved' | 'closed'  created_at: Date}
function getMarket(id: string): Promise<Market> {  // 實作}
// FAIL: 不良：使用 'any'function getMarket(id: any): Promise<any> {  // 實作}

// PASS: 良好：具有型別的函式元件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>  )}
// FAIL: 不良：無型別、結構不清楚export function Button(props) {  return <button onClick={props.onClick}>{props.children}</button>}

// PASS: 良好：可重用的自訂 hookexport 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)

// PASS: 良好：正確的狀態更新const [count, setCount] = useState(0)
// 基於先前狀態的函式更新setCount(prev => prev + 1)
// FAIL: 不良：直接引用狀態setCount(count + 1)  // 在非同步情境中可能過時

// PASS: 良好：清晰的條件渲染{isLoading && <Spinner />}{error && <ErrorMessage error={error} />}{data && <DataDisplay data={data} />}
// FAIL: 不良：三元地獄{isLoading ? <Spinner /> : error ? <ErrorMessage error={error} /> : data ? <DataDisplay data={data} /> : null}

// PASS: 良好：一致的回應結構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'
// PASS: 良好：Schema 驗證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 })    }  }}

// PASS: 良好：解釋「為什麼」而非「什麼」// 使用指數退避以避免在服務中斷時壓垮 APIconst delay = Math.min(1000 * Math.pow(2, retryCount), 30000)
// 為了處理大陣列的效能，此處刻意使用突變items.push(newItem)
// FAIL: 不良：陳述顯而易見的事實// 將計數器加 1count++
// 將名稱設為使用者的名稱name = user.name

/** * 使用語意相似度搜尋市場。 * * @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[]> {  // 實作}

import { useMemo, useCallback } from 'react'
// PASS: 良好：記憶化昂貴的計算const sortedMarkets = useMemo(() => {  return markets.sort((a, b) => b.volume - a.volume)}, [markets])
// PASS: 良好：記憶化回呼函式const handleSearch = useCallback((query: string) => {  setSearchQuery(query)}, [])

import { lazy, Suspense } from 'react'
// PASS: 良好：延遲載入重型元件const HeavyChart = lazy(() => import('./HeavyChart'))
export function Dashboard() {  return (    <Suspense fallback={<Spinner />}>      <HeavyChart />    </Suspense>  )}

// PASS: 良好：只選擇需要的欄位const { data } = await supabase  .from('markets')  .select('id, name, status')  .limit(10)
// FAIL: 不良：選擇所有欄位const { data } = await supabase  .from('markets')  .select('*')

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)})

// PASS: 良好：描述性測試名稱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', () => { })
// FAIL: 不良：模糊的測試名稱test('works', () => { })test('test search', () => { })

// FAIL: 不良：函式超過 50 行function processMarketData() {  // 100 行程式碼}
// PASS: 良好：拆分為較小的函式function processMarketData() {  const validated = validateData()  const transformed = transformData(validated)  return saveData(transformed)}

// FAIL: 不良：5 層以上巢狀if (user) {  if (user.isAdmin) {    if (market) {      if (market.isActive) {        if (hasPermission) {          // 做某事        }      }    }  }}
// PASS: 良好：提前返回if (!user) returnif (!user.isAdmin) returnif (!market) returnif (!market.isActive) returnif (!hasPermission) return
// 做某事

// FAIL: 不良：無解釋的數字if (retryCount > 3) { }setTimeout(callback, 500)
// PASS: 良好：命名常數const MAX_RETRIES = 3const DEBOUNCE_DELAY_MS = 500
if (retryCount > MAX_RETRIES) { }setTimeout(callback, DEBOUNCE_DELAY_MS)