Skills

TDD Workflow

在编写新功能、修复 Bug 或重构代码时使用此技能。强制执行测试驱动开发(TDD),包括单元测试、集成测试和端到端(E2E)测试,覆盖率需达到 80% 以上。

Install

npx skills add xu-xiang/everything-claude-code-zh --skill tdd-workflow -g -a claude-code -y
Category
Testing
Updated
8mo ago
License
MIT
Context cost
Mediumabout 1,783 tokens
Runs scripts
No, instructions only

What it does

在编写新功能、修复 Bug 或重构代码时使用此技能。强制执行测试驱动开发(TDD),包括单元测试、集成测试和端到端(E2E)测试,覆盖率需达到 80% 以上。

测试驱动开发(TDD)工作流

此技能确保所有代码开发都遵循具有全面测试覆盖率的 TDD 原则。

何时激活

  • 编写新功能或新逻辑
  • 修复 Bug 或问题
  • 重构现有代码
  • 添加 API 端点
  • 创建新组件

核心原则

1. 先测试,后代码(Tests BEFORE Code)

务必先编写测试,然后编写代码使测试通过。

2. 覆盖率要求

  • 最低 80% 覆盖率(单元测试 + 集成测试 + E2E)
  • 覆盖所有边缘情况(edge cases)
  • 测试错误场景(error scenarios)
  • 验证边界条件(boundary conditions)

3. 测试类型

单元测试(Unit Tests)

  • 独立函数和工具方法
  • 组件逻辑
  • 纯函数
  • 辅助函数和工具

集成测试(Integration Tests)

  • API 端点
  • 数据库操作
  • 服务间交互
  • 外部 API 调用

端到端测试(E2E Tests - Playwright)

  • 关键用户流程
  • 完整工作流
  • 浏览器自动化
  • UI 交互

TDD 工作流步骤

第 1 步:编写用户旅程(User Journeys)

作为 [角色],我想 [操作],以便 [收益]

示例:
作为一名用户,我想进行语义化的市场搜索,
以便即使没有精确的关键词也能找到相关的市场。

第 2 步:生成测试用例

为每个用户旅程创建全面的测试用例:

describe('语义化搜索', () => {
  it('为查询返回相关的市场', async () => {
    // 测试实现
  })

  it('优雅地处理空查询', async () => {
    // 测试边缘情况
  })

  it('当 Redis 不可用时回退到子字符串搜索', async () => {
    // 测试回退行为
  })

  it('按相似度得分对结果进行排序', async () => {
    // 测试排序逻辑
  })
})

第 3 步:运行测试(预期失败)

npm test
# 测试应该失败 - 我们还没有实现功能

第 4 步:实现代码

编写最少量的代码使测试通过:

// 由测试引导的实现
export async function searchMarkets(query: string) {
  // 实现代码
}

第 5 步:再次运行测试

npm test
# 测试现在应该通过

第 6 步:重构(Refactor)

在保持测试通过的情况下提高代码质量:

  • 消除重复
  • 改进命名
  • 优化性能
  • 增强可读性

第 7 步:验证覆盖率

npm run test:coverage
# 验证是否达到了 80% 以上的覆盖率

测试模式(Patterns)

单元测试模式 (Jest/Vitest)

import { render, screen, fireEvent } from '@testing-library/react'
import { Button } from './Button'

describe('Button 组件', () => {
  it('以正确的文本渲染', () => {
    render(<Button>Click me</Button>)
    expect(screen.getByText('Click me')).toBeInTheDocument()
  })

  it('点击时调用 onClick', () => {
    const handleClick = jest.fn()
    render(<Button onClick={handleClick}>Click</Button>)

    fireEvent.click(screen.getByRole('button'))

    expect(handleClick).toHaveBeenCalledTimes(1)
  })
Read the whole SKILL.md on GitHub

More in Testing