Communityライティング&編集github.com

Coverage Guard(カバレッジガード)

JavaScript/TypeScriptプロジェクトで100%テストカバレッジを強制するAIエージェントスキルです。Vitest、Jest、react-scriptsなど様々なテストランナーに対応し、opencode、Claude Code、Cursor、Windsurf、GitHub Copilotで利用可能です。

Coverage Guard(カバレッジガード) とは?

Coverage Guardは、JavaScript/TypeScriptプロジェクトにおいて100%のテストカバレッジを自動的に達成・維持するためのAIエージェントスキルです。このスキルは、プロジェクト内のテストランナー(Vitest、Jest、react-scripts等)を自動検出し、不足しているテスト基盤をセットアップし、カバレッジが不足しているファイルに対してテストを生成・修正します。検出、スキャン、セットアップ、テスト生成、カバレッジ実行、ギャップ補填、検証という一連のパイプラインを繰り返し実行し、全ファイルが100%カバレッジに達するまでループします。opencode、Claude Code、Cursor、Windsurf、GitHub Copilotといった主要なAIエージェントプラットフォームと互換性があり、開発者が手動でカバレッジを監視・修正する手間を大幅に削減します。

対応✓Claude Code~Codex CLI✓Cursor✓OpenCode✓Windsurf
npx skills add sametcelikbicak/coverage-guard

Installed? Explore more ライティング&編集 skills: steipete/notion, langchain-ai/langchain, bytedance/podcast-generation · View all 6 →

お気に入りのAIに質問する

このエージェントスキルを事前に読み込んだ状態で新しいチャットを開きます。

ドキュメント

Coverage Guard

JavaScript/TypeScriptプロジェクトで100%テストカバレッジを確保します。テストランナーを自動検出し、不足しているテスト基盤をセットアップし、カバレッジのないコンポーネントのテストを作成し、すべてのファイルが100%カバレッジに達するまでループします。

概要

このスキルは完全なパイプラインに従います:

  1. 検出 ランナーと基盤 → 2. スキャン ソースファイルとテスト → 3. セットアップ 不足時 → 4. 生成 新しいテスト → 5. 実行 カバレッジ → 6. 補填 ギャップ → 7. 検証 → 100%になるまで繰り返し

ステップバイステップのワークフロー

フェーズ1: 環境の検出

プロジェクトルートの package.json を確認して判別します:

cat package.json

テストランナーとカバレッジツールを特定:

指標ランナーカバレッジコマンド
"vitest" が devDependencies に存在Vitestnpx vitest --coverage
"jest" が devDependencies に存在Jestnpx jest --coverage
"react-scripts" が devDependencies に存在react-scripts (Jest)npx react-scripts test --coverage
"next" が devDependencies に存在Next.js (Jest)npx next test --coverage または jest.config を確認
"@angular/core" が dependencies に存在Angular (Karma/Jasmine)ng test --code-coverage
"@playwright/test" が devDependencies に存在Playwrightnpx playwright test (ビルトインカバレッジなし; @playwright/test を istanbul と併用)
"mocha" が devDependencies に存在Mochanpx mocha (c8/nyc でカバレッジ)
"cypress" が devDependencies に存在Cypressnpx cypress run (@cypress/code-coverage でカバレッジ)
"ava" が devDependencies に存在AVAnpx ava (c8 でカバレッジ)
見つからないなし → フェーズ2へ → フェーズ3でセットアップ

フェーズ2: ソースファイルと既存テストのスキャン

テストが必要なすべてのソースファイル(コンポーネント、モジュール、ユーティリティ)を検索:

# 一般的なソースディレクトリ
find src -type f \( -name "*.ts" -o -name "*.tsx" -o -name "*.js" -o -name "*.jsx" \) ! -name "*.test.*" ! -name "*.spec.*" ! -name "*.d.ts" ! -path "*/node_modules/*" ! -path "*/dist/*" ! -path "*/build/*" ! -path "*/.next/*"

すべての既存テストファイルを検索:

find src -type f \( -name "*.test.*" -o -name "*.spec.*" \) ! -path "*/node_modules/*"

各ソースファイルをテストファイルにマッピング:

  • src/components/Button.tsx → src/components/Button.test.tsx または src/components/__tests__/Button.test.tsx
  • src/utils/format.ts → src/utils/format.test.ts または src/utils/__tests__/format.test.ts
  • プロジェクトの既存のテストファイル配置規則に従う

各ソースファイルを分類:

  • テストあり → カバレッジ分析リストに追加
  • テストなし → テスト生成対象としてマーク

フェーズ3: テスト基盤のセットアップ(不足時)

フェーズ1でテストランナーが検出されなかった場合、ユーザーに対話的に確認:

? テストフレームワークが検出されませんでした。どれをセットアップしますか?
  1) Vitest (推奨 — 高速、モダン、ネイティブESM)
  2) Jest (最も広く使われている)
  3) react-scripts (Create React App)
  4) なし — スキップ、手動でセットアップします

ユーザーが選択したら、依存関係をインストールして設定を作成:

Vitest セットアップ:

npm install -D vitest @vitest/coverage-v8

vitest.config.ts を作成:

import { defineConfig } from 'vitest/config'

export default defineConfig({
  test: {
    coverage: {
      provider: 'v8',
      reporter: ['text', 'json', 'html'],
      exclude: [
        '**/node_modules/**',
        '**/dist/**',
        '**/*.config.*',
        '**/*.d.ts',
      ],
    },
  },
})

package.json の scripts に追加:

{
  "scripts": {
    "test": "vitest",
    "test:coverage": "vitest --coverage"
  }
}

Jest セットアップ:

npm install -D jest @types/jest ts-jest
npx ts-jest config:init
npm install -D jest @testing-library/react @testing-library/jest-dom jest-environment-jsdom

jest.config.ts を作成:

export default {
  testEnvironment: 'jsdom',
  transform: {
    '^.+\\.tsx?$': 'ts-jest',
  },
  coverageReporters: ['text', 'json', 'html'],
  collectCoverageFrom: ['src/**/*.{ts,tsx}', '!src/**/*.d.ts'],
}

package.json の scripts に追加:

{
  "scripts": {
    "test": "jest",
    "test:coverage": "jest --coverage"
  }
}

react-scripts セットアップ:

npm install -D @testing-library/react @testing-library/jest-dom @testing-library/user-event

カバレッジはビルトイン:

{
  "scripts": {
    "test": "react-scripts test",
    "test:coverage": "react-scripts test --coverage"
  }
}

セットアップ後、テストを実行してすべてが正常に動作することを確認:

npm test

失敗した場合、設定の問題を修正してから次に進みます。

フェーズ4: テスト未作成のソースファイルにテストを作成

テストファイルがない各ソースファイルについて、ソースコードを分析:

  1. ソースファイルを読み取る
  2. 以下を特定:
    • エクスポートされたすべての関数、クラス、コンポーネント
    • 戻り値の型と可能な戻りパス
    • パラメーターとその型(必須、オプション、デフォルト値)
    • Props インターフェース(React コンポーネントの場合)
    • 非同期動作(Promises、async/await)
    • 副作用(API 呼び出し、localStorage など)
    • エラー状態とエッジケース
  3. プロジェクトの規約に従ってテストファイルを生成:
    • 検出されたテストランナーのAPIを使用(Jest/Vitest では describe/it/expect など)
    • React の場合: @testing-library/reactを使用(render、screen、fireEvent)
    • 外部依存関係をモック
    • すべての分岐、エッジケース、エラーパスをカバー

React コンポーネントの例 (src/components/Button.tsx → src/components/Button.test.tsx):

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

describe('Button', () => {
  it('ラベル付きでレンダリングされる', () => {
    render(<Button label="クリックして" />)
    expect(screen.getByText('クリックして')).toBeInTheDocument()
  })

  it('クリック時に onClick が呼ばれる', () => {
    const onClick = vi.fn() // Jest の場合は jest.fn()
    render(<Button label="クリック" onClick={onClick} />)
    fireEvent.click(screen.getByText('クリック'))
    expect(onClick).toHaveBeenCalledTimes(1)
  })

  it('disabled プロップが true の場合、無効になる', () => {
    render(<Button label="クリック" disabled />)
    expect(screen.getByText('クリック')).toBeDisabled()
  })
})

ユーティリティ関数の例 (src/utils/format.ts → src/utils/format.test.ts):

import { formatCurrency, truncate } from './format'

describe('formatCurrency', () => {
  it('整数の金額をフォーマットする', () => {
    expect(formatCurrency(1000)).toBe('$1,000.00')
  })

  it('小数の金額をフォーマットする', () => {
    expect(formatCurrency(99.95)).toBe('$99.95')
  })

  it('ゼロを処理する', () => {
    expect(formatCurrency(0)).toBe('$0.00')
  })

  it('負の値を処理する', () => {
    expect(formatCurrency(-50)).toBe('-$50.00')
  })
})

フェーズ5: カバレッジレポートの実行

検出されたランナーに基づいて適切なカバレッジコマンドを実行:

ランナーコマンド
Vitestnpx vitest --coverage --reporter=verbose
Jestnpx jest --coverage --verbose
react-scriptsnpx react-scripts test --coverage --watchAll=false
その他プロジェクトで設定されたカバレッジコマンドを使用

出力を解析して以下を特定:

  • 100%未満のファイル
  • カバーされていない行、分岐、関数、ステートメント
  • テストが必要な特定の行番号
  • 0%カバレッジのファイル(テストが存在しない)

フェーズ6: カバレッジギャップの分析と補填

100%未満のファイルごと(フェーズ4でテストが作成されたが100%になっていないファイルを含む):

  1. ソースファイルとそのテストファイルを並べて読み取る
  2. カバーされていない行/関数/分岐が何を行うかを理解する
  3. テストで不足しているエッジケースを特定する
  4. ギャップをカバーするためのターゲットテストを作成:
  • カバーされていない分岐: if と else の両方のパス、三項演算子の条件をテスト
  • カバーされていない関数: すべての可能な戻りパスをテスト
  • カバーされていない行: ロジックを追跡し、それらに到達するケースを作成
  • カバーされていない非同期パス: 解決された Promise と拒否された Promise の両方の分岐をテスト
  • カバーされていないエラー処理: エラーコールバック、catch ブロック、エラーバウンダリーをテスト

検出されたテストランナーのパターンを使用:

  • Vitest: vi.mock()、vi.spyOn()、vi.fn()
  • Jest: jest.mock()、jest.spyOn()、jest.fn()
  • react-scripts: Jest と同じ

フェーズ7: 検証

テストの追加/更新後にカバレッジを再実行:

# 検出されたコマンドを使用
npx vitest --coverage   # Vitest の場合
npx jest --coverage      # Jest の場合

すべてのファイルでステートメント、分岐、関数、行が100%になっていることを確認。

フェーズ8: 繰り返し

カバレッジがまだ100%未満の場合、フェーズ6にループバック。


ランナー別設定

Vitest カバレッジ設定

vitest.config.ts を確認:

import { defineConfig } from 'vitest/config'

export default defineConfig({
  test: {
    coverage: {
      provider: 'v8',
      reporter: ['text', 'json', 'html'],
      exclude: [
        '**/node_modules/**',
        '**/dist/**',
        '**/*.config.*',
        '**/*.d.ts',
      ],
    },
  },
})

Jest カバレッジ設定

jest.config.ts に以下が含まれていることを確認:

export default {
  collectCoverage: true,
  coverageReporters: ['text', 'json', 'html'],
  collectCoverageFrom: [
    'src/**/*.{ts,tsx,js,jsx}',
    '!src/**/*.d.ts',
    '!src/**/*.test.*',
    '!src/**/*.spec.*',
  ],
}

ヒント

  • 既存のテストがあってもカバレッジが低いファイルから始める — 最も早く改善される
  • 次に、最も単純なロジックのテスト未作成ファイルに取り組む
  • React コンポーネントの場合: レンダリング、ユーザー操作、条件付きレンダリング、エラー状態、空/ローディング状態をテスト
  • ユーティリティ関数の場合: エッジケース(空文字列、null/undefined、境界値、特殊文字)をテスト
  • API サービスの場合: 成功応答、エラー応答、ローディング状態、タイムアウト、ネットワーク障害をテスト
  • デッドコードが見つかった場合(カバー不可能): 削除を提案するか、カバレッジ無視コメントを追加:
    • Vitest/V8: /* c8 ignore next */ または /* c8 ignore next 3 */
    • Jest/Istanbul: /* istanbul ignore next */ または /* istanbul ignore if */
  • ソースコードのロジックは変更しない — テストのみを追加または更新する
  • プロジェクトの既存のテストパターン(ファイル命名、フォルダ構造、モックスタイル)に従う
  • テストが0のファイルの場合、最初に主要なパスすべてをカバーする包括的なテストファイルを作成し、その後反復する

検出優先順位

ソースファイルをスキャンする際、以下の一般的なディレクトリ構造の順序でチェック:

  1. src/
  2. app/ (Next.js app ディレクトリ)
  3. components/
  4. lib/
  5. utils/
  6. server/ (Next.js/Node.js)
  7. pages/ (Next.js pages ディレクトリ)
  8. ルートレベルの *.ts / *.tsx ファイル

例

ユーザー: "カバレッジレポートで login.ts が72%と表示される、修正して"

エージェントのアクション:

  1. npx vitest --coverage --reporter=verbose を実行し、login.ts の45-52行がカバーされていないことを確認(validateEmail のエラー分岐)
  2. ソースを読み取り、validateEmail が無効なメールアドレスで例外をスローすることを理解
  3. login.test.ts に無効なメール入力のテストケースを追加
  4. カバレッジを再実行 — login.ts が100%になる

ユーザー: "jest を使っている、カバレッジをチェックして"

  1. npx jest --coverage --verbose を実行し、カバーされていないファイルを特定
  2. src/components/Header.tsx が0%であることを発見 — テストが存在しない
  3. Header.tsx のソースを読み取り、src/components/Header.test.tsx を作成
  4. カバレッジを再実行 — Header.tsx が100%になる

ユーザー: "このプロジェクトにはテスト設定がない、カバレッジを追加して"

  1. package.json にテストランナーが検出されないことを確認
  2. ユーザーに確認: "テストフレームワークが検出されませんでした。Vitest をインストールしますか?(推奨)"
  3. ユーザーが確認 → vitest + @vitest/coverage-v8 をインストール、vitest.config.ts を作成
  4. src/ をスキャンし、8個のソースファイル、0個のテストファイルを発見
  5. 8個すべてのファイルにテストを作成
  6. カバレッジを実行 — すべて100%

関連スキル