coding-standards

name	coding-standards
description	适用于 TypeScript、JavaScript、React 和 Node.js 开发的通用编码标准、最佳实践与模式。
origin	ECC

编码标准与最佳实践

适用于所有项目的通用编码标准。

何时激活

• 开始新项目或模块时
• 进行代码质量与可维护性审查时
• 为了遵循约定而重构现有代码时
• 强制执行命名、格式或结构的一致性时
• 设置 Lint、格式化或类型检查规则时
• 引导新贡献者了解编码约定时

代码质量原则

1. 可读性优先

• 代码被阅读的次数远多于编写的次数
• 变量和函数命名应清晰明确
• 优先选择自描述代码而非注释
• 保持一致的格式

2. KISS (Keep It Simple, Stupid - 保持简单)

• 采用最简单的可行方案
• 避免过度工程（Over-engineering）
• 不要进行过早优化
• 易于理解胜过奇技淫巧

3. DRY (Don't Repeat Yourself - 不要重复自己)

• 将公共逻辑提取到函数中
• 创建可复用的组件
• 在模块间共享工具函数
• 避免“复制粘贴式”编程

4. YAGNI (You Aren't Gonna Need It - 你不会需要它)

• 不要在功能被需要之前就构建它
• 避免投机性的通用设计
• 仅在必要时增加复杂度
• 从简单开始，在需要时重构

TypeScript/JavaScript 标准

变量命名

// ✅ 推荐：描述性名称
const marketSearchQuery = 'election'
const isUserAuthenticated = true
const totalRevenue = 1000

// ❌ 不推荐：命名不清晰
const q = 'election'
const flag = true
const x = 1000

函数命名

// ✅ 推荐：动词-名词模式
async function fetchMarketData(marketId: string) { }
function calculateSimilarity(a: number[], b: number[]) { }
function isValidEmail(email: string): boolean { }

// ❌ 不推荐：不清晰或仅用名词
async function market(id: string) { }
function similarity(a, b) { }
function email(e) { }

不可变模式 (Immutability Pattern)（至关重要）

// ✅ 始终使用展开运算符 (Spread Operator)
const updatedUser = {
  ...user,
  name: 'New Name'
}

const updatedArray = [...items, newItem]

// ❌ 严禁直接修改 (Mutate)
user.name = 'New Name'  // 错误
items.push(newItem)     // 错误

错误处理

// ✅ 推荐：全面的错误处理
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')
  }
}

// ❌ 不推荐：没有错误处理
async function fetchData(url) {
  const response = await fetch(url)
  return response.json()
}

Async/Await 最佳实践

// ✅ 推荐：尽可能并行执行
const [users, markets, stats] = await Promise.all([
  fetchUsers(),
  fetchMarkets(),
  fetchStats()
])

// ❌ 不推荐：不必要的顺序执行
const users = await fetchUsers()
const markets = await fetchMarkets()
const stats = await fetchStats()

类型安全

// ✅ 推荐：定义合适的类型
interface Market {
  id: string
  name: string
  status: 'active' | 'resolved' | 'closed'
  created_at: Date
}

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

// ❌ 不推荐：使用 'any'
function getMarket(id: any): Promise<any> {
  // 实现
}

React 最佳实践

组件结构

// ✅ 推荐：带类型的函数式组件
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>
  )
}

// ❌ 不推荐：无类型，结构不清晰
export function Button(props) {
  return <button onClick={props.onClick}>{props.children}</button>
}

自定义 Hook (Custom Hooks)

// ✅ 推荐：可复用的自定义 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
}

// 使用示例
const debouncedQuery = useDebounce(searchQuery, 500)

状态管理

// ✅ 推荐：正确的状态更新
const [count, setCount] = useState(0)

// 基于前一个状态的函数式更新
setCount(prev => prev + 1)

// ❌ 不推荐：直接引用当前状态
setCount(count + 1)  // 在异步场景中可能会导致状态过期

条件渲染

// ✅ 推荐：清晰的条件渲染
{isLoading && <Spinner />}
{error && <ErrorMessage error={error} />}
{data && <DataDisplay data={data} />}

// ❌ 不推荐：三元运算符地狱
{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

响应格式

// ✅ 推荐：一致的响应结构
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'

// ✅ 推荐：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: ,
        : error.
      }, { :  })
    }
  }
}

文件组织

项目结构

src/
├── app/                    # Next.js App Router
│   ├── api/               # API 路由
│   ├── markets/           # 市场相关页面
│   └── (auth)/           # 认证相关页面 (路由组)
├── components/            # React 组件
│   ├── ui/               # 通用 UI 组件
│   ├── forms/            # 表单组件
│   └── layouts/          # 布局组件
├── hooks/                # 自定义 React Hook
├── 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 为后缀

注释与文档

何时编写注释

// ✅ 推荐：解释“为什么”，而不是“是什么”
// 在服务中断期间使用指数退避 (Exponential Backoff)，以避免请求压垮 API
const delay = Math.min(1000 * Math.pow(2, retryCount), 30000)

// 为了优化处理大型数组的性能，这里特意使用了 Mutate 操作
items.push(newItem)

// ❌ 不推荐：描述显而易见的事实
// 计数器加 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[]> {
  // 实现
}

性能最佳实践

记忆化 (Memoization)

import { useMemo, useCallback } from 'react'

// ✅ 推荐：对高开销计算进行记忆化
const sortedMarkets = useMemo(() => {
  return markets.sort((a, b) => b.volume - a.volume)
}, [markets])

// ✅ 推荐：对回调函数进行记忆化
const handleSearch = useCallback((query: string) => {
  setSearchQuery(query)
}, [])

懒加载 (Lazy Loading)

import { lazy, Suspense } from 'react'

// ✅ 推荐：懒加载重量级组件
const HeavyChart = lazy(() => import('./HeavyChart'))

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

数据库查询

// ✅ 推荐：只查询必要的列
const { data } = await supabase
  .from('markets')
  .select('id, name, status')
  .limit(10)

// ❌ 不推荐：查询所有列
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)
})

测试命名

// ✅ 推荐：描述性测试名称
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', () => { })

// ❌ 不推荐：模糊的测试名称
test('works', () => { })
test('test search', () => { })

代码异味（Code Smell）检测

注意以下反模式：

1. 过长函数

// ❌ 不推荐：函数超过 50 行
function processMarketData() {
  // 100 行代码
}

// ✅ 推荐：拆分为更小的函数
function processMarketData() {
  const validated = validateData()
  const transformed = transformData(validated)
  return saveData(transformed)
}

2. 过深嵌套

// ❌ 不推荐：5 层以上的嵌套
if (user) {
  if (user.isAdmin) {
    if (market) {
      if (market.isActive) {
        if (hasPermission) {
          // 执行某些操作
        }
      }
    }
  }
}

// ✅ 推荐：卫语句 (Early Returns)
if (!user) return
if (!user.isAdmin) return
if (!market) return
if (!market.isActive) return
if (!hasPermission) return

// 执行某些操作

3. 魔术数字 (Magic Numbers)

// ❌ 不推荐：未解释的数字
if (retryCount > 3) { }
setTimeout(callback, 500)

// ✅ 推荐：具名常量
const MAX_RETRIES = 3
const DEBOUNCE_DELAY_MS = 500

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

记住：代码质量是不容商量的。清晰、可维护的代码是快速开发和从容重构的基石。