🌍 Language / 言語: English | 日本語 | Documentation / ドキュメント
AI-Agent Enabled Framework for Test-Driven Development with 6-Phase Automation
Minimal human intervention, maximum specification compliance. Intent → Formal → Tests → Code → Verify → Operate with TDD enforcement.
- Complete Claude Code Integration: All 6 phases automated through Task Tool adapters
- TDD Enforcement: Automatic Test-Driven Development compliance
- OpenTelemetry Monitoring: Real-time quality and performance metrics
- Phase 6 UI Generation: React + Next.js components in <30 seconds
- Bilingual Support: Japanese/English documentation and UI
ae-framework provides complete 6-phase automation in Claude Code environment without additional configuration:
Phase 1: Intent Analysis 🎯
User: Please analyze the project requirements
Claude Code: Executing Intent Task Adapter for requirement analysis...
✅ Intent Analysis Complete - 12 requirements identified
📋 Next steps:
• Proceed to Phase 2 (Natural Language Requirements)
Phase 6: UI/UX & Frontend Delivery 🎨
User: Generate UI components
Claude Code: Executing UI Task Adapter for component generation...
📊 OpenTelemetry initialized for ae-framework Phase 6
✅ Generated 21 files for 3/3 entities
📊 Test Coverage: 100% (threshold: 80%)
♿ A11y Score: 96% (threshold: 95%) ✅
⚡ Performance Score: 78% (threshold: 75%) ✅
- Intent Analysis: Extract requirements from natural language
- Natural Language Requirements: Structure and validate requirements
- User Stories Creation: Generate user stories and acceptance criteria
- Validation: Cross-validate requirements, stories, and specifications
- Domain Modeling: Create domain-driven design models
- UI/UX & Frontend Delivery: Generate React components with testing
# Install framework
npm install ae-framework
# Initialize project with TDD
ae-framework init my-project --tdd
# Generate complete feature
ae-framework feature "User Authentication"
ae-framework generate:tests # RED phase
ae-framework generate:code # GREEN phase
ae-framework verify # Quality verification
ae-framework ui-scaffold --components # UI generation
- React + Next.js: Modern component generation
- Design System: Radix UI + Tailwind CSS + Design Tokens
- Accessibility: WCAG 2.1 AA compliance (96% score)
- Testing: Playwright E2E + Storybook + Vitest
- i18n: Multi-language support (ja/en)
- OpenTelemetry: Real-time quality monitoring
- ✅ Test Coverage: ≥80%
- ✅ A11y Score: ≥95% (WCAG 2.1 AA)
- ✅ Performance Score: ≥75% (Lighthouse CI)
- ✅ TypeScript: Zero type errors, strict mode
- ✅ ESLint: Zero syntax errors
We welcome international contributions! Please see our Contributing Guide.
TDD強制機能付き6フェーズ自動化のAIエージェント対応フレームワーク
人手最小&仕様準拠最大。Intent→Formal→Tests→Code→Verify→Operate の6フェーズ。
- 🆕 🧪 Phase 2.3: Integration Testing System - 包括的統合テストとE2Eテストオーケストレーション
- 🆕 🛡️ Phase 2.2: Runtime Conformance System - リアルタイム適合性検証とCEGIS連携
- 🔧 Phase 2.1: CEGIS Auto-Fix System - 反例誘導帰納合成による自動コード修復
- 🎨 Phase 6 UI/UX & Frontend Delivery完全実装 - React + Next.js UI自動生成とOpenTelemetryテレメトリ
- 🚀 Phase 2-5 Claude Code Task Tool統合 - 全フェーズの完全自動化を実現
ae-framework は Claude Code 環境で全6フェーズを自動統合。追加設定なしで利用可能:
Phase 1: Intent Analysis 🎯
User: プロジェクトの要件分析をお願いします
Claude Code: Intent Task Adapterを使用して要件分析を実行します...
✅ Intent Analysis Complete - 12 requirements identified
📋 Next steps:
• Proceed to Phase 2 (Natural Language Requirements)
Phase 6: UI/UX & Frontend Delivery 🎨
User: UI コンポーネントを生成してください
Claude Code: UI Task Adapterでコンポーネント生成中...
📊 OpenTelemetry initialized for ae-framework Phase 6
✅ Generated 21 files for 3/3 entities
📊 Test Coverage: 100% (threshold: 80%)
♿ A11y Score: 96% (threshold: 95%) ✅
⚡ Performance Score: 78% (threshold: 75%) ✅
# Phase 1: Intent分析
ae-framework intent --analyze --sources="requirements.md"
# Phase 6: UI/UX & Frontend Delivery
ae-framework ui-scaffold --components
ae-framework ui-scaffold --state
ae-framework ui-scaffold --tokens
ae-framework ui-scaffold --a11y
# ae-ui エイリアス(同等の動作)
ae-ui scaffold --components
ae-ui scaffold --state
ae-ui scaffold --tokens
ae-ui scaffold --a11y
🤖 Test Generation Agent (NEW!) 自動的に包括的なテストを生成する AI エージェント:
- 要件からテスト生成: 自然言語の要件から完全なテストスイートを作成
- コードからテスト逆生成: 既存コードを分析してテストを生成(リバースTDD)
- Property-Based Testing: 数学的性質からプロパティテストを自動設計
- BDD シナリオ生成: ユーザーストーリーから Gherkin シナリオを作成
🛡️ TDD Enforcement Features TDD(Test-Driven Development)原則の遵守を自動的に強制:
- TDD Guard: コードファイルに対応するテストファイルの存在を強制
- Test Execution Guard: コミット前の全テスト通過を確認
- RED-GREEN Cycle Guard: RED→GREEN→REFACTORサイクルの遵守をチェック
- Coverage Guard: 最低カバレッジ(80%)の維持を監視
OpenTelemetryテレメトリ監視 Phase 6ではOpenTelemetryを使用してリアルタイム品質監視を実行:
監視メトリクス:
- 品質メトリクス: テストカバレッジ(≥80%)、A11yスコア(≥95%)、パフォーマンススコア(≥75%)
- 効率性メトリクス: スキャフォールド時間(<30秒)、E2Eテスト時間(<5分)、ビルド時間
- 保守性メトリクス: コンポーネント複雑度(<10)、未使用CSS率(<5%)、デザイントークン使用率(≥95%)
生成されるファイル構成
ae-framework/
├── packages/
│ ├── design-tokens/ # デザイントークン
│ └── ui/ # UIコンポーネントライブラリ
├── apps/
│ ├── web/ # Next.js Webアプリケーション
│ │ ├── app/{entity}/page.tsx # 一覧ページ
│ │ ├── app/{entity}/[id]/page.tsx # 詳細ページ
│ │ ├── messages/ja.json # 日本語翻訳
│ │ ├── messages/en.json # 英語翻訳
│ │ └── __e2e__/{entity}.spec.ts # E2Eテスト
│ └── storybook/ # Storybookドキュメント
└── templates/ui/ # Handlebarsテンプレート
技術仕様:
- Framework: Next.js 14 App Router
- UI Library: Radix UI + Tailwind CSS + shadcn/ui
- Design System: Design Tokens + Class Variance Authority (CVA)
- Forms: React Hook Form + Zod validation
- State: TanStack Query 5 for server state
- Testing: Playwright E2E + Storybook + Vitest
- i18n: next-intl 多言語対応 (ja/en)
- A11y: WCAG 2.1 AA準拠 + eslint-plugin-jsx-a11y
- Telemetry: OpenTelemetry for quality metrics
# Node.js 20+ required
# (optional) Enable Corepack to use bundled pnpm
# corepack enable
pnpm install
# Install Git hooks for TDD enforcement
pnpm run setup-hooks
# Build the framework
pnpm run build
# 1. Initialize a new project with TDD enforcement
ae-framework init my-project --tdd
# 2. Create a feature specification
ae-framework feature "User Authentication"
# 3. Generate tests (Phase 3 - RED)
ae-framework generate:tests
# 4. Generate implementation (Phase 4 - GREEN)
ae-framework generate:code
# 5. Verify quality (Phase 5)
ae-framework verify
# 6. Generate UI Components (Phase 6)
ae-framework ui-scaffold --components
# または
ae-ui scaffold --components
# 7. Deploy (Phase 6)
ae-framework deploy
When using @ts-expect-error
comments, follow this structured format:
// @ts-expect-error owner:@username expires:YYYY-MM-DD reason: detailed description
Required fields:
owner:@username
- GitHub handle responsible for the suppressionexpires:YYYY-MM-DD
- Date when this suppression should be reviewed/removedreason: description
- Detailed explanation (minimum 12 characters)
Examples:
// @ts-expect-error owner:@alice expires:2025-12-31 reason: narrowing todo for complex union
const result = complexUnion as string;
// @ts-expect-error owner:@bob expires:2025-06-15 reason: legacy API compatibility until v2 migration
legacyApi.unsafeMethod(data);
Policy enforcement:
- ✅ CI validates all
@ts-expect-error
comments ⚠️ Local development shows warnings only- 🔍 Script:
node scripts/ci/check-expect-error.mjs
- 🚀 Quick Start Guide - 15分で始めるae-framework / 15-minute ae-framework introduction
- 🎨 Phase 6 Getting Started - UI/UX専用クイックスタート / UI/UX focused quick start
- Setup Guide - 基本セットアップ / Basic setup
- 🎯 Development Instructions Guide - 実際の開発指示方法 / Practical development instruction methods
- 🚀 Claude Code Automation Guide - 要求から実装まで完全自動化 / Complete automation from requirements to implementation
- Usage Guide - 一般的な使い方ガイド / General usage guide
- Phase 2: Natural Language Requirements - 自然言語要件処理 / Natural language requirement processing
- 🆕 Phase 2.1: CEGIS Auto-Fix System - 反例誘導帰納合成による自動コード修復 / Counterexample-guided inductive synthesis for automatic code repair
- 🆕 Phase 2.2: Runtime Conformance System - リアルタイム適合性検証とCEGIS連携 / Real-time conformance verification and CEGIS integration
- 🆕 Phase 2.3: Integration Testing System - 包括的統合テストとE2Eテストオーケストレーション / Comprehensive integration and E2E test orchestration
- Phase 6: UI/UX & Frontend Delivery - React + Next.js UI自動生成 / React + Next.js UI automatic generation
- Claude Code Task Tool Integration - 全フェーズ統合詳細 / Complete phase integration details
- Claude Code Workflow - Claude Codeワークフロー / Claude Code workflow
- CLI Commands Reference - 全コマンドリファレンス / Complete command reference
- API Reference - API仕様 / API specifications
- TDD Framework Architecture - TDDフレームワーク設計 / TDD framework design
- System Architecture - システムアーキテクチャ / System architecture
docs/README.md - 全ドキュメントの体系的ナビゲーションガイド / Systematic documentation navigation guide
We welcome contributions! Please see our Contributing Guide for details. 貢献を歓迎します!詳細はコントリビューションガイドをご覧ください。
MIT License - see LICENSE file for details.
Built with:
- MCP SDK for agent communication
- OpenAI/Anthropic APIs for AI capabilities
- Next.js 14 + React 18 for UI generation
- Radix UI + Tailwind CSS for design system
- OpenTelemetry for telemetry and monitoring
- Vitest for testing framework
- PR:
PR Verify
workflow runsae verify
, replay smoke, uploads artifacts (14d retention). - Nightly:
nightly-monitoring
runs flake(×30) and compares two seeded benches (≤5%) at JST 04:15. - Replay policy: PR=replay by default, main/nightly may record separately if needed.
- Required check: set PR Verify / verify as a required status in branch protection (use
./scripts/setup-branch-protection.sh
). - Slack alerts: verify/nightly failures notify Slack (requires
SLACK_WEBHOOK_URL
secret).
AE_TYPES_STRICT=1
: CI strict mode (failures exit 1),0
for local soft mode (warnings only)AE_LINT_SCOPE
: ESLint scope pattern (default:"src/{providers,commands}/**/*.ts"
)AE_TSC_PROJECT
: TypeScript project config (default:"tsconfig.verify.json"
)AE_EXPECT_ERROR_STRICT=1
: Enable @ts-expect-error policy enforcement (default: enabled)
- Default tolerance: 5% for performance regression detection
- Environment override: Set
BENCH_TOLERANCE
to customize (takes priority over command arguments) - Nightly monitoring: Automated bench comparison with seeded runs for consistency
- Default: 5-10 runs for standard flake detection
- Opt-in extended testing: Add
run-flake
label to PR for 20-30 runs (statistical analysis) - Extended flake tests use
continue-on-error: true
to avoid blocking PR merges
- Generated cassettes (
artifacts/cassettes/
): Never commit (build artifacts, ignore in git) - Fixed cassettes (if needed): Use
cassettes/fixtures/
with mandatory code review - PR policy: New cassettes OK, existing cassette changes require review
- Alternative storage: Consider separate repo or Git LFS for large cassette collections
- Go to repository Settings → Secrets and variables → Actions
- Click New repository secret
- Name:
SLACK_WEBHOOK_URL
, Value: your Slack webhook URL - Save - failures will now trigger Slack notifications
- If secret is not set, notification step is automatically skipped
ae-framework - Automating excellence through AI-driven development 🚀