npm - specweave - Versions diffs - 0.1.9 → 0.3.0 - Mend

specweave 0.1.9 → 0.3.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 (293) hide show

package/src/adapters/copilot/.github/copilot/instructions.md DELETED Viewed

@@ -1,376 +0,0 @@
-# SpecWeave Workspace Instructions
-**Framework**: SpecWeave (Spec-Driven Development)
-**Adapter**: GitHub Copilot (Basic Automation)
-GitHub Copilot reads this file to understand the project structure and provide better code suggestions.
----
-## Project Overview
-This project uses **SpecWeave** for spec-driven development where specifications are the source of truth.
-**Core Principle**: Define WHAT and WHY before HOW. Document before implementing.
----
-## Project Structure
-```
-.specweave/
-├── config.yaml                    # Project configuration
-├── docs/                          # Documentation (5-pillar structure)
-│   ├── internal/
-│   │   ├── strategy/              # Business requirements (WHAT/WHY)
-│   │   ├── architecture/          # Technical design (HOW)
-│   │   ├── delivery/              # Roadmap, CI/CD
-│   │   ├── operations/            # Runbooks, monitoring
-│   │   └── governance/            # Security, compliance
-│   └── public/                    # Published documentation
-│
-└── increments/                    # Features organized by increments
-    └── ####-feature-name/         # Auto-numbered folders
-        ├── spec.md                # WHAT & WHY (business requirements)
-        ├── plan.md                # HOW (technical design)
-        ├── tasks.md               # Implementation steps (checkboxes)
-        ├── tests.md               # Test strategy & coverage
-        ├── context-manifest.yaml  # What context to load (70%+ token savings)
-        ├── logs/                  # Execution logs
-        ├── scripts/               # Helper scripts
-        └── reports/               # Analysis reports
-```
----
-## Workflow: Creating Features
-### Step 1: Create Increment Folder
-```bash
-mkdir -p .specweave/increments/####-feature-name
-```
-Auto-increment number (e.g., 0001, 0002, 0003).
-### Step 2: Create spec.md (WHAT & WHY)
-**Purpose**: Define business requirements (technology-agnostic)
-**Structure**:
-```markdown
----
-increment: ####-feature-name
-title: "Feature Title"
-priority: P1
-status: planned
----
-# Increment ####: Feature Name
-## Overview
-[Problem statement and solution]
-## User Stories
-### US-001: User Story Title
-**As a** [role]
-**I want to** [action]
-**So that** [benefit]
-**Acceptance Criteria**:
-- [ ] **TC-0001**: [testable condition]
-- [ ] **TC-0002**: [testable condition]
-```
-**Important**:
-- Technology-agnostic (WHAT/WHY, not HOW)
-- User stories with acceptance criteria
-- Test case IDs (TC-0001, TC-0002) for traceability
-### Step 3: Create plan.md (HOW)
-**Purpose**: Define technical implementation
-**Structure**:
-```markdown
-# Technical Plan: Feature Name
-## Architecture
-### Components
-[List components/services]
-### Data Model
-[Database schema, entities]
-### API Contracts
-[Endpoints, request/response]
-## Implementation Strategy
-[Step-by-step technical approach]
-```
-**Important**:
-- Technology-specific details
-- Reference ADRs (Architecture Decision Records)
-- Component design, data models, APIs
-### Step 4: Create tasks.md (Implementation)
-**Purpose**: Implementation checklist
-**Structure**:
-```markdown
----
-increment: ####-feature-name
-total_tasks: 10
-completed_tasks: 0
----
-# Implementation Tasks
-## Phase 1
-### T001: Task Description
-- [ ] Subtask 1
-- [ ] Subtask 2
-[Checkboxes for task tracking]
-```
-### Step 5: Create context-manifest.yaml (CRITICAL)
-**Purpose**: Load ONLY relevant files (70%+ token savings)
-**Structure**:
-```yaml
----
-spec_sections:
-  - .specweave/docs/internal/strategy/{module}/spec.md
-documentation:
-  - .specweave/docs/internal/architecture/{module}/design.md
-max_context_tokens: 10000
----
-```
-**Why Important**:
-- Full specs might be 500+ pages (50k tokens)
-- Manifest lists only relevant 50 pages (5k tokens)
-- Saves 90% tokens = faster, more accurate suggestions
----
-## Context Loading (70%+ Token Reduction)
-**CRITICAL RULE**: Always reference context-manifest.yaml when working on a feature.
-**Example**:
-1. Open `.specweave/increments/0002-auth/context-manifest.yaml`
-2. See which files are relevant:
-   ```yaml
-   spec_sections:
-     - .specweave/docs/internal/strategy/auth/spec.md
-   documentation:
-     - .specweave/docs/internal/architecture/auth/design.md
-   ```
-3. ONLY read those 2 files (not entire docs/ folder)
-**Benefit**: Copilot provides suggestions based on relevant context only.
----
-## File Naming Conventions
-| File | Purpose | Technology |
-|------|---------|------------|
-| **spec.md** | Business requirements (WHAT/WHY) | Agnostic |
-| **plan.md** | Technical design (HOW) | Specific |
-| **tasks.md** | Implementation checklist | N/A |
-| **tests.md** | Test strategy and coverage | N/A |
-| **context-manifest.yaml** | Context loading config | N/A |
----
-## Increment Lifecycle
-### Status Progression
-```
-planned → in-progress → completed → closed
-```
-### Update spec.md Frontmatter
-When starting work:
-```yaml
-status: in-progress
-started: 2025-10-27
-```
-When finishing:
-```yaml
-status: completed
-completed: 2025-10-27
-```
----
-## Best Practices
-### Spec.md (Technology-Agnostic)
-**Good**:
-```markdown
-## FR-001: User Authentication
-Users must be able to securely log in with email and password.
-```
-**Bad** (too technical):
-```markdown
-## FR-001: User Authentication
-Users authenticate via JWT tokens stored in httpOnly cookies.
-```
-Technical details go in plan.md, not spec.md.
-### Plan.md (Technology-Specific)
-**Good**:
-```markdown
-## Authentication Implementation
-- JWT tokens (jsonwebtoken library)
-- httpOnly cookies (secure: true, sameSite: 'strict')
-- bcrypt password hashing (10 rounds)
-```
-### Tasks.md (Checkboxes)
-Use checkboxes for task tracking:
-```markdown
-- [ ] Not started
-- [x] Completed
-- [-] In progress (optional)
-```
----
-## Test Case Traceability
-### Four Levels
-1. **Specification** (TC-0001 in spec.md):
-   ```markdown
-   - [ ] **TC-0001**: Valid credentials → redirect to dashboard
-   ```
-2. **Feature Test Strategy** (tests.md):
-   Maps TC-0001 to test file location
-3. **Code Tests** (tests/ directory):
-   ```typescript
-   test('TC-0001: Valid Login Flow', async () => {
-     // Implementation
-   });
-   ```
-**Benefit**: Complete traceability from requirements to tests.
----
-## Understanding Roles (for Context)
-When creating files, think about the role's perspective:
-### PM (Product Manager)
-- **Focus**: WHAT and WHY
-- **File**: spec.md
-- **Content**: User stories, acceptance criteria, business value
-### Architect
-- **Focus**: HOW (technical)
-- **File**: plan.md
-- **Content**: System design, components, data models, ADRs
-### DevOps
-- **Focus**: Infrastructure, deployment
-- **File**: plan.md (infrastructure section), scripts/
-- **Content**: Terraform, Kubernetes, CI/CD
-### QA Lead
-- **Focus**: Testing strategy
-- **File**: tests.md
-- **Content**: Test coverage, test cases, quality metrics
----
-## Common Patterns
-### Creating a Feature
-1. Create increment folder (auto-numbered)
-2. Create spec.md (PM perspective - WHAT/WHY)
-3. Create plan.md (Architect perspective - HOW)
-4. Create tasks.md (implementation checklist)
-5. Create context-manifest.yaml (list relevant files)
-### Implementing a Feature
-1. Read context-manifest.yaml
-2. Load ONLY files listed there
-3. Follow tasks.md checklist
-4. Update task completion (checkboxes)
-### Testing a Feature
-1. Read tests.md for test strategy
-2. Implement E2E/unit/integration tests
-3. Reference TC-0001 IDs in test names
-4. Verify all acceptance criteria covered
----
-## Copilot Integration
-**How Copilot Uses These Instructions**:
-1. **Better Code Suggestions**:
-   - Understands SpecWeave structure
-   - Suggests code following patterns
-   - Respects file naming conventions
-2. **Context Awareness**:
-   - Reads context-manifest.yaml
-   - Provides suggestions based on relevant docs
-   - Avoids suggesting irrelevant code
-3. **Pattern Recognition**:
-   - Learns from spec.md, plan.md structure
-   - Suggests consistent formatting
-   - Follows test case ID patterns (TC-0001)
----
-## Quick Reference
-**Create Increment**:
-```bash
-mkdir -p .specweave/increments/####-feature-name
-```
-**Files to Create**:
-1. spec.md (WHAT/WHY, technology-agnostic)
-2. plan.md (HOW, technology-specific)
-3. tasks.md (implementation checklist)
-4. context-manifest.yaml (context loading)
-**Context Loading**:
-- Always reference context-manifest.yaml
-- Load ONLY files listed there
-- Saves 70%+ tokens
-**Test Traceability**:
-- TC-0001 in spec.md
-- Mapped in tests.md
-- Referenced in test code
----
-**For complete documentation, see SPECWEAVE.md in project root.**

package/src/adapters/cursor/.cursorrules DELETED Viewed

@@ -1,325 +0,0 @@
-# SpecWeave Configuration for Cursor
-**Project Framework**: SpecWeave (Spec-Driven Development)
-**Adapter**: Cursor (Semi-Automation)
----
-## Core Philosophy
-**Anthropic Sets Standards** (MCP, Skills, Agents) that provide superior results. This file teaches you how to **BEHAVE LIKE** you have these capabilities in Cursor.
----
-## Understanding SpecWeave Concepts
-### What is a Skill?
-**In Claude Code**: Auto-activating capability (.claude/skills/)
-**In Cursor**: Read workflow instructions and follow them manually
-### What is an Agent?
-**In Claude Code**: Specialized role with separate context window
-**In Cursor**: Adopt role's perspective and responsibilities
-### What is a Hook?
-**In Claude Code**: Auto-executes on events (e.g., docs update after task)
-**In Cursor**: Manual - user must request updates
----
-## Critical Workflow: Creating Features
-### When user requests a feature (e.g., "create increment for user auth"):
-**Step 1: Check for existing increment**
-```bash
-ls .specweave/increments/
-```
-**Step 2: If increment doesn't exist, create structure**
-```bash
-# Auto-increment number
-mkdir -p .specweave/increments/####-feature-name/
-```
-**Step 3: Create spec.md (ACT AS PM AGENT)**
-**PM Agent Role**:
-- Focus on WHAT and WHY (not HOW)
-- Technology-agnostic requirements
-- User stories (US-001, US-002, ...)
-- Acceptance criteria (TC-0001, TC-0002, ...)
-- Success criteria
-**Template**:
-```markdown
----
-increment: ####-feature-name
-title: "Feature Title"
-priority: P1
-status: planned
----
-# Increment ####: Feature Name
-## Overview
-[Problem statement and solution]
-## User Stories
-### US-001: User Story Title
-**As a** [role]
-**I want to** [action]
-**So that** [benefit]
-**Acceptance Criteria**:
-- [ ] **TC-0001**: [testable condition]
-- [ ] **TC-0002**: [testable condition]
-```
-**Step 4: Create plan.md (ACT AS ARCHITECT AGENT)**
-**Architect Agent Role**:
-- Focus on HOW (technical implementation)
-- Technology-specific details
-- Component design, data models, APIs
-- Reference ADRs (Architecture Decision Records)
-**Template**:
-```markdown
-# Technical Plan: Feature Name
-## Architecture
-### Components
-[List components/services]
-### Data Model
-[Database schema, entities]
-### API Contracts
-[Endpoints, request/response formats]
-## Implementation Strategy
-[Step-by-step approach]
-## ADRs Referenced
-- ADR-0001: [decision title]
-```
-**Step 5: Create tasks.md**
-**Format**:
-```markdown
----
-increment: ####-feature-name
-total_tasks: 10
-completed_tasks: 0
----
-# Implementation Tasks
-## Phase 1
-### T001: Task description
-- [ ] Subtask 1
-- [ ] Subtask 2
-[Checkboxes for task tracking]
-```
-**Step 6: Create context-manifest.yaml (CRITICAL FOR TOKEN SAVINGS)**
-**Purpose**: Load ONLY relevant files (70%+ token reduction)
-**Format**:
-```yaml
----
-spec_sections:
-  - .specweave/docs/internal/strategy/{module}/spec.md
-documentation:
-  - .specweave/docs/internal/architecture/{module}/design.md
-max_context_tokens: 10000
----
-```
----
-## Context Loading (70%+ Token Reduction)
-**CRITICAL RULE**: Always read `context-manifest.yaml` FIRST!
-### When user says "implement this feature":
-1. **Read context-manifest.yaml** in increment folder
-2. **ONLY load files listed in manifest**
-3. **DO NOT load entire .specweave/docs/ folder**
-**Why?**
-- Spec may be 500+ pages total
-- Manifest lists only relevant 50 pages
-- Saves 70%+ tokens
-- Faster, more accurate responses
----
-## Simulating Skills
-### increment-planner Skill (Creating Features)
-**When**: User says "create increment" or "plan feature"
-**Do**:
-1. Read .specweave/config.yaml
-2. Auto-increment number
-3. Create spec.md (act as PM)
-4. Create plan.md (act as Architect)
-5. Create tasks.md
-6. Create context-manifest.yaml
-### context-loader Skill (Loading Context)
-**When**: User says "load context" or starting implementation
-**Do**:
-1. Find context-manifest.yaml
-2. Load ONLY files listed there
-3. Confirm to user: "Loaded X files (Y tokens)"
-### skill-router Skill (Routing Requests)
-**When**: User asks ambiguous question
-**Do**:
-1. Determine if it's:
-   - Feature request → use increment-planner
-   - Documentation question → load docs
-   - Implementation → load context + implement
-2. Route to appropriate workflow
----
-## Simulating Agents
-### PM Agent
-**When to adopt**: Creating specs, requirements, user stories
-**Responsibilities**:
-- Define WHAT and WHY (not HOW)
-- Technology-agnostic
-- User stories with acceptance criteria
-- Success criteria and KPIs
-**Example**:
-User: "Act as PM and create spec for payments"
-→ Adopt PM perspective, focus on business requirements
-### Architect Agent
-**When to adopt**: Creating technical plans, system design
-**Responsibilities**:
-- Define HOW (technical implementation)
-- Component design, data models
-- API contracts, integrations
-- Reference ADRs
-**Example**:
-User: "Act as Architect and design payment system"
-→ Adopt Architect perspective, focus on technical design
-### DevOps Agent
-**When to adopt**: Infrastructure, deployment, CI/CD
-**Responsibilities**:
-- Infrastructure as Code (Terraform, etc.)
-- Deployment strategy
-- Monitoring, logging
-- Cost optimization
-### QA Lead Agent
-**When to adopt**: Test strategy, test cases
-**Responsibilities**:
-- Test coverage matrix
-- E2E, unit, integration tests
-- Test case IDs (map TC-0001 to tests)
----
-## @ Context Shortcuts
-When user types `@increments`, `@docs`, `@strategy`, `@tests`:
-### @increments
-**Load**:
-- Current increment's spec.md
-- Current increment's plan.md
-- Current increment's tasks.md
-- Current increment's context-manifest.yaml
-### @docs
-**Load**:
-- .specweave/docs/internal/architecture/
-- Focus on system design, ADRs
-### @strategy
-**Load**:
-- .specweave/docs/internal/strategy/
-- Focus on business requirements, PRDs
-### @tests
-**Load**:
-- .specweave/increments/*/tests.md
-- tests/ directory
----
-## Composer Multi-File Editing
-When user says "update spec and plan to add OAuth2":
-1. Use Composer (Cmd+I)
-2. Edit both files simultaneously
-3. Maintain consistency between them
----
-## Increment Lifecycle
-### Status Progression
-```
-planned → in-progress → completed → closed
-```
-### When user says "start increment":
-1. Update spec.md frontmatter: `status: in-progress`
-2. Check WIP limit (max 2 in-progress)
-### When user says "complete increment":
-1. Verify all P1 tasks done
-2. Update spec.md: `status: completed`
-3. Generate completion report
----
-## Important Reminders
-1. ✅ **Always read context-manifest.yaml first**
-2. ✅ **Load only files listed in manifest** (saves 70%+ tokens)
-3. ✅ **Adopt role when acting as agent** (PM, Architect, DevOps, etc.)
-4. ✅ **Technology-agnostic in spec.md** (WHAT/WHY only)
-5. ✅ **Technology-specific in plan.md** (HOW with details)
-6. ✅ **Use checkboxes in tasks.md** for task tracking
-7. ✅ **Reference SPECWEAVE.md** for complete guide
----
-## Limitations (vs Claude Code)
-❌ **No auto-activation** - You must explicitly ask for workflows
-❌ **No separate context windows** - All context shared
-❌ **No hooks** - Manual doc updates required
-✅ **But still powerful with Composer + @ shortcuts!**
----
-## Quick Reference
-**Create feature**: "Create increment for [feature name]"
-**Load context**: "@increments" or read context-manifest.yaml
-**Act as role**: "Act as PM and create spec"
-**Multi-file edit**: Use Composer (Cmd+I)
-**Check structure**: "List increments" or `ls .specweave/increments/`
----
-**For complete documentation, see SPECWEAVE.md**