asiaostrich/ac-coverage

AC 覆蓋率助手

語言: English | 繁體中文

分析驗收條件（AC）與測試之間的追蹤關係，並產生覆蓋率報告。

與 /coverage 的區別

| 面向 | /coverage | /ac-coverage | |------|-------------|----------------| | 範圍 | 程式碼層級（行/分支/函式） | 需求層級（AC 對測試） | | 輸入 | 原始碼 + 測試執行器 | SPEC 檔案 + 測試標註 | | 問題 | 「有多少程式碼被測試？」 | 「哪些 AC 有測試？」 | | 輸出 | 覆蓋率百分比 | 追蹤矩陣 + 缺口報告 |

工作流程

1. 解析 SPEC — 從規格檔案中擷取 AC 定義（AC-1、AC-2、...）
2. 掃描測試 — 使用標準連結慣例搜尋測試檔案中的 @AC 和 @SPEC 標註
3. 建立矩陣 — 將每個 AC 對應到其測試參考（檔案、測試名稱、行號）
4. 分類狀態 — 將每個 AC 標記為 ✅ 已覆蓋、⚠️ 部分覆蓋 或 ❌ 未覆蓋
5. 計算覆蓋率 — 套用公式：覆蓋率 % = (已覆蓋 + 部分 × 0.5) / 總計 × 100
6. 產生報告 — 輸出標準化 Markdown 報告

標註慣例

測試必須使用標準標註來參考其來源 AC：

// TypeScript/JavaScript
describe('AC-1: 使用有效憑證登入', () => {
  // @AC AC-1
  // @SPEC SPEC-001
  it('成功登入後應重導至儀表板', () => { ... });
});

# Python
class TestAC1_UserLogin:
    """AC-1: 使用有效憑證登入
    @AC AC-1
    @SPEC SPEC-001
    """
    def test_redirect_to_dashboard(self): ...

# BDD Feature
@SPEC-001 @AC-1
Scenario: 使用有效憑證登入

覆蓋率門檻

| 門檻 | 預設值 | 強制執行 | |------|--------|----------| | 提交時 | 80% | 功能分支合併必要條件 | | 發布時 | 100% | 正式發布必要條件 | | 警告 | 60% | 觸發覆蓋率警告 |

門檻可透過 --threshold 參數或專案設定進行配置。

四層追溯（--full 模式）

使用 --full 標記將追溯從 2 層（AC→Test）擴展為 4 層。

追溯層次

第 0 層：需求 / 使用者故事（REQ）
    ↓ (定義)
第 1 層：驗收條件（AC）
    ↓ (@AC 標註)
第 2 層：測試案例
    ↓ (覆蓋)
第 3 層：原始碼（@implements）

各層標註慣例

// 第 3→1 層：程式碼參考 AC
// @implements AC-1, AC-2
function authenticate(user: string, pass: string) { ... }

<!-- 第 0→1 層：SPEC 中的需求 -->
## 需求
### REQ-1: 使用者驗證
- AC-1: 給定有效憑證，當登入時，則通過驗證
- AC-2: 給定無效憑證，當登入時，則拒絕登入

完整追溯報告

## 四層追溯矩陣

| 需求 | AC | 測試 | 程式碼 | 狀態 |
|------|-----|------|--------|------|
| REQ-1 | AC-1 | auth.test.ts:15 | auth.ts:42 | ✅ 完整 |
| REQ-1 | AC-2 | auth.test.ts:30 | auth.ts:58 | ✅ 完整 |
| REQ-2 | AC-3 | — | dashboard.ts:10 | ⚠️ 無測試 |
| REQ-3 | AC-4 | export.test.ts:5 | — | ⚠️ 無程式碼 |

### 缺口摘要
- 第 0→1 層：2 個需求缺少 AC
- 第 1→2 層：1 個 AC 缺少測試
- 第 2→3 層：0 個測試缺少程式碼對應
- 第 3→1 層：3 個程式碼檔案缺少 AC 對應

反向追溯

使用 --trace-code <path> 從程式碼反向追溯到需求。

/ac-coverage --trace-code src/auth.ts
# 輸出：
# src/auth.ts:42 → @implements AC-1 → REQ-1 (SPEC-AUTH-001)
# src/auth.ts:58 → @implements AC-2 → REQ-1 (SPEC-AUTH-001)

報告格式

產生的報告遵循 core/acceptance-criteria-traceability.md 中的標準格式：

# AC 覆蓋率報告

**規格**: SPEC-001 — 功能名稱
**產生日期**: 2026-03-26
**覆蓋率**: 75% (6/8 AC)

## 摘要

| 狀態 | 數量 | 百分比 |
|------|------|--------|
| ✅ 已覆蓋 | 5 | 62.5% |
| ⚠️ 部分覆蓋 | 2 | 25.0% |
| ❌ 未覆蓋 | 1 | 12.5% |

## 追蹤矩陣

| AC-ID | 描述 | 狀態 | 測試參考 |
|-------|------|------|----------|
| AC-1 | 使用有效憑證登入 | ✅ | auth.test.ts:15 |
| AC-2 | 拒絕無效憑證 | ✅ | auth.test.ts:32 |
| ...   | ...            | ... | ... |

## 缺口

- **AC-8**: 社群登入 — 受 OAuth 沙盒環境限制

## 待辦事項

1. [ ] AC-8: 建立 OAuth 沙盒環境（預計完成：待定）

使用方式

• /ac-coverage - 分析當前專案的 AC 覆蓋率
• /ac-coverage path/to/SPEC.md - 分析特定規格檔案的 AC 覆蓋率
• /ac-coverage --full - 執行四層完整追溯分析
• /ac-coverage --trace-code <path> - 從程式碼反向追溯到需求

下一步引導

/ac-coverage 完成後，AI 助手應建議：

AC 覆蓋率分析完成。建議下一步：

• 覆蓋率達標 → 執行 /checkin 通過品質關卡
• 有未覆蓋 AC → 執行 /derive-tdd 補齊測試 ⭐ 推薦
• 有部分覆蓋 AC → 檢查缺少的邊界情況
• 需要完整追溯 → 執行 /ac-coverage --full
• 反向追溯 → 執行 /ac-coverage --trace-code <path>

參考

• 核心規範：acceptance-criteria-traceability.md
• SPEC：SPEC-AC-COVERAGE.md
• 相關：test-coverage-assistant（程式碼層級覆蓋率）
• 相關：checkin-assistant（品質關卡）