ai-summon 0.0.1
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.
- package/.claude/commands/speckit.analyze.md +184 -0
- package/.claude/commands/speckit.checklist.md +294 -0
- package/.claude/commands/speckit.clarify.md +177 -0
- package/.claude/commands/speckit.constitution.md +78 -0
- package/.claude/commands/speckit.implement.md +121 -0
- package/.claude/commands/speckit.plan.md +81 -0
- package/.claude/commands/speckit.specify.md +204 -0
- package/.claude/commands/speckit.tasks.md +108 -0
- package/.claude/settings.local.json +23 -0
- package/.prettierignore +5 -0
- package/.prettierrc.json +10 -0
- package/.specify/memory/constitution.md +72 -0
- package/.specify/scripts/bash/check-prerequisites.sh +166 -0
- package/.specify/scripts/bash/common.sh +113 -0
- package/.specify/scripts/bash/create-new-feature.sh +97 -0
- package/.specify/scripts/bash/setup-plan.sh +60 -0
- package/.specify/scripts/bash/update-agent-context.sh +738 -0
- package/.specify/templates/agent-file-template.md +28 -0
- package/.specify/templates/checklist-template.md +40 -0
- package/.specify/templates/plan-template.md +111 -0
- package/.specify/templates/spec-template.md +115 -0
- package/.specify/templates/tasks-template.md +250 -0
- package/CLAUDE.md +199 -0
- package/PRD.md +268 -0
- package/README.md +171 -0
- package/dist/ai-summon.d.ts +2 -0
- package/dist/ai-summon.js +73 -0
- package/dist/commands/ide/index.d.ts +3 -0
- package/dist/commands/ide/index.js +253 -0
- package/dist/commands/init.d.ts +4 -0
- package/dist/commands/init.js +55 -0
- package/dist/commands/url.d.ts +4 -0
- package/dist/commands/url.js +223 -0
- package/dist/types/index.d.ts +40 -0
- package/dist/types/index.js +1 -0
- package/dist/util.d.ts +16 -0
- package/dist/util.js +109 -0
- package/eslint.config.js +47 -0
- package/package.json +47 -0
- package/specs/001-cloud-login-feature/contracts/cloud-command.ts +82 -0
- package/specs/001-cloud-login-feature/contracts/config-service.ts +170 -0
- package/specs/001-cloud-login-feature/data-model.md +269 -0
- package/specs/001-cloud-login-feature/plan.md +91 -0
- package/specs/001-cloud-login-feature/quickstart.md +366 -0
- package/specs/001-cloud-login-feature/research.md +290 -0
- package/specs/001-cloud-login-feature/spec.md +195 -0
- package/specs/001-cloud-login-feature/tasks.md +235 -0
- package/specs/001-cloud-scp-command/contracts/cloud-scp-api.ts +402 -0
- package/specs/001-cloud-scp-command/data-model.md +424 -0
- package/specs/001-cloud-scp-command/plan.md +124 -0
- package/specs/001-cloud-scp-command/quickstart.md +536 -0
- package/specs/001-cloud-scp-command/research.md +345 -0
- package/specs/001-cloud-scp-command/spec.md +248 -0
- package/specs/001-cloud-scp-command/tasks.md +434 -0
- package/src/ai-summon.ts +88 -0
- package/src/commands/ide/index.ts +322 -0
- package/src/commands/init.ts +64 -0
- package/src/commands/url.ts +262 -0
- package/src/types/index.ts +49 -0
- package/src/util.ts +146 -0
- package/tsconfig.json +21 -0
|
@@ -0,0 +1,28 @@
|
|
|
1
|
+
# [PROJECT NAME] Development Guidelines
|
|
2
|
+
|
|
3
|
+
Auto-generated from all feature plans. Last updated: [DATE]
|
|
4
|
+
|
|
5
|
+
## Active Technologies
|
|
6
|
+
|
|
7
|
+
[EXTRACTED FROM ALL PLAN.MD FILES]
|
|
8
|
+
|
|
9
|
+
## Project Structure
|
|
10
|
+
|
|
11
|
+
```
|
|
12
|
+
[ACTUAL STRUCTURE FROM PLANS]
|
|
13
|
+
```
|
|
14
|
+
|
|
15
|
+
## Commands
|
|
16
|
+
|
|
17
|
+
[ONLY COMMANDS FOR ACTIVE TECHNOLOGIES]
|
|
18
|
+
|
|
19
|
+
## Code Style
|
|
20
|
+
|
|
21
|
+
[LANGUAGE-SPECIFIC, ONLY FOR LANGUAGES IN USE]
|
|
22
|
+
|
|
23
|
+
## Recent Changes
|
|
24
|
+
|
|
25
|
+
[LAST 3 FEATURES AND WHAT THEY ADDED]
|
|
26
|
+
|
|
27
|
+
<!-- MANUAL ADDITIONS START -->
|
|
28
|
+
<!-- MANUAL ADDITIONS END -->
|
|
@@ -0,0 +1,40 @@
|
|
|
1
|
+
# [CHECKLIST TYPE] Checklist: [FEATURE NAME]
|
|
2
|
+
|
|
3
|
+
**Purpose**: [Brief description of what this checklist covers]
|
|
4
|
+
**Created**: [DATE]
|
|
5
|
+
**Feature**: [Link to spec.md or relevant documentation]
|
|
6
|
+
|
|
7
|
+
**Note**: This checklist is generated by the `/speckit.checklist` command based on feature context and requirements.
|
|
8
|
+
|
|
9
|
+
<!--
|
|
10
|
+
============================================================================
|
|
11
|
+
IMPORTANT: The checklist items below are SAMPLE ITEMS for illustration only.
|
|
12
|
+
|
|
13
|
+
The /speckit.checklist command MUST replace these with actual items based on:
|
|
14
|
+
- User's specific checklist request
|
|
15
|
+
- Feature requirements from spec.md
|
|
16
|
+
- Technical context from plan.md
|
|
17
|
+
- Implementation details from tasks.md
|
|
18
|
+
|
|
19
|
+
DO NOT keep these sample items in the generated checklist file.
|
|
20
|
+
============================================================================
|
|
21
|
+
-->
|
|
22
|
+
|
|
23
|
+
## [Category 1]
|
|
24
|
+
|
|
25
|
+
- [ ] CHK001 First checklist item with clear action
|
|
26
|
+
- [ ] CHK002 Second checklist item
|
|
27
|
+
- [ ] CHK003 Third checklist item
|
|
28
|
+
|
|
29
|
+
## [Category 2]
|
|
30
|
+
|
|
31
|
+
- [ ] CHK004 Another category item
|
|
32
|
+
- [ ] CHK005 Item with specific criteria
|
|
33
|
+
- [ ] CHK006 Final item in this category
|
|
34
|
+
|
|
35
|
+
## Notes
|
|
36
|
+
|
|
37
|
+
- Check items off as completed: `[x]`
|
|
38
|
+
- Add comments or findings inline
|
|
39
|
+
- Link to relevant resources or documentation
|
|
40
|
+
- Items are numbered sequentially for easy reference
|
|
@@ -0,0 +1,111 @@
|
|
|
1
|
+
# Implementation Plan: [FEATURE]
|
|
2
|
+
|
|
3
|
+
**Branch**: `[###-feature-name]` | **Date**: [DATE] | **Spec**: [link]
|
|
4
|
+
**Input**: Feature specification from `/specs/[###-feature-name]/spec.md`
|
|
5
|
+
|
|
6
|
+
**Note**: This template is filled in by the `/speckit.plan` command. See `.specify/templates/commands/plan.md` for the execution workflow.
|
|
7
|
+
|
|
8
|
+
## Summary
|
|
9
|
+
|
|
10
|
+
[Extract from feature spec: primary requirement + technical approach from research]
|
|
11
|
+
|
|
12
|
+
## Technical Context
|
|
13
|
+
|
|
14
|
+
<!--
|
|
15
|
+
ACTION REQUIRED: Replace the content in this section with the technical details
|
|
16
|
+
for the project. The structure here is presented in advisory capacity to guide
|
|
17
|
+
the iteration process.
|
|
18
|
+
-->
|
|
19
|
+
|
|
20
|
+
**Language/Version**: TypeScript 5.0+ with ES2020 target and ESNext modules
|
|
21
|
+
**Primary Dependencies**: commander (CLI), inquirer (prompts), zx (shell), chalk (colors), ora (progress)
|
|
22
|
+
**Storage**: [if applicable, e.g., JSON config files, local storage or N/A]
|
|
23
|
+
**Testing**: [Jest, Vitest, or manual CLI testing - specify if needed]
|
|
24
|
+
**Target Platform**: Node.js CLI (global installation via npm/yarn)
|
|
25
|
+
**Project Type**: [single/web/mobile - determines source structure]
|
|
26
|
+
**Performance Goals**: [domain-specific, e.g., 1000 req/s, 10k lines/sec, 60 fps or NEEDS CLARIFICATION]
|
|
27
|
+
**Constraints**: [domain-specific, e.g., <200ms p95, <100MB memory, offline-capable or NEEDS CLARIFICATION]
|
|
28
|
+
**Scale/Scope**: [domain-specific, e.g., 10k users, 1M LOC, 50 screens or NEEDS CLARIFICATION]
|
|
29
|
+
|
|
30
|
+
## Constitution Check
|
|
31
|
+
|
|
32
|
+
_GATE: Must pass before Phase 0 research. Re-check after Phase 1 design._
|
|
33
|
+
|
|
34
|
+
✅ **TypeScript-First**: All code written in TypeScript with strict mode, fully typed
|
|
35
|
+
✅ **Shell Integration**: Uses zx library for all shell operations with async/await
|
|
36
|
+
✅ **Interactive CLI**: Uses inquirer prompts with validation and chalk/ora for feedback
|
|
37
|
+
✅ **Modular Architecture**: Commands organized by domain in separate modules
|
|
38
|
+
✅ **Yarn Package Management**: Uses Yarn with standard script patterns
|
|
39
|
+
|
|
40
|
+
## Project Structure
|
|
41
|
+
|
|
42
|
+
### Documentation (this feature)
|
|
43
|
+
|
|
44
|
+
```
|
|
45
|
+
specs/[###-feature]/
|
|
46
|
+
├── plan.md # This file (/speckit.plan command output)
|
|
47
|
+
├── research.md # Phase 0 output (/speckit.plan command)
|
|
48
|
+
├── data-model.md # Phase 1 output (/speckit.plan command)
|
|
49
|
+
├── quickstart.md # Phase 1 output (/speckit.plan command)
|
|
50
|
+
├── contracts/ # Phase 1 output (/speckit.plan command)
|
|
51
|
+
└── tasks.md # Phase 2 output (/speckit.tasks command - NOT created by /speckit.plan)
|
|
52
|
+
```
|
|
53
|
+
|
|
54
|
+
### Source Code (repository root)
|
|
55
|
+
|
|
56
|
+
<!--
|
|
57
|
+
ACTION REQUIRED: Replace the placeholder tree below with the concrete layout
|
|
58
|
+
for this feature. Delete unused options and expand the chosen structure with
|
|
59
|
+
real paths (e.g., apps/admin, packages/something). The delivered plan must
|
|
60
|
+
not include Option labels.
|
|
61
|
+
-->
|
|
62
|
+
|
|
63
|
+
```
|
|
64
|
+
# Option 1: TypeScript CLI Project (DEFAULT)
|
|
65
|
+
src/
|
|
66
|
+
├── commands/ # Domain-specific command modules (git, mono, ide)
|
|
67
|
+
├── types/ # TypeScript type definitions
|
|
68
|
+
├── util.ts # Utility functions
|
|
69
|
+
└── hsh.ts # Main CLI entry point
|
|
70
|
+
|
|
71
|
+
dist/ # Compiled TypeScript output
|
|
72
|
+
└── [mirrors src structure]
|
|
73
|
+
|
|
74
|
+
tests/ # Optional - only if tests requested
|
|
75
|
+
├── unit/
|
|
76
|
+
└── integration/
|
|
77
|
+
|
|
78
|
+
# [REMOVE IF UNUSED] Option 2: Web application (when "frontend" + "backend" detected)
|
|
79
|
+
backend/
|
|
80
|
+
├── src/
|
|
81
|
+
│ ├── models/
|
|
82
|
+
│ ├── services/
|
|
83
|
+
│ └── api/
|
|
84
|
+
└── tests/
|
|
85
|
+
|
|
86
|
+
frontend/
|
|
87
|
+
├── src/
|
|
88
|
+
│ ├── components/
|
|
89
|
+
│ ├── pages/
|
|
90
|
+
│ └── services/
|
|
91
|
+
└── tests/
|
|
92
|
+
|
|
93
|
+
# [REMOVE IF UNUSED] Option 3: Mobile + API (when "iOS/Android" detected)
|
|
94
|
+
api/
|
|
95
|
+
└── [same as backend above]
|
|
96
|
+
|
|
97
|
+
ios/ or android/
|
|
98
|
+
└── [platform-specific structure: feature modules, UI flows, platform tests]
|
|
99
|
+
```
|
|
100
|
+
|
|
101
|
+
**Structure Decision**: [Document the selected structure and reference the real
|
|
102
|
+
directories captured above]
|
|
103
|
+
|
|
104
|
+
## Complexity Tracking
|
|
105
|
+
|
|
106
|
+
_Fill ONLY if Constitution Check has violations that must be justified_
|
|
107
|
+
|
|
108
|
+
| Violation | Why Needed | Simpler Alternative Rejected Because |
|
|
109
|
+
| -------------------------- | ------------------ | ------------------------------------ |
|
|
110
|
+
| [e.g., 4th project] | [current need] | [why 3 projects insufficient] |
|
|
111
|
+
| [e.g., Repository pattern] | [specific problem] | [why direct DB access insufficient] |
|
|
@@ -0,0 +1,115 @@
|
|
|
1
|
+
# Feature Specification: [FEATURE NAME]
|
|
2
|
+
|
|
3
|
+
**Feature Branch**: `[###-feature-name]`
|
|
4
|
+
**Created**: [DATE]
|
|
5
|
+
**Status**: Draft
|
|
6
|
+
**Input**: User description: "$ARGUMENTS"
|
|
7
|
+
|
|
8
|
+
## User Scenarios & Testing _(mandatory)_
|
|
9
|
+
|
|
10
|
+
<!--
|
|
11
|
+
IMPORTANT: User stories should be PRIORITIZED as user journeys ordered by importance.
|
|
12
|
+
Each user story/journey must be INDEPENDENTLY TESTABLE - meaning if you implement just ONE of them,
|
|
13
|
+
you should still have a viable MVP (Minimum Viable Product) that delivers value.
|
|
14
|
+
|
|
15
|
+
Assign priorities (P1, P2, P3, etc.) to each story, where P1 is the most critical.
|
|
16
|
+
Think of each story as a standalone slice of functionality that can be:
|
|
17
|
+
- Developed independently
|
|
18
|
+
- Tested independently
|
|
19
|
+
- Deployed independently
|
|
20
|
+
- Demonstrated to users independently
|
|
21
|
+
-->
|
|
22
|
+
|
|
23
|
+
### User Story 1 - [Brief Title] (Priority: P1)
|
|
24
|
+
|
|
25
|
+
[Describe this user journey in plain language]
|
|
26
|
+
|
|
27
|
+
**Why this priority**: [Explain the value and why it has this priority level]
|
|
28
|
+
|
|
29
|
+
**Independent Test**: [Describe how this can be tested independently - e.g., "Can be fully tested by [specific action] and delivers [specific value]"]
|
|
30
|
+
|
|
31
|
+
**Acceptance Scenarios**:
|
|
32
|
+
|
|
33
|
+
1. **Given** [initial state], **When** [action], **Then** [expected outcome]
|
|
34
|
+
2. **Given** [initial state], **When** [action], **Then** [expected outcome]
|
|
35
|
+
|
|
36
|
+
---
|
|
37
|
+
|
|
38
|
+
### User Story 2 - [Brief Title] (Priority: P2)
|
|
39
|
+
|
|
40
|
+
[Describe this user journey in plain language]
|
|
41
|
+
|
|
42
|
+
**Why this priority**: [Explain the value and why it has this priority level]
|
|
43
|
+
|
|
44
|
+
**Independent Test**: [Describe how this can be tested independently]
|
|
45
|
+
|
|
46
|
+
**Acceptance Scenarios**:
|
|
47
|
+
|
|
48
|
+
1. **Given** [initial state], **When** [action], **Then** [expected outcome]
|
|
49
|
+
|
|
50
|
+
---
|
|
51
|
+
|
|
52
|
+
### User Story 3 - [Brief Title] (Priority: P3)
|
|
53
|
+
|
|
54
|
+
[Describe this user journey in plain language]
|
|
55
|
+
|
|
56
|
+
**Why this priority**: [Explain the value and why it has this priority level]
|
|
57
|
+
|
|
58
|
+
**Independent Test**: [Describe how this can be tested independently]
|
|
59
|
+
|
|
60
|
+
**Acceptance Scenarios**:
|
|
61
|
+
|
|
62
|
+
1. **Given** [initial state], **When** [action], **Then** [expected outcome]
|
|
63
|
+
|
|
64
|
+
---
|
|
65
|
+
|
|
66
|
+
[Add more user stories as needed, each with an assigned priority]
|
|
67
|
+
|
|
68
|
+
### Edge Cases
|
|
69
|
+
|
|
70
|
+
<!--
|
|
71
|
+
ACTION REQUIRED: The content in this section represents placeholders.
|
|
72
|
+
Fill them out with the right edge cases.
|
|
73
|
+
-->
|
|
74
|
+
|
|
75
|
+
- What happens when [boundary condition]?
|
|
76
|
+
- How does system handle [error scenario]?
|
|
77
|
+
|
|
78
|
+
## Requirements _(mandatory)_
|
|
79
|
+
|
|
80
|
+
<!--
|
|
81
|
+
ACTION REQUIRED: The content in this section represents placeholders.
|
|
82
|
+
Fill them out with the right functional requirements.
|
|
83
|
+
-->
|
|
84
|
+
|
|
85
|
+
### Functional Requirements
|
|
86
|
+
|
|
87
|
+
- **FR-001**: System MUST [specific capability, e.g., "allow users to create accounts"]
|
|
88
|
+
- **FR-002**: System MUST [specific capability, e.g., "validate email addresses"]
|
|
89
|
+
- **FR-003**: Users MUST be able to [key interaction, e.g., "reset their password"]
|
|
90
|
+
- **FR-004**: System MUST [data requirement, e.g., "persist user preferences"]
|
|
91
|
+
- **FR-005**: System MUST [behavior, e.g., "log all security events"]
|
|
92
|
+
|
|
93
|
+
_Example of marking unclear requirements:_
|
|
94
|
+
|
|
95
|
+
- **FR-006**: System MUST authenticate users via [NEEDS CLARIFICATION: auth method not specified - email/password, SSO, OAuth?]
|
|
96
|
+
- **FR-007**: System MUST retain user data for [NEEDS CLARIFICATION: retention period not specified]
|
|
97
|
+
|
|
98
|
+
### Key Entities _(include if feature involves data)_
|
|
99
|
+
|
|
100
|
+
- **[Entity 1]**: [What it represents, key attributes without implementation]
|
|
101
|
+
- **[Entity 2]**: [What it represents, relationships to other entities]
|
|
102
|
+
|
|
103
|
+
## Success Criteria _(mandatory)_
|
|
104
|
+
|
|
105
|
+
<!--
|
|
106
|
+
ACTION REQUIRED: Define measurable success criteria.
|
|
107
|
+
These must be technology-agnostic and measurable.
|
|
108
|
+
-->
|
|
109
|
+
|
|
110
|
+
### Measurable Outcomes
|
|
111
|
+
|
|
112
|
+
- **SC-001**: [Measurable metric, e.g., "Users can complete account creation in under 2 minutes"]
|
|
113
|
+
- **SC-002**: [Measurable metric, e.g., "System handles 1000 concurrent users without degradation"]
|
|
114
|
+
- **SC-003**: [User satisfaction metric, e.g., "90% of users successfully complete primary task on first attempt"]
|
|
115
|
+
- **SC-004**: [Business metric, e.g., "Reduce support tickets related to [X] by 50%"]
|
|
@@ -0,0 +1,250 @@
|
|
|
1
|
+
---
|
|
2
|
+
description: 'Task list template for feature implementation'
|
|
3
|
+
---
|
|
4
|
+
|
|
5
|
+
# Tasks: [FEATURE NAME]
|
|
6
|
+
|
|
7
|
+
**Input**: Design documents from `/specs/[###-feature-name]/`
|
|
8
|
+
**Prerequisites**: plan.md (required), spec.md (required for user stories), research.md, data-model.md, contracts/
|
|
9
|
+
|
|
10
|
+
**Tests**: The examples below include test tasks. Tests are OPTIONAL - only include them if explicitly requested in the feature specification.
|
|
11
|
+
|
|
12
|
+
**Organization**: Tasks are grouped by user story to enable independent implementation and testing of each story.
|
|
13
|
+
|
|
14
|
+
## Format: `[ID] [P?] [Story] Description`
|
|
15
|
+
|
|
16
|
+
- **[P]**: Can run in parallel (different files, no dependencies)
|
|
17
|
+
- **[Story]**: Which user story this task belongs to (e.g., US1, US2, US3)
|
|
18
|
+
- Include exact file paths in descriptions
|
|
19
|
+
|
|
20
|
+
## Path Conventions
|
|
21
|
+
|
|
22
|
+
- **Single project**: `src/`, `tests/` at repository root
|
|
23
|
+
- **Web app**: `backend/src/`, `frontend/src/`
|
|
24
|
+
- **Mobile**: `api/src/`, `ios/src/` or `android/src/`
|
|
25
|
+
- Paths shown below assume single project - adjust based on plan.md structure
|
|
26
|
+
|
|
27
|
+
<!--
|
|
28
|
+
============================================================================
|
|
29
|
+
IMPORTANT: The tasks below are SAMPLE TASKS for illustration purposes only.
|
|
30
|
+
|
|
31
|
+
The /speckit.tasks command MUST replace these with actual tasks based on:
|
|
32
|
+
- User stories from spec.md (with their priorities P1, P2, P3...)
|
|
33
|
+
- Feature requirements from plan.md
|
|
34
|
+
- Entities from data-model.md
|
|
35
|
+
- Endpoints from contracts/
|
|
36
|
+
|
|
37
|
+
Tasks MUST be organized by user story so each story can be:
|
|
38
|
+
- Implemented independently
|
|
39
|
+
- Tested independently
|
|
40
|
+
- Delivered as an MVP increment
|
|
41
|
+
|
|
42
|
+
DO NOT keep these sample tasks in the generated tasks.md file.
|
|
43
|
+
============================================================================
|
|
44
|
+
-->
|
|
45
|
+
|
|
46
|
+
## Phase 1: Setup (Shared Infrastructure)
|
|
47
|
+
|
|
48
|
+
**Purpose**: Project initialization and basic structure
|
|
49
|
+
|
|
50
|
+
- [ ] T001 Create TypeScript CLI project structure (src/, dist/, package.json)
|
|
51
|
+
- [ ] T002 Initialize TypeScript with tsconfig.json and yarn dependencies
|
|
52
|
+
- [ ] T003 [P] Configure TypeScript strict mode and ESLint/Prettier
|
|
53
|
+
|
|
54
|
+
---
|
|
55
|
+
|
|
56
|
+
## Phase 2: Foundational (Blocking Prerequisites)
|
|
57
|
+
|
|
58
|
+
**Purpose**: Core infrastructure that MUST be complete before ANY user story can be implemented
|
|
59
|
+
|
|
60
|
+
**⚠️ CRITICAL**: No user story work can begin until this phase is complete
|
|
61
|
+
|
|
62
|
+
Examples of foundational tasks (adjust based on your CLI project):
|
|
63
|
+
|
|
64
|
+
- [ ] T004 Setup Commander.js CLI framework and main entry point (src/hsh.ts)
|
|
65
|
+
- [ ] T005 [P] Configure chalk for colored output and ora for progress indicators
|
|
66
|
+
- [ ] T006 [P] Setup inquirer for interactive prompts with validation
|
|
67
|
+
- [ ] T007 Create base types and interfaces in src/types/index.ts
|
|
68
|
+
- [ ] T008 Configure error handling with chalk colors and proper exit codes
|
|
69
|
+
- [ ] T009 Setup zx for shell operations and utility functions
|
|
70
|
+
|
|
71
|
+
**Checkpoint**: Foundation ready - user story implementation can now begin in parallel
|
|
72
|
+
|
|
73
|
+
---
|
|
74
|
+
|
|
75
|
+
## Phase 3: User Story 1 - [Title] (Priority: P1) 🎯 MVP
|
|
76
|
+
|
|
77
|
+
**Goal**: [Brief description of what this story delivers]
|
|
78
|
+
|
|
79
|
+
**Independent Test**: [How to verify this story works on its own]
|
|
80
|
+
|
|
81
|
+
### Tests for User Story 1 (OPTIONAL - only if tests requested) ⚠️
|
|
82
|
+
|
|
83
|
+
**NOTE: Write these tests FIRST, ensure they FAIL before implementation**
|
|
84
|
+
|
|
85
|
+
- [ ] T010 [P] [US1] CLI command test for [command] in tests/integration/test\_[name].ts
|
|
86
|
+
- [ ] T011 [P] [US1] Unit tests for [function] in tests/unit/test\_[name].ts
|
|
87
|
+
|
|
88
|
+
### Implementation for User Story 1
|
|
89
|
+
|
|
90
|
+
- [ ] T012 [P] [US1] Create command types in src/types/[command].ts
|
|
91
|
+
- [ ] T013 [P] [US1] Create utility functions in src/util.ts
|
|
92
|
+
- [ ] T014 [US1] Implement command logic in src/commands/[domain].ts (depends on T012, T013)
|
|
93
|
+
- [ ] T015 [US1] Implement CLI interface in src/hsh.ts
|
|
94
|
+
- [ ] T016 [US1] Add inquirer prompts with validation
|
|
95
|
+
- [ ] T017 [US1] Add chalk output and error handling
|
|
96
|
+
|
|
97
|
+
**Checkpoint**: At this point, User Story 1 should be fully functional and testable independently
|
|
98
|
+
|
|
99
|
+
---
|
|
100
|
+
|
|
101
|
+
## Phase 4: User Story 2 - [Title] (Priority: P2)
|
|
102
|
+
|
|
103
|
+
**Goal**: [Brief description of what this story delivers]
|
|
104
|
+
|
|
105
|
+
**Independent Test**: [How to verify this story works on its own]
|
|
106
|
+
|
|
107
|
+
### Tests for User Story 2 (OPTIONAL - only if tests requested) ⚠️
|
|
108
|
+
|
|
109
|
+
- [ ] T018 [P] [US2] Contract test for [endpoint] in tests/contract/test\_[name].py
|
|
110
|
+
- [ ] T019 [P] [US2] Integration test for [user journey] in tests/integration/test\_[name].py
|
|
111
|
+
|
|
112
|
+
### Implementation for User Story 2
|
|
113
|
+
|
|
114
|
+
- [ ] T020 [P] [US2] Create [Entity] model in src/models/[entity].py
|
|
115
|
+
- [ ] T021 [US2] Implement [Service] in src/services/[service].py
|
|
116
|
+
- [ ] T022 [US2] Implement [endpoint/feature] in src/[location]/[file].py
|
|
117
|
+
- [ ] T023 [US2] Integrate with User Story 1 components (if needed)
|
|
118
|
+
|
|
119
|
+
**Checkpoint**: At this point, User Stories 1 AND 2 should both work independently
|
|
120
|
+
|
|
121
|
+
---
|
|
122
|
+
|
|
123
|
+
## Phase 5: User Story 3 - [Title] (Priority: P3)
|
|
124
|
+
|
|
125
|
+
**Goal**: [Brief description of what this story delivers]
|
|
126
|
+
|
|
127
|
+
**Independent Test**: [How to verify this story works on its own]
|
|
128
|
+
|
|
129
|
+
### Tests for User Story 3 (OPTIONAL - only if tests requested) ⚠️
|
|
130
|
+
|
|
131
|
+
- [ ] T024 [P] [US3] Contract test for [endpoint] in tests/contract/test\_[name].py
|
|
132
|
+
- [ ] T025 [P] [US3] Integration test for [user journey] in tests/integration/test\_[name].py
|
|
133
|
+
|
|
134
|
+
### Implementation for User Story 3
|
|
135
|
+
|
|
136
|
+
- [ ] T026 [P] [US3] Create [Entity] model in src/models/[entity].py
|
|
137
|
+
- [ ] T027 [US3] Implement [Service] in src/services/[service].py
|
|
138
|
+
- [ ] T028 [US3] Implement [endpoint/feature] in src/[location]/[file].py
|
|
139
|
+
|
|
140
|
+
**Checkpoint**: All user stories should now be independently functional
|
|
141
|
+
|
|
142
|
+
---
|
|
143
|
+
|
|
144
|
+
[Add more user story phases as needed, following the same pattern]
|
|
145
|
+
|
|
146
|
+
---
|
|
147
|
+
|
|
148
|
+
## Phase N: Polish & Cross-Cutting Concerns
|
|
149
|
+
|
|
150
|
+
**Purpose**: Improvements that affect multiple user stories
|
|
151
|
+
|
|
152
|
+
- [ ] TXXX [P] Documentation updates in docs/
|
|
153
|
+
- [ ] TXXX Code cleanup and refactoring
|
|
154
|
+
- [ ] TXXX Performance optimization across all stories
|
|
155
|
+
- [ ] TXXX [P] Additional unit tests (if requested) in tests/unit/
|
|
156
|
+
- [ ] TXXX Security hardening
|
|
157
|
+
- [ ] TXXX Run quickstart.md validation
|
|
158
|
+
|
|
159
|
+
---
|
|
160
|
+
|
|
161
|
+
## Dependencies & Execution Order
|
|
162
|
+
|
|
163
|
+
### Phase Dependencies
|
|
164
|
+
|
|
165
|
+
- **Setup (Phase 1)**: No dependencies - can start immediately
|
|
166
|
+
- **Foundational (Phase 2)**: Depends on Setup completion - BLOCKS all user stories
|
|
167
|
+
- **User Stories (Phase 3+)**: All depend on Foundational phase completion
|
|
168
|
+
- User stories can then proceed in parallel (if staffed)
|
|
169
|
+
- Or sequentially in priority order (P1 → P2 → P3)
|
|
170
|
+
- **Polish (Final Phase)**: Depends on all desired user stories being complete
|
|
171
|
+
|
|
172
|
+
### User Story Dependencies
|
|
173
|
+
|
|
174
|
+
- **User Story 1 (P1)**: Can start after Foundational (Phase 2) - No dependencies on other stories
|
|
175
|
+
- **User Story 2 (P2)**: Can start after Foundational (Phase 2) - May integrate with US1 but should be independently testable
|
|
176
|
+
- **User Story 3 (P3)**: Can start after Foundational (Phase 2) - May integrate with US1/US2 but should be independently testable
|
|
177
|
+
|
|
178
|
+
### Within Each User Story
|
|
179
|
+
|
|
180
|
+
- Tests (if included) MUST be written and FAIL before implementation
|
|
181
|
+
- Models before services
|
|
182
|
+
- Services before endpoints
|
|
183
|
+
- Core implementation before integration
|
|
184
|
+
- Story complete before moving to next priority
|
|
185
|
+
|
|
186
|
+
### Parallel Opportunities
|
|
187
|
+
|
|
188
|
+
- All Setup tasks marked [P] can run in parallel
|
|
189
|
+
- All Foundational tasks marked [P] can run in parallel (within Phase 2)
|
|
190
|
+
- Once Foundational phase completes, all user stories can start in parallel (if team capacity allows)
|
|
191
|
+
- All tests for a user story marked [P] can run in parallel
|
|
192
|
+
- Models within a story marked [P] can run in parallel
|
|
193
|
+
- Different user stories can be worked on in parallel by different team members
|
|
194
|
+
|
|
195
|
+
---
|
|
196
|
+
|
|
197
|
+
## Parallel Example: User Story 1
|
|
198
|
+
|
|
199
|
+
```bash
|
|
200
|
+
# Launch all tests for User Story 1 together (if tests requested):
|
|
201
|
+
Task: "Contract test for [endpoint] in tests/contract/test_[name].py"
|
|
202
|
+
Task: "Integration test for [user journey] in tests/integration/test_[name].py"
|
|
203
|
+
|
|
204
|
+
# Launch all models for User Story 1 together:
|
|
205
|
+
Task: "Create [Entity1] model in src/models/[entity1].py"
|
|
206
|
+
Task: "Create [Entity2] model in src/models/[entity2].py"
|
|
207
|
+
```
|
|
208
|
+
|
|
209
|
+
---
|
|
210
|
+
|
|
211
|
+
## Implementation Strategy
|
|
212
|
+
|
|
213
|
+
### MVP First (User Story 1 Only)
|
|
214
|
+
|
|
215
|
+
1. Complete Phase 1: Setup
|
|
216
|
+
2. Complete Phase 2: Foundational (CRITICAL - blocks all stories)
|
|
217
|
+
3. Complete Phase 3: User Story 1
|
|
218
|
+
4. **STOP and VALIDATE**: Test User Story 1 independently
|
|
219
|
+
5. Deploy/demo if ready
|
|
220
|
+
|
|
221
|
+
### Incremental Delivery
|
|
222
|
+
|
|
223
|
+
1. Complete Setup + Foundational → Foundation ready
|
|
224
|
+
2. Add User Story 1 → Test independently → Deploy/Demo (MVP!)
|
|
225
|
+
3. Add User Story 2 → Test independently → Deploy/Demo
|
|
226
|
+
4. Add User Story 3 → Test independently → Deploy/Demo
|
|
227
|
+
5. Each story adds value without breaking previous stories
|
|
228
|
+
|
|
229
|
+
### Parallel Team Strategy
|
|
230
|
+
|
|
231
|
+
With multiple developers:
|
|
232
|
+
|
|
233
|
+
1. Team completes Setup + Foundational together
|
|
234
|
+
2. Once Foundational is done:
|
|
235
|
+
- Developer A: User Story 1
|
|
236
|
+
- Developer B: User Story 2
|
|
237
|
+
- Developer C: User Story 3
|
|
238
|
+
3. Stories complete and integrate independently
|
|
239
|
+
|
|
240
|
+
---
|
|
241
|
+
|
|
242
|
+
## Notes
|
|
243
|
+
|
|
244
|
+
- [P] tasks = different files, no dependencies
|
|
245
|
+
- [Story] label maps task to specific user story for traceability
|
|
246
|
+
- Each user story should be independently completable and testable
|
|
247
|
+
- Verify tests fail before implementing
|
|
248
|
+
- Commit after each task or logical group
|
|
249
|
+
- Stop at any checkpoint to validate story independently
|
|
250
|
+
- Avoid: vague tasks, same file conflicts, cross-story dependencies that break independence
|