specweave 0.1.4 → 0.1.6
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/README.md +162 -243
- package/SPECWEAVE.md +14 -12
- package/dist/cli/commands/init.d.ts.map +1 -1
- package/dist/cli/commands/init.js +42 -26
- package/dist/cli/commands/init.js.map +1 -1
- package/package.json +1 -1
- package/src/commands/README.md +171 -0
- package/src/commands/at.md +114 -0
- package/src/commands/ci.md +63 -0
- package/src/commands/done.md +103 -0
- package/src/commands/init.md +123 -0
- package/src/commands/ls.md +100 -0
- package/src/commands/si.md +83 -0
- package/src/commands/vi.md +89 -0
- package/src/skills/specweave-detector/SKILL.md +137 -178
- package/src/templates/CLAUDE.md.template +29 -26
- package/src/templates/README.md.template +7 -7
|
@@ -0,0 +1,123 @@
|
|
|
1
|
+
---
|
|
2
|
+
description: 🔥 Shorthand for /create-project - Initialize SpecWeave project (Alias)
|
|
3
|
+
---
|
|
4
|
+
|
|
5
|
+
# Initialize Project (Short Alias)
|
|
6
|
+
|
|
7
|
+
**⚡ Quick Alias**: This is a shorthand command for `/create-project`.
|
|
8
|
+
|
|
9
|
+
Use this when you want to quickly initialize a new SpecWeave project without typing the full command name.
|
|
10
|
+
|
|
11
|
+
---
|
|
12
|
+
|
|
13
|
+
## Full Command
|
|
14
|
+
|
|
15
|
+
For complete documentation, see `/create-project`.
|
|
16
|
+
|
|
17
|
+
This alias provides the exact same functionality as the full command.
|
|
18
|
+
|
|
19
|
+
---
|
|
20
|
+
|
|
21
|
+
## Usage
|
|
22
|
+
|
|
23
|
+
```bash
|
|
24
|
+
/init [project-name] [--type=<stack>]
|
|
25
|
+
```
|
|
26
|
+
|
|
27
|
+
**Examples**:
|
|
28
|
+
```bash
|
|
29
|
+
/init # Interactive prompts
|
|
30
|
+
/init my-saas # Auto-detect tech stack
|
|
31
|
+
/init my-api --type=python # Specify Python
|
|
32
|
+
/init my-app --type=nextjs # Specify Next.js
|
|
33
|
+
```
|
|
34
|
+
|
|
35
|
+
---
|
|
36
|
+
|
|
37
|
+
## What This Does
|
|
38
|
+
|
|
39
|
+
1. **Creates directory structure**:
|
|
40
|
+
```
|
|
41
|
+
my-project/
|
|
42
|
+
├── .specweave/
|
|
43
|
+
│ ├── config.yaml
|
|
44
|
+
│ ├── docs/
|
|
45
|
+
│ ├── increments/
|
|
46
|
+
│ └── tests/
|
|
47
|
+
├── .claude/
|
|
48
|
+
│ ├── commands/
|
|
49
|
+
│ ├── skills/ # Auto-install on demand
|
|
50
|
+
│ └── agents/ # Auto-install on demand
|
|
51
|
+
├── CLAUDE.md
|
|
52
|
+
└── README.md
|
|
53
|
+
```
|
|
54
|
+
|
|
55
|
+
2. **Detects tech stack** (or uses `--type` flag):
|
|
56
|
+
- TypeScript/JavaScript → Next.js, Node.js, React
|
|
57
|
+
- Python → FastAPI, Django, Flask
|
|
58
|
+
- Go → Gin, Echo, standard library
|
|
59
|
+
- .NET → ASP.NET Core
|
|
60
|
+
- Java → Spring Boot
|
|
61
|
+
|
|
62
|
+
3. **Auto-installs components** based on your first request:
|
|
63
|
+
```
|
|
64
|
+
User: "Create Next.js authentication"
|
|
65
|
+
|
|
66
|
+
📦 Installing required components...
|
|
67
|
+
✅ nextjs skill
|
|
68
|
+
✅ nodejs-backend skill
|
|
69
|
+
✅ security agent
|
|
70
|
+
✅ pm agent
|
|
71
|
+
```
|
|
72
|
+
|
|
73
|
+
4. **Initializes git** (if git available)
|
|
74
|
+
|
|
75
|
+
5. **Shows next steps**
|
|
76
|
+
|
|
77
|
+
---
|
|
78
|
+
|
|
79
|
+
## Tech Stack Detection
|
|
80
|
+
|
|
81
|
+
**Auto-detected from**:
|
|
82
|
+
- `package.json` (JavaScript/TypeScript)
|
|
83
|
+
- `requirements.txt`, `pyproject.toml` (Python)
|
|
84
|
+
- `go.mod` (Go)
|
|
85
|
+
- `*.csproj` (.NET)
|
|
86
|
+
- `pom.xml`, `build.gradle` (Java)
|
|
87
|
+
|
|
88
|
+
**Manual specification**:
|
|
89
|
+
```bash
|
|
90
|
+
/init --type=nextjs # Next.js + TypeScript
|
|
91
|
+
/init --type=python # Python (FastAPI default)
|
|
92
|
+
/init --type=django # Django specifically
|
|
93
|
+
/init --type=dotnet # ASP.NET Core
|
|
94
|
+
```
|
|
95
|
+
|
|
96
|
+
---
|
|
97
|
+
|
|
98
|
+
## After Initialization
|
|
99
|
+
|
|
100
|
+
**Start building immediately**:
|
|
101
|
+
```bash
|
|
102
|
+
cd my-project
|
|
103
|
+
/ci "User authentication" # Create first increment
|
|
104
|
+
```
|
|
105
|
+
|
|
106
|
+
SpecWeave will:
|
|
107
|
+
1. Detect you need auth components
|
|
108
|
+
2. Auto-install: `security` agent, `nodejs-backend` skill
|
|
109
|
+
3. Generate specs, plan, tasks
|
|
110
|
+
4. Ready to implement!
|
|
111
|
+
|
|
112
|
+
---
|
|
113
|
+
|
|
114
|
+
## Other Useful Aliases
|
|
115
|
+
|
|
116
|
+
- `/ci` - Create increment (shorthand for `/create-increment`)
|
|
117
|
+
- `/si` - Start increment (shorthand for `/start-increment`)
|
|
118
|
+
- `/vi` - Validate increment (shorthand for `/validate-increment`)
|
|
119
|
+
- `/ls` - List increments (shorthand for `/list-increments`)
|
|
120
|
+
|
|
121
|
+
---
|
|
122
|
+
|
|
123
|
+
**💡 Tip**: No need to pre-install components - they install on-demand!
|
|
@@ -0,0 +1,100 @@
|
|
|
1
|
+
---
|
|
2
|
+
description: 🔥 Shorthand for /list-increments - List all increments (Alias)
|
|
3
|
+
---
|
|
4
|
+
|
|
5
|
+
# List Increments (Short Alias)
|
|
6
|
+
|
|
7
|
+
**⚡ Quick Alias**: This is a shorthand command for `/list-increments`.
|
|
8
|
+
|
|
9
|
+
Use this when you want to quickly list increments without typing the full command name.
|
|
10
|
+
|
|
11
|
+
---
|
|
12
|
+
|
|
13
|
+
## Full Command
|
|
14
|
+
|
|
15
|
+
For complete documentation, see `/list-increments`.
|
|
16
|
+
|
|
17
|
+
This alias provides the exact same functionality as the full command.
|
|
18
|
+
|
|
19
|
+
---
|
|
20
|
+
|
|
21
|
+
## Usage
|
|
22
|
+
|
|
23
|
+
```bash
|
|
24
|
+
/ls [--status=<status>] [--format=<format>]
|
|
25
|
+
```
|
|
26
|
+
|
|
27
|
+
**Examples**:
|
|
28
|
+
```bash
|
|
29
|
+
/ls # All increments
|
|
30
|
+
/ls --status=in-progress # Only in-progress
|
|
31
|
+
/ls --status=planned # Only planned
|
|
32
|
+
/ls --format=detailed # Detailed view
|
|
33
|
+
```
|
|
34
|
+
|
|
35
|
+
---
|
|
36
|
+
|
|
37
|
+
## What This Shows
|
|
38
|
+
|
|
39
|
+
**Default View** (Summary):
|
|
40
|
+
```
|
|
41
|
+
📋 SpecWeave Increments
|
|
42
|
+
|
|
43
|
+
Status: in-progress (2) | planned (3) | completed (5) | closed (4)
|
|
44
|
+
|
|
45
|
+
In Progress:
|
|
46
|
+
0012-user-authentication [████████░░] 80% (8/10 tasks)
|
|
47
|
+
0013-payment-integration [███░░░░░░░] 30% (3/10 tasks)
|
|
48
|
+
|
|
49
|
+
Planned:
|
|
50
|
+
0014-admin-dashboard [░░░░░░░░░░] 0% (0/15 tasks)
|
|
51
|
+
0015-analytics-module [░░░░░░░░░░] 0% (0/12 tasks)
|
|
52
|
+
```
|
|
53
|
+
|
|
54
|
+
**Detailed View** (`--format=detailed`):
|
|
55
|
+
Shows full spec summary, architecture approach, test coverage, etc.
|
|
56
|
+
|
|
57
|
+
---
|
|
58
|
+
|
|
59
|
+
## Status Filters
|
|
60
|
+
|
|
61
|
+
| Status | Description | Alias |
|
|
62
|
+
|--------|-------------|-------|
|
|
63
|
+
| `backlog` | Not yet planned | Ideas, proposals |
|
|
64
|
+
| `planned` | Spec created, not started | Ready to work |
|
|
65
|
+
| `in-progress` | Active work | Currently implementing |
|
|
66
|
+
| `completed` | Tasks done, ready to close | Awaiting review/merge |
|
|
67
|
+
| `closed` | Finished and archived | Done |
|
|
68
|
+
|
|
69
|
+
---
|
|
70
|
+
|
|
71
|
+
## Typical Usage
|
|
72
|
+
|
|
73
|
+
**Quick check**:
|
|
74
|
+
```bash
|
|
75
|
+
/ls --status=in-progress # What am I working on?
|
|
76
|
+
```
|
|
77
|
+
|
|
78
|
+
**Planning**:
|
|
79
|
+
```bash
|
|
80
|
+
/ls --status=planned # What's next?
|
|
81
|
+
```
|
|
82
|
+
|
|
83
|
+
**Review**:
|
|
84
|
+
```bash
|
|
85
|
+
/ls --format=detailed # Full increment overview
|
|
86
|
+
```
|
|
87
|
+
|
|
88
|
+
---
|
|
89
|
+
|
|
90
|
+
## Other Useful Aliases
|
|
91
|
+
|
|
92
|
+
- `/ci` - Create increment (shorthand for `/create-increment`)
|
|
93
|
+
- `/si` - Start increment (shorthand for `/start-increment`)
|
|
94
|
+
- `/vi` - Validate increment (shorthand for `/validate-increment`)
|
|
95
|
+
- `/done` - Close increment (shorthand for `/close-increment`)
|
|
96
|
+
- `/at` - Add tasks (shorthand for `/add-tasks`)
|
|
97
|
+
|
|
98
|
+
---
|
|
99
|
+
|
|
100
|
+
**💡 Tip**: Use `/ls` daily to track progress across all increments.
|
|
@@ -0,0 +1,83 @@
|
|
|
1
|
+
---
|
|
2
|
+
description: 🔥 Shorthand for /start-increment - Start working on increment (Alias)
|
|
3
|
+
---
|
|
4
|
+
|
|
5
|
+
# Start Increment (Short Alias)
|
|
6
|
+
|
|
7
|
+
**⚡ Quick Alias**: This is a shorthand command for `/start-increment`.
|
|
8
|
+
|
|
9
|
+
Use this when you want to quickly start working on an increment without typing the full command name.
|
|
10
|
+
|
|
11
|
+
---
|
|
12
|
+
|
|
13
|
+
## Full Command
|
|
14
|
+
|
|
15
|
+
For complete documentation, see `/start-increment`.
|
|
16
|
+
|
|
17
|
+
This alias provides the exact same functionality as the full command.
|
|
18
|
+
|
|
19
|
+
---
|
|
20
|
+
|
|
21
|
+
## Usage
|
|
22
|
+
|
|
23
|
+
```bash
|
|
24
|
+
/si <increment-id>
|
|
25
|
+
```
|
|
26
|
+
|
|
27
|
+
**Examples**:
|
|
28
|
+
```bash
|
|
29
|
+
/si 0001
|
|
30
|
+
/si 0042
|
|
31
|
+
/si 0123
|
|
32
|
+
```
|
|
33
|
+
|
|
34
|
+
---
|
|
35
|
+
|
|
36
|
+
## What This Does
|
|
37
|
+
|
|
38
|
+
1. **Updates status** to `in-progress` in `tasks.md`
|
|
39
|
+
2. **Loads context** via context-manifest.yaml
|
|
40
|
+
3. **Creates feature branch** (if git workflow enabled)
|
|
41
|
+
4. **Shows increment summary**:
|
|
42
|
+
- Spec highlights (user stories, goals)
|
|
43
|
+
- Architecture approach
|
|
44
|
+
- Task breakdown
|
|
45
|
+
- Test strategy
|
|
46
|
+
|
|
47
|
+
---
|
|
48
|
+
|
|
49
|
+
## Typical Workflow
|
|
50
|
+
|
|
51
|
+
```bash
|
|
52
|
+
# 1. Create increment
|
|
53
|
+
/ci "User authentication"
|
|
54
|
+
|
|
55
|
+
# 2. Review generated specs
|
|
56
|
+
# ... check spec.md, plan.md, tasks.md ...
|
|
57
|
+
|
|
58
|
+
# 3. Start working
|
|
59
|
+
/si 0001
|
|
60
|
+
|
|
61
|
+
# 4. Implement tasks
|
|
62
|
+
# ... write code, tests, docs ...
|
|
63
|
+
|
|
64
|
+
# 5. Validate quality
|
|
65
|
+
/vi 0001 --quality
|
|
66
|
+
|
|
67
|
+
# 6. Close when done
|
|
68
|
+
/done 0001
|
|
69
|
+
```
|
|
70
|
+
|
|
71
|
+
---
|
|
72
|
+
|
|
73
|
+
## Other Useful Aliases
|
|
74
|
+
|
|
75
|
+
- `/ci` - Create increment (shorthand for `/create-increment`)
|
|
76
|
+
- `/vi` - Validate increment (shorthand for `/validate-increment`)
|
|
77
|
+
- `/done` - Close increment (shorthand for `/close-increment`)
|
|
78
|
+
- `/ls` - List increments (shorthand for `/list-increments`)
|
|
79
|
+
- `/at` - Add tasks (shorthand for `/add-tasks`)
|
|
80
|
+
|
|
81
|
+
---
|
|
82
|
+
|
|
83
|
+
**💡 Tip**: Always validate (`/vi`) before starting to catch spec issues early.
|
|
@@ -0,0 +1,89 @@
|
|
|
1
|
+
---
|
|
2
|
+
description: 🔥 Shorthand for /validate-increment - Validate increment quality (Alias)
|
|
3
|
+
---
|
|
4
|
+
|
|
5
|
+
# Validate Increment (Short Alias)
|
|
6
|
+
|
|
7
|
+
**⚡ Quick Alias**: This is a shorthand command for `/validate-increment`.
|
|
8
|
+
|
|
9
|
+
Use this when you want to quickly validate an increment without typing the full command name.
|
|
10
|
+
|
|
11
|
+
---
|
|
12
|
+
|
|
13
|
+
## Full Command
|
|
14
|
+
|
|
15
|
+
For complete documentation, see `/validate-increment`.
|
|
16
|
+
|
|
17
|
+
This alias provides the exact same functionality as the full command.
|
|
18
|
+
|
|
19
|
+
---
|
|
20
|
+
|
|
21
|
+
## Usage
|
|
22
|
+
|
|
23
|
+
```bash
|
|
24
|
+
/vi [increment-id] [--quality]
|
|
25
|
+
```
|
|
26
|
+
|
|
27
|
+
**Examples**:
|
|
28
|
+
```bash
|
|
29
|
+
/vi 0001 # Rule-based validation only
|
|
30
|
+
/vi 0001 --quality # Rule-based + LLM quality assessment
|
|
31
|
+
/vi # Validate current increment
|
|
32
|
+
```
|
|
33
|
+
|
|
34
|
+
---
|
|
35
|
+
|
|
36
|
+
## What This Does
|
|
37
|
+
|
|
38
|
+
**Rule-Based Validation** (Always runs):
|
|
39
|
+
- ✅ 120 validation rules across 4 categories
|
|
40
|
+
- ✅ Consistency checks (Spec ↔ Plan ↔ Tasks alignment)
|
|
41
|
+
- ✅ Completeness checks (All required sections present)
|
|
42
|
+
- ✅ Quality checks (Technology-agnostic, testable criteria)
|
|
43
|
+
- ✅ Traceability checks (TC-0001 → tests.md coverage)
|
|
44
|
+
|
|
45
|
+
**LLM Quality Assessment** (With `--quality` flag):
|
|
46
|
+
- ✅ 6-dimension scoring (Clarity, Testability, Completeness, etc.)
|
|
47
|
+
- ✅ Actionable suggestions with examples
|
|
48
|
+
- ✅ Overall quality score (0-100)
|
|
49
|
+
- ✅ Issue severity ranking (major, minor)
|
|
50
|
+
|
|
51
|
+
---
|
|
52
|
+
|
|
53
|
+
## Validation Results
|
|
54
|
+
|
|
55
|
+
**Rule-Based Output**:
|
|
56
|
+
```
|
|
57
|
+
✅ Validation Results: 118/120 rules passed (98%)
|
|
58
|
+
|
|
59
|
+
Issues Found:
|
|
60
|
+
⚠️ [CONSISTENCY-012] Missing test case coverage for US-B003
|
|
61
|
+
⚠️ [QUALITY-008] Acceptance criteria not testable in spec.md:45
|
|
62
|
+
```
|
|
63
|
+
|
|
64
|
+
**Quality Assessment Output** (with `--quality`):
|
|
65
|
+
```
|
|
66
|
+
🔍 Quality Score: 87/100 (GOOD)
|
|
67
|
+
|
|
68
|
+
Dimension Scores:
|
|
69
|
+
• Clarity: 92/100 ✓✓
|
|
70
|
+
• Testability: 78/100 ✓ (Needs improvement)
|
|
71
|
+
• Completeness: 90/100 ✓✓
|
|
72
|
+
• Feasibility: 88/100 ✓✓
|
|
73
|
+
|
|
74
|
+
Issues: 2 major, 1 minor
|
|
75
|
+
Suggestions: 3 high priority improvements
|
|
76
|
+
```
|
|
77
|
+
|
|
78
|
+
---
|
|
79
|
+
|
|
80
|
+
## Other Useful Aliases
|
|
81
|
+
|
|
82
|
+
- `/ci` - Create increment (shorthand for `/create-increment`)
|
|
83
|
+
- `/si` - Start increment (shorthand for `/start-increment`)
|
|
84
|
+
- `/done` - Close increment (shorthand for `/close-increment`)
|
|
85
|
+
- `/ls` - List increments (shorthand for `/list-increments`)
|
|
86
|
+
|
|
87
|
+
---
|
|
88
|
+
|
|
89
|
+
**💡 Tip**: Use `/vi` for quick checks, `/vi --quality` before implementation.
|