ai-sprint-kit 1.3.0 → 2.0.0

package/templates/.claude/commands/ai-sprint-docs.md

@@ -1,519 +0,0 @@
----
-description: Generate and update project documentation
-argument-hint: [optional: specific doc type (readme|api|architecture)]
----
-
-## Command: /ai-sprint-docs
-
-Generate comprehensive, up-to-date documentation including README, API docs, architecture diagrams, and inline code comments.
-
-## Usage
-
-```
-/ai-sprint-docs
-/ai-sprint-docs readme
-/ai-sprint-docs api
-/ai-sprint-docs architecture
-```
-
-## Workflow
-
-### 1. Audit Existing Docs
-- Check current documentation
-- Identify outdated sections
-- Find missing documentation
-- List undocumented code
-
-### 2. Generate Documentation
-- README.md (if missing/outdated)
-- API documentation (OpenAPI/GraphQL)
-- Architecture diagrams (Mermaid)
-- Code comments (TSDoc/JSDoc)
-
-### 3. Update Documentation
-- Sync with current codebase
-- Fix broken links
-- Update examples
-- Add missing sections
-
-### 4. Validate
-- Test all code examples
-- Check all links work
-- Verify accuracy
-- Ensure completeness
-
-## Documentation Types
-
-### README.md
-```markdown
-# Project Name
-
-Brief description (1-2 sentences)
-
-## Features
-- ✅ Feature 1
-- ✅ Feature 2
-- ✅ Feature 3
-
-## Quick Start
-\`\`\`bash
-npm install
-npm run dev
-\`\`\`
-
-## Installation
-
-### Prerequisites
-- Node.js 20+
-- PostgreSQL 16+
-
-### Steps
-1. Clone repository
-\`\`\`bash
-git clone https://github.com/org/repo
-cd repo
-\`\`\`
-
-2. Install dependencies
-\`\`\`bash
-npm install
-\`\`\`
-
-3. Configure environment
-\`\`\`bash
-cp .env.example .env
-# Edit .env with your values
-\`\`\`
-
-4. Run database migrations
-\`\`\`bash
-npm run db:migrate
-\`\`\`
-
-5. Start development server
-\`\`\`bash
-npm run dev
-\`\`\`
-
-Open [http://localhost:3000](http://localhost:3000)
-
-## Usage
-
-### Basic Example
-\`\`\`typescript
-import { feature } from 'package';
-
-const result = feature({ option: 'value' });
-\`\`\`
-
-### Advanced Example
-\`\`\`typescript
-// More complex usage
-\`\`\`
-
-## API Reference
-
-See [API.md](API.md)
-
-## Development
-
-### Project Structure
-\`\`\`
-app/          # Next.js app directory
-lib/          # Utilities
-components/   # React components
-tests/        # Tests
-\`\`\`
-
-### Commands
-\`\`\`bash
-npm run dev      # Development server
-npm run build    # Production build
-npm test         # Run tests
-npm run lint     # Lint code
-\`\`\`
-
-## Environment Variables
-
-| Variable | Description | Required |
-|----------|-------------|----------|
-| `DATABASE_URL` | PostgreSQL connection | Yes |
-| `JWT_SECRET` | JWT signing secret | Yes |
-
-## Deployment
-
-See [DEPLOYMENT.md](DEPLOYMENT.md)
-
-## Contributing
-
-1. Fork repository
-2. Create feature branch
-3. Make changes
-4. Submit pull request
-
-## License
-
-MIT
-```
-
-### API Documentation (OpenAPI)
-```yaml
-openapi: 3.0.0
-info:
-  title: App API
-  version: 1.0.0
-  description: REST API for the application
-
-servers:
-  - url: https://api.example.com
-    description: Production
-  - url: http://localhost:3000
-    description: Development
-
-paths:
-  /api/users:
-    get:
-      summary: List users
-      description: Get paginated list of users
-      parameters:
-        - name: page
-          in: query
-          schema:
-            type: integer
-            default: 1
-        - name: limit
-          in: query
-          schema:
-            type: integer
-            default: 20
-      responses:
-        '200':
-          description: Success
-          content:
-            application/json:
-              schema:
-                type: object
-                properties:
-                  users:
-                    type: array
-                    items:
-                      $ref: '#/components/schemas/User'
-                  total:
-                    type: integer
-                  page:
-                    type: integer
-
-    post:
-      summary: Create user
-      requestBody:
-        required: true
-        content:
-          application/json:
-            schema:
-              type: object
-              properties:
-                email:
-                  type: string
-                  format: email
-                password:
-                  type: string
-                  minLength: 8
-      responses:
-        '201':
-          description: User created
-        '400':
-          description: Invalid input
-
-components:
-  schemas:
-    User:
-      type: object
-      properties:
-        id:
-          type: string
-        email:
-          type: string
-        createdAt:
-          type: string
-          format: date-time
-```
-
-### Architecture Documentation
-```markdown
-# System Architecture
-
-## Overview
-Modern full-stack application with Next.js frontend and Node.js backend.
-
-## Tech Stack
-
-### Frontend
-- Next.js 15 (React framework)
-- TypeScript
-- Tailwind CSS
-
-### Backend
-- Node.js REST API
-- PostgreSQL (database)
-- Redis (cache)
-
-### Infrastructure
-- Vercel (frontend hosting)
-- Railway (backend + DB)
-- Cloudflare (CDN)
-
-## Architecture Diagram
-
-\`\`\`mermaid
-graph TD
-    A[User] -->|HTTPS| B[Cloudflare CDN]
-    B -->|Static Assets| C[Vercel - Next.js]
-    C -->|API Calls| D[Railway - Node.js API]
-    D -->|Query| E[PostgreSQL]
-    D -->|Cache| F[Redis]
-\`\`\`
-
-## Database Schema
-
-\`\`\`mermaid
-erDiagram
-    USER ||--o{ ORDER : places
-    USER {
-        string id PK
-        string email UK
-        string password
-        datetime created_at
-    }
-    ORDER {
-        string id PK
-        string user_id FK
-        decimal amount
-        string status
-        datetime created_at
-    }
-\`\`\`
-
-## API Flow
-
-\`\`\`mermaid
-sequenceDiagram
-    User->>Frontend: Submit form
-    Frontend->>API: POST /api/orders
-    API->>DB: Create order
-    DB-->>API: Order created
-    API->>Queue: Add to processing
-    API-->>Frontend: Order ID
-    Frontend-->>User: Show confirmation
-\`\`\`
-
-## Security
-
-- JWT authentication
-- HTTPS only
-- Rate limiting (100 req/15min)
-- Input validation
-- SQL injection prevention (parameterized queries)
-- XSS prevention (output encoding)
-
-## Performance
-
-- Redis caching (1 hour TTL)
-- Database connection pooling
-- CDN for static assets
-- Image optimization (Next.js)
-- Code splitting (automatic)
-```
-
-### Code Comments (TSDoc)
-```typescript
-/**
- * Calculate user's subscription tier based on usage
- *
- * Uses a sliding window of 30 days to prevent gaming.
- * Tier upgrades are immediate, downgrades have 7-day grace period.
- *
- * @param userId - User identifier
- * @returns Subscription tier (free|pro|enterprise)
- * @throws {NotFoundError} If user doesn't exist
- *
- * @example
- * ```typescript
- * const tier = await calculateTier('user_123');
- * console.log(tier); // 'pro'
- * ```
- */
-export async function calculateTier(userId: string): Promise<Tier> {
-  // Implementation
-}
-```
-
-## Generated Documentation
-
-### For Libraries/Packages
-```markdown
-# Package Name
-
-Brief description
-
-## Installation
-\`\`\`bash
-npm install package-name
-\`\`\`
-
-## Quick Start
-\`\`\`typescript
-import { feature } from 'package-name';
-
-feature({ option: 'value' });
-\`\`\`
-
-## API Reference
-
-### `feature(options)`
-
-**Parameters:**
-- `options.option` (string): Description
-
-**Returns:** Description
-
-**Example:**
-\`\`\`typescript
-const result = feature({ option: 'value' });
-\`\`\`
-
-## Advanced Usage
-
-### Custom Configuration
-\`\`\`typescript
-// Example
-\`\`\`
-
-## Contributing
-See [CONTRIBUTING.md](CONTRIBUTING.md)
-
-## License
-MIT
-```
-
-### For Applications
-```markdown
-# App Name
-
-What the app does in one sentence.
-
-## Demo
-[Live Demo](https://app.com) | [Video](https://youtube.com)
-
-## Features
-- ✅ Feature 1
-- ✅ Feature 2
-
-## Tech Stack
-**Frontend:** Next.js, TypeScript
-**Backend:** Node.js, PostgreSQL
-**Deployment:** Vercel, Railway
-
-## Getting Started
-[Installation instructions]
-
-## Development
-[Development guide]
-
-## Deployment
-See [DEPLOYMENT.md](DEPLOYMENT.md)
-
-## License
-MIT
-```
-
-## Documentation Tools
-
-### Generate OpenAPI Docs
-```bash
-# From OpenAPI spec
-npx @redocly/cli build-docs openapi.yaml
-
-# Or auto-generate from code
-npx swagger-jsdoc -d swaggerDef.js routes/*.js -o openapi.json
-```
-
-### Generate TypeDoc
-```bash
-# API docs from TypeScript
-npx typedoc --out docs src/
-```
-
-### Mermaid Diagrams
-```markdown
-\`\`\`mermaid
-graph TD
-    A[Start] --> B[Process]
-    B --> C[End]
-\`\`\`
-```
-
-## Documentation Checklist
-
-### Minimum Viable
-- ✅ README with quick start
-- ✅ Installation instructions
-- ✅ Basic usage examples
-- ✅ Environment variables
-- ✅ License
-
-### Complete
-- ✅ All above
-- ✅ API reference
-- ✅ Architecture diagram
-- ✅ Contributing guide
-- ✅ Deployment guide
-- ✅ Troubleshooting
-- ✅ Changelog
-
-## Common Issues
-
-### Outdated Docs
-- Set up automation to check docs
-- Update docs with code changes
-- Add docs to CI/CD checks
-
-### Broken Links
-- Use link checker in CI
-- Test all examples
-- Verify external links
-
-### Missing Examples
-- Add code examples to all functions
-- Include error handling examples
-- Show common use cases
-
-## Integration with Other Commands
-
-**/ai-sprint-code** → **/ai-sprint-docs**
-- After generating code, document it
-
-**/ai-sprint-review** → **/ai-sprint-docs**
-- Review identifies missing docs
-
-**/ai-sprint-test** → **/ai-sprint-docs**
-- Tests validate doc examples work
-
-## Success Criteria
-
-Documentation is successful when:
-- ✅ New users can start in <10 minutes
-- ✅ All code examples work
-- ✅ API is fully documented
-- ✅ No broken links
-- ✅ Architecture is clear
-- ✅ Updated with code
-
-## Remember
-
-**Good documentation:**
-- Helps users succeed
-- Saves support time
-- Onboards developers
-- Shows professionalism
-
-**Write docs your future self will thank you for.**

package/templates/.claude/commands/ai-sprint-plan.md

@@ -1,136 +0,0 @@
----
-description: Create comprehensive implementation plan with research and architecture
-argument-hint: [feature or task description]
----
-
-**ULTRATHINK** - Deep thinking mode for comprehensive planning.
-
-**Objective:** $ARGUMENTS
-
-## MANDATORY Workflow
-
-**CRITICAL:** Follow these steps in order. Do NOT skip research.
-
----
-
-### Step 1: Context & Memory
-
-```bash
-# Get current timestamp (DO NOT guess dates)
-date "+%y%m%d-%H%M"
-```
-
-Check memory for past lessons:
-- Read `ai_context/memory/learning.md` for mistakes to avoid
-- Read `ai_context/memory/decisions.md` for past architectural decisions
-
----
-
-### Step 2: Clarification
-
-Use `AskUserQuestion` tool if requirements are unclear:
-- Technical constraints?
-- Performance requirements?
-- Security considerations?
-- Integration points?
-
----
-
-### Step 3: Research (MANDATORY)
-
-**⚠️ Do NOT skip research. Use researcher agent:**
-
-```
-Task(subagent_type="researcher", prompt="Research best practices and approaches for: $ARGUMENTS. Find: 1) Common patterns 2) Security considerations 3) Potential pitfalls 4) Recommended libraries/tools. Limit to 5 sources.", description="Research task requirements")
-```
-
-Research must cover:
-- Industry best practices
-- Security considerations (OWASP if applicable)
-- Common implementation patterns
-- Potential risks and mitigation
-
----
-
-### Step 4: Architecture Planning
-
-Use planner agent with research results:
-
-```
-Task(subagent_type="planner", prompt="Create implementation plan for: $ARGUMENTS. Use research findings. Include: architecture, phases, risks, security, success criteria.", description="Create implementation plan")
-```
-
----
-
-### Step 5: Create Plan Files
-
-Create plan directory: `ai_context/ai-sprint-plans/YYMMDD-HHMM-feature-name/`
-
-**Required files:**
-
-1. **plan.md** - Overview (keep under 80 lines)
-   ```yaml
-   ---
-   title: "Feature name"
-   status: pending
-   created: YYYY-MM-DD
-   ---
-   ```
-   - Summary
-   - Phase list with links
-   - Success criteria
-
-2. **phase-XX-name.md** - Detailed phases
-   - Requirements
-   - Architecture decisions
-   - Implementation steps
-   - Security considerations
-   - Success criteria
-
-3. **research/researcher-report.md** - Research findings
-
----
-
-### Step 6: Update Memory
-
-After plan creation:
-- Add key decisions to `ai_context/memory/decisions.md`
-- Note any lessons learned
-
----
-
-## Plan Contents
-
-Every plan must include:
-- **Overview** - What we're building and why
-- **Architecture** - Technical decisions with rationale
-- **Phases** - Step-by-step implementation (ordered)
-- **Risks** - Potential issues and mitigation strategies
-- **Security** - Security considerations and requirements
-- **Success Criteria** - Definition of done
-
-## Output
-
-Plan directory structure:
-```
-ai_context/ai-sprint-plans/YYMMDD-HHMM-feature-name/
-├── plan.md           # Overview
-├── phase-01-*.md     # Phase details
-├── phase-02-*.md
-└── research/
-    └── researcher-report.md
-```
-
-## Next Steps
-
-After plan creation:
-1. Review plan with user
-2. Get approval or make adjustments
-3. Execute with `/ai-sprint-code {plan-path}` or continue `/ai-sprint-auto`
-
-## REMEMBER
-
-- **ULTRATHINK** - Take time to think deeply about architecture
-- **Research FIRST** - Always research before planning
-- **No shortcuts** - Complete all steps in order
-- **Memory matters** - Check past lessons, record new decisions