第 11 章 测试与发布

{
  "scripts": {
    "test": "vitest run",
    "test:watch": "vitest"
  },
  "devDependencies": {
    "vitest": "^3.0.0"
  }
}

// src/core/__tests__/logger.test.ts
import { describe, it, expect, vi, beforeEach, afterEach } from 'vitest'
import { logger, setLogLevel } from '../logger.js'
 
describe('Logger', () => {
  let consoleSpy: ReturnType<typeof vi.spyOn>
 
  beforeEach(() => {
    consoleSpy = vi.spyOn(console, 'log').mockImplementation(() => {})
    setLogLevel('normal') // 每个测试重置状态
  })
 
  afterEach(() => {
    consoleSpy.mockRestore()
  })
 
  it('quiet 级别下 info 不应该输出', () => {
    setLogLevel('quiet')
    logger.info('这条信息不该出现')
    expect(consoleSpy).not.toHaveBeenCalled()
  })
 
  it('normal 级别下 info 应该输出', () => {
    setLogLevel('normal')
    logger.info('这条信息应该出现')
    expect(consoleSpy).toHaveBeenCalledOnce()
  })
 
  it('normal 级别下 debug 不应该输出', () => {
    setLogLevel('normal')
    logger.debug('调试信息')
    expect(consoleSpy).not.toHaveBeenCalled()
  })
 
  it('debug 级别下所有方法都应该输出', () => {
    setLogLevel('debug')
    logger.info('info')
    logger.verbose('verbose')
    logger.debug('debug')
    expect(consoleSpy).toHaveBeenCalledTimes(3)
  })
})

// src/core/__tests__/error.test.ts
import { describe, it, expect, vi, afterEach } from 'vitest'
import { UserError, NetworkError, handleError, ExitCode } from '../error.js'
 
describe('Error 类', () => {
  it('UserError 携带 hint', () => {
    const err = new UserError('配置缺失', '运行 repox init')
    expect(err.message).toBe('配置缺失')
    expect(err.hint).toBe('运行 repox init')
    expect(err.name).toBe('UserError')
    expect(err).toBeInstanceOf(Error)
  })
 
  it('NetworkError 携带状态码和 URL', () => {
    const err = new NetworkError('请求失败', 404, 'https://api.example.com')
    expect(err.statusCode).toBe(404)
    expect(err.url).toBe('https://api.example.com')
  })
})
 
describe('handleError', () => {
  const exitSpy = vi.spyOn(process, 'exit').mockImplementation(() => undefined as never)
  const stderrSpy = vi.spyOn(console, 'error').mockImplementation(() => {})
 
  afterEach(() => {
    exitSpy.mockClear()
    stderrSpy.mockClear()
  })
 
  it('UserError 使用退出码 2', () => {
    handleError(new UserError('测试错误'))
    expect(exitSpy).toHaveBeenCalledWith(ExitCode.USAGE_ERROR)
  })
 
  it('NetworkError 使用退出码 1', () => {
    handleError(new NetworkError('网络错误'))
    expect(exitSpy).toHaveBeenCalledWith(ExitCode.GENERAL_ERROR)
  })
})

// src/utils/__tests__/format.test.ts
import { describe, it, expect } from 'vitest'
import { truncate } from '../format.js'
 
describe('truncate', () => {
  it('短字符串不截断', () => {
    expect(truncate('hello', 10)).toBe('hello')
  })
 
  it('长字符串截断并加省略号', () => {
    expect(truncate('hello world', 8)).toBe('hello...')
  })
 
  it('刚好等于最大长度不截断', () => {
    expect(truncate('12345', 5)).toBe('12345')
  })
})

// tests/integration/cli.test.ts
import { describe, it, expect } from 'vitest'
import { execSync } from 'node:child_process'
 
const CLI = 'npx tsx src/index.ts'
 
describe('CLI 集成测试', () => {
  it('--version 输出版本号', () => {
    const output = execSync(`${CLI} --version`, { encoding: 'utf-8' }).trim()
    expect(output).toMatch(/^\d+\.\d+\.\d+$/)
  })
 
  it('--help 输出帮助信息', () => {
    const output = execSync(`${CLI} --help`, { encoding: 'utf-8' })
    expect(output).toContain('AI 驱动的仓库助手')
    expect(output).toContain('scan')
    expect(output).toContain('commit')
  })
 
  it('scan 命令输出 JSON', () => {
    const output = execSync(`${CLI} scan --format json`, {
      encoding: 'utf-8',
      cwd: process.cwd(), // 确保在 repox 项目目录下
    })
    const parsed = JSON.parse(output)
    expect(parsed.name).toBe('repox')
    expect(parsed).toHaveProperty('language')
    expect(parsed).toHaveProperty('frameworks')
  })
 
  it('未知命令返回非零退出码', () => {
    try {
      execSync(`${CLI} nonexistent`, { encoding: 'utf-8', stdio: 'pipe' })
      expect.fail('应该抛出错误')
    } catch (error: unknown) {
      const execError = error as { status: number; stderr: string }
      expect(execError.status).not.toBe(0)
    }
  })
 
  it('scan --format json 的输出是合法 JSON', () => {
    const output = execSync(`${CLI} scan --format json`, { encoding: 'utf-8' })
    expect(() => JSON.parse(output)).not.toThrow()
  })
})

execSync(command, { encoding: 'utf-8', timeout: 10000 }) // 10 秒超时

// tests/snapshot/output.test.ts
import { describe, it, expect } from 'vitest'
import { formatKeyValue, formatList } from '../../src/utils/format.js'
 
describe('输出格式快照', () => {
  it('formatKeyValue plain 格式', () => {
    const result = formatKeyValue({
      '项目名称': 'repox',
      '语言': 'TypeScript',
      'TypeScript': true,
    }, 'plain')
    expect(result).toMatchSnapshot()
  })
 
  it('formatList plain 格式', () => {
    const result = formatList(
      ['名称', '版本', '描述'],
      [
        ['repox-plugin-feishu', '1.0.0', '飞书集成'],
        ['repox-plugin-gitlab', '0.2.0', 'GitLab 支持'],
      ],
      'plain',
    )
    expect(result).toMatchSnapshot()
  })
})

it('help 输出保持稳定', () => {
  const output = execSync('npx tsx src/index.ts --help', { encoding: 'utf-8' })
  expect(output).toMatchSnapshot()
})

// 方式一：vi.stubGlobal 替换全局 fetch
const mockFetch = vi.fn()
vi.stubGlobal('fetch', mockFetch)
 
mockFetch.mockResolvedValueOnce({
  ok: true,
  status: 200,
  json: async () => ({ data: 'test' }),
  headers: new Headers(),
})
 
// 调用被测代码后验证
expect(mockFetch).toHaveBeenCalledWith(
  expect.stringContaining('/api/'),
  expect.objectContaining({ method: 'POST' }),
)

// 方式二：mock 整个 api-client 模块
vi.mock('../core/api-client.js', () => ({
  createGitHubClient: () => ({
    get: vi.fn().mockResolvedValue({ data: { full_name: 'test/repo' }, status: 200 }),
    post: vi.fn().mockResolvedValue({ data: {}, status: 201 }),
  }),
}))

const exitSpy = vi.spyOn(process, 'exit').mockImplementation(() => undefined as never)

import { vol } from 'memfs'
vi.mock('node:fs', async () => {
  const memfs = await import('memfs')
  return memfs.fs
})
 
beforeEach(() => {
  vol.reset()
  vol.fromJSON({
    '/home/user/.config/repox/config.json': JSON.stringify({
      ai: { apiKey: 'sk-test' },
    }),
    '/project/.repoxrc': JSON.stringify({
      output: { format: 'json' },
    }),
  })
})

import { mkdtempSync, writeFileSync, rmSync } from 'node:fs'
import { tmpdir } from 'node:os'
import path from 'node:path'
 
let testDir: string
 
beforeEach(() => {
  testDir = mkdtempSync(path.join(tmpdir(), 'repox-test-'))
})
 
afterEach(() => {
  rmSync(testDir, { recursive: true, force: true })
})

// esbuild.config.js
import { build } from 'esbuild'
 
await build({
  entryPoints: ['src/index.ts'],
  bundle: true,
  platform: 'node',
  target: 'node18',
  format: 'esm',
  outfile: 'dist/index.js',
  banner: {
    js: '#!/usr/bin/env node',
  },
  external: [
    // 保留为外部依赖，避免打包问题
    'ink',
    'react',
    'yoga-wasm-web',
  ],
})
 
console.log('构建完成 → dist/index.js')

{
  "bin": {
    "repox": "./dist/index.js"
  },
  "files": ["dist"],
  "scripts": {
    "build": "node esbuild.config.js",
    "prepublishOnly": "npm run build"
  }
}

# 1. 确保已登录 npm
npm login
 
# 2. 检查包名是否被占用
npm search repox
 
# 3. 构建
npm run build
 
# 4. dry-run 看看会发布什么
npm publish --dry-run
 
# 5. 正式发布
npm publish

{
  "name": "@yourname/repox",
  "bin": {
    "repox": "./dist/index.js"
  }
}

npm publish --access public

# 1. 用 esbuild 打包成单文件（已经做了）
node esbuild.config.js
 
# 2. 生成 SEA 配置
echo '{ "main": "dist/index.js", "output": "dist/sea-prep.blob" }' > sea-config.json
 
# 3. 生成 SEA blob
node --experimental-sea-config sea-config.json
 
# 4. 复制 node 可执行文件
cp $(which node) dist/repox
 
# 5. 注入 blob
npx postject dist/repox NODE_SEA_BLOB dist/sea-prep.blob \
  --sentinel-fuse NODE_SEA_FUSE_fce680ab2cc467b6e072b8b5df1996b2
 
# 6. macOS 需要重签名
codesign --sign - dist/repox  # 仅 macOS

# 安装
npm install -D @changesets/cli
 
# 初始化
npx changeset init

# 完成一个功能后，创建 changeset
npx changeset
# 交互式选择：这是 patch / minor / major？
# 写一行变更描述
 
# 发版时，changeset 自动：
# 1. 根据所有待发布的 changeset 计算新版本号
# 2. 更新 package.json
# 3. 生成 CHANGELOG.md
# 4. 提交并打 tag
npx changeset version
npm publish

import updateNotifier from 'update-notifier'
import pkg from '../package.json' assert { type: 'json' }
 
// 检查更新（异步、非阻塞、有本地缓存不会每次都请求 npm）
const notifier = updateNotifier({ pkg })
notifier.notify()

   ╭─────────────────────────────────────╮
   │                                     │
   │   Update available 0.1.0 → 0.5.0   │
   │   Run npm i -g repox to update      │
   │                                     │
   ╰─────────────────────────────────────╯

# .github/workflows/ci.yml
name: CI
 
on:
  push:
    branches: [main]
  pull_request:
    branches: [main]
 
jobs:
  test:
    runs-on: ubuntu-latest
    strategy:
      matrix:
        node-version: [18, 20, 22]
    steps:
      - uses: actions/checkout@v4
 
      - uses: actions/setup-node@v4
        with:
          node-version: ${{ matrix.node-version }}
          cache: 'npm'
 
      - run: npm ci
      - run: npm run lint
      - run: npm test
 
  build:
    runs-on: ubuntu-latest
    needs: test
    steps:
      - uses: actions/checkout@v4
 
      - uses: actions/setup-node@v4
        with:
          node-version: 20
          cache: 'npm'
 
      - run: npm ci
      - run: npm run build
 
      # 验证打包产物能正常运行
      - run: node dist/index.js --version
      - run: node dist/index.js --help

# .github/workflows/release.yml
name: Release
 
on:
  push:
    branches: [main]
 
jobs:
  release:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
 
      - uses: actions/setup-node@v4
        with:
          node-version: 20
          registry-url: 'https://registry.npmjs.org'
          cache: 'npm'
 
      - run: npm ci
      - run: npm run build
 
      - name: 创建 Release PR 或发布
        uses: changesets/action@v1
        with:
          publish: npm publish
        env:
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
          NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}