ai-devkit 0.2.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (56) hide show
  1. package/CHANGELOG.md +49 -0
  2. package/README.md +364 -0
  3. package/dist/cli.d.ts +3 -0
  4. package/dist/cli.d.ts.map +1 -0
  5. package/dist/cli.js +24 -0
  6. package/dist/cli.js.map +1 -0
  7. package/dist/commands/init.d.ts +9 -0
  8. package/dist/commands/init.d.ts.map +1 -0
  9. package/dist/commands/init.js +162 -0
  10. package/dist/commands/init.js.map +1 -0
  11. package/dist/commands/phase.d.ts +2 -0
  12. package/dist/commands/phase.d.ts.map +1 -0
  13. package/dist/commands/phase.js +83 -0
  14. package/dist/commands/phase.js.map +1 -0
  15. package/dist/index.d.ts +4 -0
  16. package/dist/index.d.ts.map +1 -0
  17. package/dist/index.js +23 -0
  18. package/dist/index.js.map +1 -0
  19. package/dist/lib/Config.d.ts +12 -0
  20. package/dist/lib/Config.d.ts.map +1 -0
  21. package/dist/lib/Config.js +94 -0
  22. package/dist/lib/Config.js.map +1 -0
  23. package/dist/lib/TemplateManager.d.ts +13 -0
  24. package/dist/lib/TemplateManager.d.ts.map +1 -0
  25. package/dist/lib/TemplateManager.js +129 -0
  26. package/dist/lib/TemplateManager.js.map +1 -0
  27. package/dist/types.d.ts +17 -0
  28. package/dist/types.d.ts.map +1 -0
  29. package/dist/types.js +22 -0
  30. package/dist/types.js.map +1 -0
  31. package/package.json +46 -0
  32. package/templates/env/claude/CLAUDE.md +52 -0
  33. package/templates/env/claude/commands/check-implementation.md +21 -0
  34. package/templates/env/claude/commands/code-review.md +81 -0
  35. package/templates/env/claude/commands/execute-plan.md +71 -0
  36. package/templates/env/claude/commands/new-requirement.md +127 -0
  37. package/templates/env/claude/commands/review-design.md +11 -0
  38. package/templates/env/claude/commands/review-requirements.md +9 -0
  39. package/templates/env/claude/commands/update-planning.md +61 -0
  40. package/templates/env/claude/commands/writing-test.md +44 -0
  41. package/templates/env/cursor/commands/check-implementation.md +21 -0
  42. package/templates/env/cursor/commands/code-review.md +81 -0
  43. package/templates/env/cursor/commands/execute-plan.md +71 -0
  44. package/templates/env/cursor/commands/new-requirement.md +127 -0
  45. package/templates/env/cursor/commands/review-design.md +11 -0
  46. package/templates/env/cursor/commands/review-requirements.md +9 -0
  47. package/templates/env/cursor/commands/update-planning.md +61 -0
  48. package/templates/env/cursor/commands/writing-test.md +44 -0
  49. package/templates/env/cursor/rules/ai-devkit.md +51 -0
  50. package/templates/phases/deployment.md +72 -0
  51. package/templates/phases/design.md +60 -0
  52. package/templates/phases/implementation.md +65 -0
  53. package/templates/phases/monitoring.md +80 -0
  54. package/templates/phases/planning.md +60 -0
  55. package/templates/phases/requirements.md +51 -0
  56. package/templates/phases/testing.md +81 -0
@@ -0,0 +1,61 @@
1
+ # Planning Update Assistant
2
+
3
+ Please help me reconcile the current implementation progress with our planning documentation.
4
+
5
+ ## Step 1: Gather Context
6
+ Ask me for:
7
+ - Feature/branch name and brief status
8
+ - Tasks completed since last update
9
+ - Any new tasks discovered
10
+ - Current blockers or risks
11
+ - Relevant planning docs (e.g., `docs/ai/planning/feature-{name}.md`)
12
+
13
+ ## Step 2: Review Planning Doc
14
+ If a planning doc exists:
15
+ - Summarize existing milestones and task breakdowns
16
+ - Note expected sequencing and dependencies
17
+ - Identify outstanding tasks in the plan
18
+
19
+ ## Step 3: Reconcile Progress
20
+ For each planned task:
21
+ - Mark status (done / in progress / blocked / not started)
22
+ - Note actual work completed vs. planned scope
23
+ - Record blockers or changes in approach
24
+ - Identify tasks that were skipped or added
25
+
26
+ ## Step 4: Update Task List
27
+ Help me produce an updated checklist such as:
28
+ ```
29
+ ### Current Status: [Feature Name]
30
+
31
+ #### Done
32
+ - [x] Task A - short note on completion or link to commit/pr
33
+ - [x] Task B
34
+
35
+ #### In Progress
36
+ - [ ] Task C - waiting on [dependency]
37
+
38
+ #### Blocked
39
+ - [ ] Task D - blocked by [issue/owner]
40
+
41
+ #### Newly Discovered Work
42
+ - [ ] Task E - reason discovered
43
+ - [ ] Task F - due by [date]
44
+ ```
45
+
46
+ ## Step 5: Next Steps & Priorities
47
+ - Suggest the next 2-3 actionable tasks
48
+ - Highlight risky areas needing attention
49
+ - Recommend coordination (design changes, stakeholder sync, etc.)
50
+ - List documentation updates needed
51
+
52
+ ## Step 6: Summary for Planning Doc
53
+ Prepare a summary paragraph to copy into the planning doc, covering:
54
+ - Current state and progress
55
+ - Major risks/blockers
56
+ - Upcoming focus items
57
+ - Any changes to scope or timeline
58
+
59
+ ---
60
+ Let me know when you're ready to begin the planning update.
61
+
@@ -0,0 +1,44 @@
1
+ Review `docs/ai/testing/feature-{name}.md` and ensure it mirrors the base template before writing tests.
2
+
3
+ ## Step 1: Gather Context
4
+ Ask me for:
5
+ - Feature name and branch
6
+ - Summary of what changed (link to design & requirements docs)
7
+ - Target environment (backend, frontend, full-stack)
8
+ - Existing automated test suites (unit, integration, E2E)
9
+ - Any flaky or slow tests to avoid
10
+
11
+ ## Step 2: Analyze Testing Template
12
+ - Identify required sections from `docs/ai/testing/feature-{name}.md` (unit, integration, manual verification, coverage targets)
13
+ - Confirm success criteria and edge cases from requirements & design docs
14
+ - Note any mocks/stubs or fixtures already available
15
+
16
+ ## Step 3: Unit Tests (Aim for 100% coverage)
17
+ For each module/function:
18
+ 1. List behavior scenarios (happy path, edge cases, error handling)
19
+ 2. Generate concrete test cases with assertions and inputs
20
+ 3. Reference existing utilities/mocks to accelerate implementation
21
+ 4. Provide pseudocode or actual test snippets
22
+ 5. Highlight potential missing branches preventing full coverage
23
+
24
+ ## Step 4: Integration Tests
25
+ 1. Identify critical flows that span multiple components/services
26
+ 2. Define setup/teardown steps (databases, APIs, queues)
27
+ 3. Outline test cases validating interaction boundaries, data contracts, and failure modes
28
+ 4. Suggest instrumentation/logging to debug failures
29
+
30
+ ## Step 5: Coverage Strategy
31
+ - Recommend tooling commands (e.g., `npm run test -- --coverage`)
32
+ - Call out files/functions that still need coverage and why
33
+ - Suggest additional tests if coverage <100%
34
+
35
+ ## Step 6: Manual & Exploratory Testing
36
+ - Propose manual test checklist covering UX, accessibility, and error handling
37
+ - Identify exploratory scenarios or chaos/failure injection tests if relevant
38
+
39
+ ## Step 7: Update Documentation & TODOs
40
+ - Summarize which tests were added or still missing
41
+ - Update `docs/ai/testing/feature-{name}.md` sections with links to test files and results
42
+ - Flag follow-up tasks for deferred tests (with owners/dates)
43
+
44
+ Let me know when you have the latest code changes ready; we'll write tests together until we hit 100% coverage.
@@ -0,0 +1,51 @@
1
+ # AI DevKit Rules
2
+
3
+ ## Project Context
4
+ This project uses ai-devkit for structured AI-assisted development. Phase documentation is located in `docs/ai/`.
5
+
6
+ ## Documentation Structure
7
+ - `docs/ai/requirements/` - Problem understanding and requirements
8
+ - `docs/ai/design/` - System architecture and design decisions (include mermaid diagrams)
9
+ - `docs/ai/planning/` - Task breakdown and project planning
10
+ - `docs/ai/implementation/` - Implementation guides and notes
11
+ - `docs/ai/testing/` - Testing strategy and test cases
12
+ - `docs/ai/deployment/` - Deployment and infrastructure docs
13
+ - `docs/ai/monitoring/` - Monitoring and observability setup
14
+
15
+ ## Code Style & Standards
16
+ - Follow the project's established code style and conventions
17
+ - Write clear, self-documenting code with meaningful variable names
18
+ - Add comments for complex logic or non-obvious decisions
19
+
20
+ ## Development Workflow
21
+ - Review phase documentation in `docs/ai/` before implementing features
22
+ - Keep requirements, design, and implementation docs updated as the project evolves
23
+ - Reference the planning doc for task breakdown and priorities
24
+ - Copy the testing template (`docs/ai/testing/README.md`) before creating feature-specific testing docs
25
+
26
+ ## AI Interaction Guidelines
27
+ - When implementing features, first check relevant phase documentation
28
+ - For new features, start with requirements clarification
29
+ - Update phase docs when significant changes or decisions are made
30
+
31
+ ## Testing & Quality
32
+ - Write tests alongside implementation
33
+ - Follow the testing strategy defined in `docs/ai/testing/`
34
+ - Use `/writing-test` to generate unit and integration tests targeting 100% coverage
35
+ - Ensure code passes all tests before considering it complete
36
+
37
+ ## Documentation
38
+ - Update phase documentation when requirements or design changes
39
+ - Keep inline code comments focused and relevant
40
+ - Document architectural decisions and their rationale
41
+ - Use mermaid diagrams for any architectural or data-flow visuals (update existing diagrams if needed)
42
+ - Record test coverage results and outstanding gaps in `docs/ai/testing/`
43
+
44
+ ## Key Commands
45
+ When working on this project, you can run commands to:
46
+ - Understand project requirements and goals (`review-requirements`)
47
+ - Review architectural decisions (`review-design`)
48
+ - Plan and execute tasks (`execute-plan`)
49
+ - Verify implementation against design (`check-implementation`)
50
+ - Suggest missing tests (`suggest-tests`)
51
+ - Perform structured code reviews (`code-review`)
@@ -0,0 +1,72 @@
1
+ ---
2
+ phase: deployment
3
+ title: Deployment Strategy
4
+ description: Define deployment process, infrastructure, and release procedures
5
+ ---
6
+
7
+ # Deployment Strategy
8
+
9
+ ## Infrastructure
10
+ **Where will the application run?**
11
+
12
+ - Hosting platform (AWS, GCP, Azure, etc.)
13
+ - Infrastructure components (servers, databases, etc.)
14
+ - Environment separation (dev, staging, production)
15
+
16
+ ## Deployment Pipeline
17
+ **How do we deploy changes?**
18
+
19
+ ### Build Process
20
+ - Build steps and commands
21
+ - Asset compilation/optimization
22
+ - Environment configuration
23
+
24
+ ### CI/CD Pipeline
25
+ - Automated testing gates
26
+ - Build automation
27
+ - Deployment automation
28
+
29
+ ## Environment Configuration
30
+ **What settings differ per environment?**
31
+
32
+ ### Development
33
+ - Configuration details
34
+ - Local setup
35
+
36
+ ### Staging
37
+ - Configuration details
38
+ - Testing environment
39
+
40
+ ### Production
41
+ - Configuration details
42
+ - Monitoring setup
43
+
44
+ ## Deployment Steps
45
+ **What's the release process?**
46
+
47
+ 1. Pre-deployment checklist
48
+ 2. Deployment execution steps
49
+ 3. Post-deployment validation
50
+ 4. Rollback procedure (if needed)
51
+
52
+ ## Database Migrations
53
+ **How do we handle schema changes?**
54
+
55
+ - Migration strategy
56
+ - Backup procedures
57
+ - Rollback approach
58
+
59
+ ## Secrets Management
60
+ **How do we handle sensitive data?**
61
+
62
+ - Environment variables
63
+ - Secret storage solution
64
+ - Key rotation strategy
65
+
66
+ ## Rollback Plan
67
+ **What if something goes wrong?**
68
+
69
+ - Rollback triggers
70
+ - Rollback steps
71
+ - Communication plan
72
+
@@ -0,0 +1,60 @@
1
+ ---
2
+ phase: design
3
+ title: System Design & Architecture
4
+ description: Define the technical architecture, components, and data models
5
+ ---
6
+
7
+ # System Design & Architecture
8
+
9
+ ## Architecture Overview
10
+ **What is the high-level system structure?**
11
+
12
+ - Include a mermaid diagram that captures the main components and their relationships. Example:
13
+ ```mermaid
14
+ graph TD
15
+ Client -->|HTTPS| API
16
+ API --> ServiceA
17
+ API --> ServiceB
18
+ ServiceA --> Database[(DB)]
19
+ ```
20
+ - Key components and their responsibilities
21
+ - Technology stack choices and rationale
22
+
23
+ ## Data Models
24
+ **What data do we need to manage?**
25
+
26
+ - Core entities and their relationships
27
+ - Data schemas/structures
28
+ - Data flow between components
29
+
30
+ ## API Design
31
+ **How do components communicate?**
32
+
33
+ - External APIs (if applicable)
34
+ - Internal interfaces
35
+ - Request/response formats
36
+ - Authentication/authorization approach
37
+
38
+ ## Component Breakdown
39
+ **What are the major building blocks?**
40
+
41
+ - Frontend components (if applicable)
42
+ - Backend services/modules
43
+ - Database/storage layer
44
+ - Third-party integrations
45
+
46
+ ## Design Decisions
47
+ **Why did we choose this approach?**
48
+
49
+ - Key architectural decisions and trade-offs
50
+ - Alternatives considered
51
+ - Patterns and principles applied
52
+
53
+ ## Non-Functional Requirements
54
+ **How should the system perform?**
55
+
56
+ - Performance targets
57
+ - Scalability considerations
58
+ - Security requirements
59
+ - Reliability/availability needs
60
+
@@ -0,0 +1,65 @@
1
+ ---
2
+ phase: implementation
3
+ title: Implementation Guide
4
+ description: Technical implementation notes, patterns, and code guidelines
5
+ ---
6
+
7
+ # Implementation Guide
8
+
9
+ ## Development Setup
10
+ **How do we get started?**
11
+
12
+ - Prerequisites and dependencies
13
+ - Environment setup steps
14
+ - Configuration needed
15
+
16
+ ## Code Structure
17
+ **How is the code organized?**
18
+
19
+ - Directory structure
20
+ - Module organization
21
+ - Naming conventions
22
+
23
+ ## Implementation Notes
24
+ **Key technical details to remember:**
25
+
26
+ ### Core Features
27
+ - Feature 1: Implementation approach
28
+ - Feature 2: Implementation approach
29
+ - Feature 3: Implementation approach
30
+
31
+ ### Patterns & Best Practices
32
+ - Design patterns being used
33
+ - Code style guidelines
34
+ - Common utilities/helpers
35
+
36
+ ## Integration Points
37
+ **How do pieces connect?**
38
+
39
+ - API integration details
40
+ - Database connections
41
+ - Third-party service setup
42
+
43
+ ## Error Handling
44
+ **How do we handle failures?**
45
+
46
+ - Error handling strategy
47
+ - Logging approach
48
+ - Retry/fallback mechanisms
49
+
50
+ ## Performance Considerations
51
+ **How do we keep it fast?**
52
+
53
+ - Optimization strategies
54
+ - Caching approach
55
+ - Query optimization
56
+ - Resource management
57
+
58
+ ## Security Notes
59
+ **What security measures are in place?**
60
+
61
+ - Authentication/authorization
62
+ - Input validation
63
+ - Data encryption
64
+ - Secrets management
65
+
@@ -0,0 +1,80 @@
1
+ ---
2
+ phase: monitoring
3
+ title: Monitoring & Observability
4
+ description: Define monitoring strategy, metrics, alerts, and incident response
5
+ ---
6
+
7
+ # Monitoring & Observability
8
+
9
+ ## Key Metrics
10
+ **What do we need to track?**
11
+
12
+ ### Performance Metrics
13
+ - Response time/latency
14
+ - Throughput/requests per second
15
+ - Resource utilization (CPU, memory, disk)
16
+
17
+ ### Business Metrics
18
+ - User engagement metrics
19
+ - Conversion/success rates
20
+ - Feature usage
21
+
22
+ ### Error Metrics
23
+ - Error rates by type
24
+ - Failed requests
25
+ - Exception tracking
26
+
27
+ ## Monitoring Tools
28
+ **What tools are we using?**
29
+
30
+ - Application monitoring (APM)
31
+ - Infrastructure monitoring
32
+ - Log aggregation
33
+ - User analytics
34
+
35
+ ## Logging Strategy
36
+ **What do we log and how?**
37
+
38
+ - Log levels and categories
39
+ - Structured logging format
40
+ - Log retention policy
41
+ - Sensitive data handling
42
+
43
+ ## Alerts & Notifications
44
+ **When and how do we get notified?**
45
+
46
+ ### Critical Alerts
47
+ - Alert 1: [Condition] → [Action]
48
+ - Alert 2: [Condition] → [Action]
49
+
50
+ ### Warning Alerts
51
+ - Alert 1: [Condition] → [Action]
52
+ - Alert 2: [Condition] → [Action]
53
+
54
+ ## Dashboards
55
+ **What do we visualize?**
56
+
57
+ - System health dashboard
58
+ - Business metrics dashboard
59
+ - Custom views per team/role
60
+
61
+ ## Incident Response
62
+ **How do we handle issues?**
63
+
64
+ ### On-Call Rotation
65
+ - Schedule and contacts
66
+ - Escalation path
67
+
68
+ ### Incident Process
69
+ 1. Detection and triage
70
+ 2. Investigation and diagnosis
71
+ 3. Resolution and mitigation
72
+ 4. Post-mortem and learning
73
+
74
+ ## Health Checks
75
+ **How do we verify system health?**
76
+
77
+ - Endpoint health checks
78
+ - Dependency checks
79
+ - Automated smoke tests
80
+
@@ -0,0 +1,60 @@
1
+ ---
2
+ phase: planning
3
+ title: Project Planning & Task Breakdown
4
+ description: Break down work into actionable tasks and estimate timeline
5
+ ---
6
+
7
+ # Project Planning & Task Breakdown
8
+
9
+ ## Milestones
10
+ **What are the major checkpoints?**
11
+
12
+ - [ ] Milestone 1: [Description]
13
+ - [ ] Milestone 2: [Description]
14
+ - [ ] Milestone 3: [Description]
15
+
16
+ ## Task Breakdown
17
+ **What specific work needs to be done?**
18
+
19
+ ### Phase 1: Foundation
20
+ - [ ] Task 1.1: [Description]
21
+ - [ ] Task 1.2: [Description]
22
+
23
+ ### Phase 2: Core Features
24
+ - [ ] Task 2.1: [Description]
25
+ - [ ] Task 2.2: [Description]
26
+
27
+ ### Phase 3: Integration & Polish
28
+ - [ ] Task 3.1: [Description]
29
+ - [ ] Task 3.2: [Description]
30
+
31
+ ## Dependencies
32
+ **What needs to happen in what order?**
33
+
34
+ - Task dependencies and blockers
35
+ - External dependencies (APIs, services, etc.)
36
+ - Team/resource dependencies
37
+
38
+ ## Timeline & Estimates
39
+ **When will things be done?**
40
+
41
+ - Estimated effort per task/phase
42
+ - Target dates for milestones
43
+ - Buffer for unknowns
44
+
45
+ ## Risks & Mitigation
46
+ **What could go wrong?**
47
+
48
+ - Technical risks
49
+ - Resource risks
50
+ - Dependency risks
51
+ - Mitigation strategies
52
+
53
+ ## Resources Needed
54
+ **What do we need to succeed?**
55
+
56
+ - Team members and roles
57
+ - Tools and services
58
+ - Infrastructure
59
+ - Documentation/knowledge
60
+
@@ -0,0 +1,51 @@
1
+ ---
2
+ phase: requirements
3
+ title: Requirements & Problem Understanding
4
+ description: Clarify the problem space, gather requirements, and define success criteria
5
+ ---
6
+
7
+ # Requirements & Problem Understanding
8
+
9
+ ## Problem Statement
10
+ **What problem are we solving?**
11
+
12
+ - Describe the core problem or pain point
13
+ - Who is affected by this problem?
14
+ - What is the current situation/workaround?
15
+
16
+ ## Goals & Objectives
17
+ **What do we want to achieve?**
18
+
19
+ - Primary goals
20
+ - Secondary goals
21
+ - Non-goals (what's explicitly out of scope)
22
+
23
+ ## User Stories & Use Cases
24
+ **How will users interact with the solution?**
25
+
26
+ - As a [user type], I want to [action] so that [benefit]
27
+ - Key workflows and scenarios
28
+ - Edge cases to consider
29
+
30
+ ## Success Criteria
31
+ **How will we know when we're done?**
32
+
33
+ - Measurable outcomes
34
+ - Acceptance criteria
35
+ - Performance benchmarks (if applicable)
36
+
37
+ ## Constraints & Assumptions
38
+ **What limitations do we need to work within?**
39
+
40
+ - Technical constraints
41
+ - Business constraints
42
+ - Time/budget constraints
43
+ - Assumptions we're making
44
+
45
+ ## Questions & Open Items
46
+ **What do we still need to clarify?**
47
+
48
+ - Unresolved questions
49
+ - Items requiring stakeholder input
50
+ - Research needed
51
+
@@ -0,0 +1,81 @@
1
+ ---
2
+ phase: testing
3
+ title: Testing Strategy
4
+ description: Define testing approach, test cases, and quality assurance
5
+ ---
6
+
7
+ # Testing Strategy
8
+
9
+ ## Test Coverage Goals
10
+ **What level of testing do we aim for?**
11
+
12
+ - Unit test coverage target (default: 100% of new/changed code)
13
+ - Integration test scope (critical paths + error handling)
14
+ - End-to-end test scenarios (key user journeys)
15
+ - Alignment with requirements/design acceptance criteria
16
+
17
+ ## Unit Tests
18
+ **What individual components need testing?**
19
+
20
+ ### Component/Module 1
21
+ - [ ] Test case 1: [Description] (covers scenario / branch)
22
+ - [ ] Test case 2: [Description] (covers edge case / error handling)
23
+ - [ ] Additional coverage: [Description]
24
+
25
+ ### Component/Module 2
26
+ - [ ] Test case 1: [Description]
27
+ - [ ] Test case 2: [Description]
28
+ - [ ] Additional coverage: [Description]
29
+
30
+ ## Integration Tests
31
+ **How do we test component interactions?**
32
+
33
+ - [ ] Integration scenario 1
34
+ - [ ] Integration scenario 2
35
+ - [ ] API endpoint tests
36
+ - [ ] Integration scenario 3 (failure mode / rollback)
37
+
38
+ ## End-to-End Tests
39
+ **What user flows need validation?**
40
+
41
+ - [ ] User flow 1: [Description]
42
+ - [ ] User flow 2: [Description]
43
+ - [ ] Critical path testing
44
+ - [ ] Regression of adjacent features
45
+
46
+ ## Test Data
47
+ **What data do we use for testing?**
48
+
49
+ - Test fixtures and mocks
50
+ - Seed data requirements
51
+ - Test database setup
52
+
53
+ ## Test Reporting & Coverage
54
+ **How do we verify and communicate test results?**
55
+
56
+ - Coverage commands and thresholds (`npm run test -- --coverage`)
57
+ - Coverage gaps (files/functions below 100% and rationale)
58
+ - Links to test reports or dashboards
59
+ - Manual testing outcomes and sign-off
60
+
61
+ ## Manual Testing
62
+ **What requires human validation?**
63
+
64
+ - UI/UX testing checklist (include accessibility)
65
+ - Browser/device compatibility
66
+ - Smoke tests after deployment
67
+
68
+ ## Performance Testing
69
+ **How do we validate performance?**
70
+
71
+ - Load testing scenarios
72
+ - Stress testing approach
73
+ - Performance benchmarks
74
+
75
+ ## Bug Tracking
76
+ **How do we manage issues?**
77
+
78
+ - Issue tracking process
79
+ - Bug severity levels
80
+ - Regression testing strategy
81
+