superspec 0.1.0 → 0.1.2
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/LICENSE +1 -1
- package/README.md +333 -244
- package/dist/cli/index.js +0 -0
- package/package.json +2 -1
package/LICENSE
CHANGED
package/README.md
CHANGED
|
@@ -1,328 +1,417 @@
|
|
|
1
|
-
|
|
1
|
+
<div align="center">
|
|
2
|
+
|
|
3
|
+
<picture>
|
|
4
|
+
<source media="(prefers-color-scheme: dark)" srcset=".github/banner.svg">
|
|
5
|
+
<source media="(prefers-color-scheme: light)" srcset=".github/banner.svg">
|
|
6
|
+
<img src=".github/banner.svg" alt="SuperSpec - Spec-Driven Development Framework" width="100%">
|
|
7
|
+
</picture>
|
|
8
|
+
|
|
9
|
+
<br />
|
|
10
|
+
|
|
11
|
+
[](https://www.npmjs.com/package/superspec)
|
|
12
|
+
[](https://www.npmjs.com/package/superspec)
|
|
13
|
+
[](https://github.com/HankLiu447/superspec/actions/workflows/ci.yml)
|
|
14
|
+
[](https://opensource.org/licenses/MIT)
|
|
15
|
+
[](https://nodejs.org/)
|
|
16
|
+
[](https://www.typescriptlang.org/)
|
|
17
|
+
[](https://claude.ai/claude-code)
|
|
18
|
+
|
|
19
|
+
<br />
|
|
20
|
+
|
|
21
|
+
**Every Scenario becomes a test. Every test traces back to a Scenario.**
|
|
22
|
+
|
|
23
|
+
<br />
|
|
24
|
+
|
|
25
|
+
[Quick Start](#-quick-start) · [Documentation](#-documentation) · [CLI Reference](#-cli-commands) · [Contributing](#-contributing)
|
|
26
|
+
|
|
27
|
+
</div>
|
|
28
|
+
|
|
29
|
+
<br />
|
|
30
|
+
|
|
31
|
+
## Why SuperSpec?
|
|
32
|
+
|
|
33
|
+
Most development workflows suffer from **specification drift** — where documentation, tests, and code gradually become misaligned. SuperSpec solves this by establishing specifications as the **single source of truth** and enforcing bidirectional traceability between specs and tests.
|
|
34
|
+
|
|
35
|
+
<table>
|
|
36
|
+
<tr>
|
|
37
|
+
<td width="50%">
|
|
38
|
+
|
|
39
|
+
### ❌ Without SuperSpec
|
|
40
|
+
|
|
41
|
+
- Specs written once, then forgotten
|
|
42
|
+
- Tests don't match requirements
|
|
43
|
+
- "It works" without verification
|
|
44
|
+
- Changes break unknown features
|
|
45
|
+
- Documentation always outdated
|
|
46
|
+
|
|
47
|
+
</td>
|
|
48
|
+
<td width="50%">
|
|
49
|
+
|
|
50
|
+
### ✅ With SuperSpec
|
|
51
|
+
|
|
52
|
+
- Specs are living documents
|
|
53
|
+
- Every scenario = a test case
|
|
54
|
+
- Evidence-based completion
|
|
55
|
+
- Impact analysis before changes
|
|
56
|
+
- Documentation auto-maintained
|
|
57
|
+
|
|
58
|
+
</td>
|
|
59
|
+
</tr>
|
|
60
|
+
</table>
|
|
61
|
+
|
|
62
|
+
<br />
|
|
63
|
+
|
|
64
|
+
## ✨ Key Features
|
|
65
|
+
|
|
66
|
+
<table>
|
|
67
|
+
<tr>
|
|
68
|
+
<td align="center" width="25%">
|
|
69
|
+
<br />
|
|
70
|
+
<img src="https://img.icons8.com/fluency/48/document.png" width="36" />
|
|
71
|
+
<br /><br />
|
|
72
|
+
<strong>Spec-First</strong>
|
|
73
|
+
<br />
|
|
74
|
+
<sub>Specifications as single source of truth</sub>
|
|
75
|
+
<br /><br />
|
|
76
|
+
</td>
|
|
77
|
+
<td align="center" width="25%">
|
|
78
|
+
<br />
|
|
79
|
+
<img src="https://img.icons8.com/fluency/48/test-tube.png" width="36" />
|
|
80
|
+
<br /><br />
|
|
81
|
+
<strong>TDD Enforced</strong>
|
|
82
|
+
<br />
|
|
83
|
+
<sub>Write tests first, then implement</sub>
|
|
84
|
+
<br /><br />
|
|
85
|
+
</td>
|
|
86
|
+
<td align="center" width="25%">
|
|
87
|
+
<br />
|
|
88
|
+
<img src="https://img.icons8.com/fluency/48/artificial-intelligence.png" width="36" />
|
|
89
|
+
<br /><br />
|
|
90
|
+
<strong>AI-Powered</strong>
|
|
91
|
+
<br />
|
|
92
|
+
<sub>Claude Code skills integration</sub>
|
|
93
|
+
<br /><br />
|
|
94
|
+
</td>
|
|
95
|
+
<td align="center" width="25%">
|
|
96
|
+
<br />
|
|
97
|
+
<img src="https://img.icons8.com/fluency/48/checked-2.png" width="36" />
|
|
98
|
+
<br /><br />
|
|
99
|
+
<strong>Verified</strong>
|
|
100
|
+
<br />
|
|
101
|
+
<sub>Evidence before completion claims</sub>
|
|
102
|
+
<br /><br />
|
|
103
|
+
</td>
|
|
104
|
+
</tr>
|
|
105
|
+
</table>
|
|
106
|
+
|
|
107
|
+
<br />
|
|
108
|
+
|
|
109
|
+
## 🚀 Quick Start
|
|
2
110
|
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
|
|
111
|
+
```bash
|
|
112
|
+
# Install globally
|
|
113
|
+
npm install -g superspec
|
|
6
114
|
|
|
7
|
-
|
|
115
|
+
# Initialize in your project
|
|
116
|
+
cd your-project
|
|
117
|
+
superspec init
|
|
8
118
|
|
|
9
|
-
|
|
10
|
-
|
|
119
|
+
# Start developing with Claude Code
|
|
120
|
+
/superspec:kickoff
|
|
11
121
|
```
|
|
12
122
|
|
|
13
|
-
|
|
14
|
-
|-----------|-------------|
|
|
15
|
-
| **Specs First** | All development has Specs as the single source of truth |
|
|
16
|
-
| **TDD Enforced** | Write tests first, watch them fail, then implement |
|
|
17
|
-
| **Two-Phase Review** | Spec Compliance Review → Code Quality Review |
|
|
18
|
-
| **Evidence First** | Verification over claims |
|
|
19
|
-
| **Delta Tracking** | Structured change history |
|
|
20
|
-
| **Archive Preservation** | Complete development documentation |
|
|
123
|
+
That's it! SuperSpec will guide you through the entire development workflow.
|
|
21
124
|
|
|
22
|
-
|
|
125
|
+
<br />
|
|
23
126
|
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
├─────────────────────────────────────────────────────────────────────────┤
|
|
28
|
-
│ /superspec:brainstorm → Progressive design (Explore → Propose → Spec)│
|
|
29
|
-
│ ↓ │
|
|
30
|
-
│ superspec validate → Validate specs (CLI) + team review │
|
|
31
|
-
│ ↓ │
|
|
32
|
-
│ /superspec:plan → Create TDD implementation plan │
|
|
33
|
-
└─────────────────────────────────────────────────────────────────────────┘
|
|
34
|
-
|
|
35
|
-
┌─────────────────────────────────────────────────────────────────────────┐
|
|
36
|
-
│ FAST TRACK (small-medium features) │
|
|
37
|
-
├─────────────────────────────────────────────────────────────────────────┤
|
|
38
|
-
│ /superspec:kickoff → All-in-one: brainstorm + validate + plan │
|
|
39
|
-
└─────────────────────────────────────────────────────────────────────────┘
|
|
40
|
-
|
|
41
|
-
↓ (both paths continue)
|
|
42
|
-
|
|
43
|
-
/superspec:execute Subagent-driven TDD implementation
|
|
44
|
-
↓
|
|
45
|
-
/superspec:verify Verify implementation matches specs
|
|
46
|
-
↓
|
|
47
|
-
/superspec:finish-branch Complete branch (merge/PR)
|
|
48
|
-
↓
|
|
49
|
-
/superspec:archive Archive changes, apply Delta
|
|
50
|
-
```
|
|
127
|
+
## 📖 Documentation
|
|
128
|
+
|
|
129
|
+
### The Four Iron Rules
|
|
51
130
|
|
|
52
|
-
|
|
131
|
+
| Rule | Principle |
|
|
132
|
+
|:-----|:----------|
|
|
133
|
+
| **TDD Rule** | No production code without a failing test first |
|
|
134
|
+
| **Spec Rule** | Specs are truth. Changes are proposals. |
|
|
135
|
+
| **SuperSpec Rule** | Every Scenario becomes a test. Every test traces to a Scenario. |
|
|
136
|
+
| **Verification Rule** | No completion claims without fresh verification evidence |
|
|
137
|
+
|
|
138
|
+
<br />
|
|
139
|
+
|
|
140
|
+
### Workflow Overview
|
|
53
141
|
|
|
54
142
|
```
|
|
55
|
-
|
|
56
|
-
|
|
57
|
-
|
|
58
|
-
|
|
59
|
-
|
|
60
|
-
|
|
61
|
-
|
|
62
|
-
|
|
63
|
-
|
|
64
|
-
|
|
65
|
-
|
|
66
|
-
|
|
67
|
-
|
|
68
|
-
|
|
69
|
-
|
|
70
|
-
|
|
71
|
-
|
|
72
|
-
|
|
73
|
-
|
|
74
|
-
|
|
75
|
-
|
|
76
|
-
|
|
77
|
-
|
|
78
|
-
|
|
79
|
-
|
|
80
|
-
| | Approach is decided |
|
|
81
|
-
| v |
|
|
82
|
-
| |
|
|
83
|
-
| Phase 4: SPEC -> specs/*.md |
|
|
84
|
-
| - Define Requirements (System SHALL...) |
|
|
85
|
-
| - Define Scenarios (WHEN/THEN -> each becomes a test) |
|
|
86
|
-
| |
|
|
87
|
-
+----------------------------------------------------------+
|
|
143
|
+
┌─────────────────────────────────────────────────────────────────────┐
|
|
144
|
+
│ Choose Your Path │
|
|
145
|
+
├─────────────────────────────────────────────────────────────────────┤
|
|
146
|
+
│ │
|
|
147
|
+
│ 🚀 FAST TRACK (small-medium features) │
|
|
148
|
+
│ /superspec:kickoff → All-in-one: brainstorm + validate + plan │
|
|
149
|
+
│ │
|
|
150
|
+
│ 📋 FULL WORKFLOW (large features, team review) │
|
|
151
|
+
│ /superspec:brainstorm → Progressive 4-phase design │
|
|
152
|
+
│ superspec validate → CLI validation + team review │
|
|
153
|
+
│ /superspec:plan → Create TDD implementation plan │
|
|
154
|
+
│ │
|
|
155
|
+
└─────────────────────────────────────────────────────────────────────┘
|
|
156
|
+
│
|
|
157
|
+
▼
|
|
158
|
+
┌─────────────────────────────────────────────────────────────────────┐
|
|
159
|
+
│ Implementation (both paths) │
|
|
160
|
+
├─────────────────────────────────────────────────────────────────────┤
|
|
161
|
+
│ │
|
|
162
|
+
│ /superspec:execute → Subagent-driven TDD implementation │
|
|
163
|
+
│ /superspec:verify → Verify implementation matches specs│
|
|
164
|
+
│ /superspec:finish-branch → Complete branch (merge/PR) │
|
|
165
|
+
│ /superspec:archive → Archive changes, apply delta │
|
|
166
|
+
│ │
|
|
167
|
+
└─────────────────────────────────────────────────────────────────────┘
|
|
88
168
|
```
|
|
89
169
|
|
|
90
|
-
|
|
170
|
+
<br />
|
|
91
171
|
|
|
92
|
-
###
|
|
172
|
+
### Four-Phase Brainstorming
|
|
93
173
|
|
|
94
|
-
|
|
95
|
-
|
|
96
|
-
npm install -g superspec
|
|
174
|
+
<details>
|
|
175
|
+
<summary><strong>Phase 1: EXPLORE</strong> — Understand the problem</summary>
|
|
97
176
|
|
|
98
|
-
|
|
99
|
-
|
|
100
|
-
|
|
101
|
-
|
|
102
|
-
|
|
103
|
-
|
|
104
|
-
|
|
177
|
+
- Free exploration and discovery
|
|
178
|
+
- Ask clarifying questions
|
|
179
|
+
- Visualize ideas and constraints
|
|
180
|
+
- No commitments yet
|
|
181
|
+
|
|
182
|
+
</details>
|
|
183
|
+
|
|
184
|
+
<details>
|
|
185
|
+
<summary><strong>Phase 2: PROPOSE</strong> — Define scope → <code>proposal.md</code></summary>
|
|
186
|
+
|
|
187
|
+
- **Why**: Problem or opportunity statement
|
|
188
|
+
- **What Changes**: List of modifications
|
|
189
|
+
- **Capabilities**: New or modified features
|
|
190
|
+
- **Impact**: Affected areas of the system
|
|
191
|
+
|
|
192
|
+
</details>
|
|
193
|
+
|
|
194
|
+
<details>
|
|
195
|
+
<summary><strong>Phase 3: DESIGN</strong> — Technical approach → <code>design.md</code></summary>
|
|
196
|
+
|
|
197
|
+
- Compare 2-3 technical approaches
|
|
198
|
+
- Document trade-offs
|
|
199
|
+
- Select and justify the recommended approach
|
|
200
|
+
|
|
201
|
+
</details>
|
|
202
|
+
|
|
203
|
+
<details>
|
|
204
|
+
<summary><strong>Phase 4: SPEC</strong> — Requirements & scenarios → <code>specs/*.md</code></summary>
|
|
105
205
|
|
|
106
|
-
|
|
206
|
+
- Define Requirements (`System SHALL...`)
|
|
207
|
+
- Define Scenarios (`WHEN/THEN` — each becomes a test)
|
|
107
208
|
|
|
108
|
-
|
|
209
|
+
</details>
|
|
109
210
|
|
|
110
|
-
|
|
211
|
+
<br />
|
|
212
|
+
|
|
213
|
+
## 💻 CLI Commands
|
|
214
|
+
|
|
215
|
+
### Project Management
|
|
111
216
|
|
|
112
217
|
```bash
|
|
113
|
-
superspec init
|
|
218
|
+
superspec init [path] # Initialize SuperSpec in a project
|
|
219
|
+
superspec view # Dashboard overview
|
|
220
|
+
superspec list # List all changes
|
|
221
|
+
superspec list --specs # List all specifications
|
|
222
|
+
superspec show <item> # Show details of a change or spec
|
|
114
223
|
```
|
|
115
224
|
|
|
116
|
-
|
|
117
|
-
|
|
118
|
-
|
|
119
|
-
|
|
120
|
-
|
|
121
|
-
|
|
122
|
-
|
|
225
|
+
### Validation & Verification
|
|
226
|
+
|
|
227
|
+
```bash
|
|
228
|
+
superspec validate <id> # Validate a specification
|
|
229
|
+
superspec validate <id> --strict # Strict mode (warnings = errors)
|
|
230
|
+
superspec verify <id> # Verify implementation matches specs
|
|
231
|
+
superspec verify <id> --verbose # Show detailed matching info
|
|
123
232
|
```
|
|
124
233
|
|
|
125
|
-
###
|
|
234
|
+
### Archiving
|
|
126
235
|
|
|
127
236
|
```bash
|
|
128
|
-
|
|
129
|
-
|
|
130
|
-
|
|
131
|
-
# OR FULL WORKFLOW: Separate phases with review points
|
|
132
|
-
# 1. Start a new change (four-phase brainstorming)
|
|
133
|
-
/superspec:brainstorm
|
|
237
|
+
superspec archive <id> # Archive completed change
|
|
238
|
+
superspec archive <id> --yes # Skip confirmation
|
|
239
|
+
```
|
|
134
240
|
|
|
135
|
-
|
|
136
|
-
superspec validate add-feature --strict
|
|
241
|
+
<br />
|
|
137
242
|
|
|
138
|
-
|
|
139
|
-
/superspec:plan
|
|
243
|
+
## 🤖 Claude Code Integration
|
|
140
244
|
|
|
141
|
-
|
|
142
|
-
# 4. Execute plan (subagent-driven TDD)
|
|
143
|
-
/superspec:execute
|
|
245
|
+
SuperSpec provides skills that integrate seamlessly with [Claude Code](https://claude.ai/claude-code):
|
|
144
246
|
|
|
145
|
-
|
|
146
|
-
|
|
247
|
+
| Skill | Description |
|
|
248
|
+
|:------|:------------|
|
|
249
|
+
| `/superspec:kickoff` | Fast-track: brainstorm → validate → plan in one session |
|
|
250
|
+
| `/superspec:brainstorm` | Full workflow with 4-phase progressive design |
|
|
251
|
+
| `/superspec:plan` | Create TDD implementation plan |
|
|
252
|
+
| `/superspec:execute` | Subagent-driven TDD implementation |
|
|
253
|
+
| `/superspec:verify` | Verify implementation matches specifications |
|
|
254
|
+
| `/superspec:finish-branch` | Complete branch (merge, PR, or keep) |
|
|
255
|
+
| `/superspec:archive` | Archive changes and apply deltas to main specs |
|
|
147
256
|
|
|
148
|
-
|
|
149
|
-
/superspec:finish-branch
|
|
257
|
+
### Additional Skills
|
|
150
258
|
|
|
151
|
-
|
|
152
|
-
|
|
153
|
-
|
|
259
|
+
| Skill | Description |
|
|
260
|
+
|:------|:------------|
|
|
261
|
+
| `tdd` | TDD cycle with anti-pattern awareness |
|
|
262
|
+
| `git-worktree` | Isolated development with git worktrees |
|
|
263
|
+
| `systematic-debugging` | Root cause analysis methodology |
|
|
264
|
+
| `code-review` | Two-phase review (spec compliance + quality) |
|
|
265
|
+
| `verification-before-completion` | Evidence-based completion claims |
|
|
154
266
|
|
|
155
|
-
|
|
267
|
+
<br />
|
|
156
268
|
|
|
157
|
-
|
|
269
|
+
## 📁 Project Structure
|
|
158
270
|
|
|
159
271
|
```
|
|
160
272
|
your-project/
|
|
161
273
|
├── superspec/
|
|
162
|
-
│ ├──
|
|
163
|
-
│ │
|
|
274
|
+
│ ├── project.yaml # Project configuration
|
|
275
|
+
│ │
|
|
276
|
+
│ ├── specs/ # 📚 Main specifications (source of truth)
|
|
277
|
+
│ │ └── <capability>/
|
|
164
278
|
│ │ └── spec.md
|
|
165
279
|
│ │
|
|
166
|
-
│ └── changes/ # Change
|
|
167
|
-
│ ├──
|
|
280
|
+
│ └── changes/ # 📝 Change management
|
|
281
|
+
│ ├── <change-id>/ # Active changes
|
|
168
282
|
│ │ ├── proposal.md # Why + What
|
|
169
283
|
│ │ ├── design.md # How (technical approach)
|
|
170
|
-
│ │ ├── specs/ # Delta
|
|
284
|
+
│ │ ├── specs/ # Delta specifications
|
|
171
285
|
│ │ ├── plan.md # TDD implementation plan
|
|
172
|
-
│ │ └── tasks.md # Task
|
|
286
|
+
│ │ └── tasks.md # Task tracking
|
|
173
287
|
│ │
|
|
174
|
-
│ └── archive/ # Completed
|
|
175
|
-
│ └── YYYY-MM-DD
|
|
288
|
+
│ └── archive/ # Completed changes
|
|
289
|
+
│ └── YYYY-MM-DD-<id>/
|
|
176
290
|
│
|
|
177
|
-
└── src/ #
|
|
291
|
+
└── src/ # Your application code
|
|
178
292
|
```
|
|
179
293
|
|
|
180
|
-
|
|
294
|
+
<br />
|
|
295
|
+
|
|
296
|
+
## 📝 Spec Format
|
|
181
297
|
|
|
182
298
|
```markdown
|
|
183
|
-
#
|
|
299
|
+
# Feature Name
|
|
184
300
|
|
|
185
301
|
## Purpose
|
|
186
|
-
|
|
302
|
+
Brief description of what this feature does and why it exists.
|
|
187
303
|
|
|
188
304
|
## Requirements
|
|
189
305
|
|
|
190
|
-
### Requirement:
|
|
191
|
-
The system SHALL
|
|
306
|
+
### Requirement: User Authentication
|
|
307
|
+
The system SHALL authenticate users with email and password.
|
|
192
308
|
|
|
193
|
-
#### Scenario:
|
|
194
|
-
- **WHEN**
|
|
195
|
-
- **THEN**
|
|
309
|
+
#### Scenario: Successful Login
|
|
310
|
+
- **WHEN** user submits valid credentials
|
|
311
|
+
- **THEN** system grants access and returns session token
|
|
312
|
+
|
|
313
|
+
#### Scenario: Invalid Credentials
|
|
314
|
+
- **WHEN** user submits invalid credentials
|
|
315
|
+
- **THEN** system denies access with error message
|
|
196
316
|
```
|
|
197
317
|
|
|
198
|
-
### Spec
|
|
318
|
+
### Spec → Test Mapping
|
|
199
319
|
|
|
200
320
|
```
|
|
201
|
-
|
|
202
|
-
|
|
203
|
-
#### Scenario:
|
|
204
|
-
- WHEN valid credentials
|
|
205
|
-
- THEN grants access
|
|
206
|
-
|
|
207
|
-
|
|
321
|
+
Specification Test
|
|
322
|
+
─────────────────────────────────────────────────────────────────────
|
|
323
|
+
#### Scenario: Successful Login → test('Successful Login', () => {
|
|
324
|
+
- WHEN valid credentials const result = login(validCreds);
|
|
325
|
+
- THEN grants access expect(result.granted).toBe(true);
|
|
326
|
+
});
|
|
327
|
+
─────────────────────────────────────────────────────────────────────
|
|
208
328
|
```
|
|
209
329
|
|
|
210
|
-
|
|
330
|
+
<br />
|
|
331
|
+
|
|
332
|
+
## 🔄 Two-Phase Review
|
|
333
|
+
|
|
334
|
+
SuperSpec enforces a two-phase review process:
|
|
335
|
+
|
|
336
|
+
```
|
|
337
|
+
┌────────────────────────────────────────┐
|
|
338
|
+
│ Phase 1: Spec Compliance Review │
|
|
339
|
+
│ ────────────────────────────────── │
|
|
340
|
+
│ ✓ Every Requirement implemented? │
|
|
341
|
+
│ ✓ Every Scenario has a test? │
|
|
342
|
+
│ ✓ No extra/missing features? │
|
|
343
|
+
└────────────────────────────────────────┘
|
|
344
|
+
│
|
|
345
|
+
▼ Pass to proceed
|
|
346
|
+
┌────────────────────────────────────────┐
|
|
347
|
+
│ Phase 2: Code Quality Review │
|
|
348
|
+
│ ────────────────────────────────── │
|
|
349
|
+
│ ✓ Error handling │
|
|
350
|
+
│ ✓ Type safety │
|
|
351
|
+
│ ✓ SOLID principles │
|
|
352
|
+
│ ✓ Test quality │
|
|
353
|
+
└────────────────────────────────────────┘
|
|
354
|
+
```
|
|
355
|
+
|
|
356
|
+
<br />
|
|
357
|
+
|
|
358
|
+
## 🛠 Installation
|
|
359
|
+
|
|
360
|
+
### From npm
|
|
211
361
|
|
|
212
362
|
```bash
|
|
213
|
-
|
|
214
|
-
superspec init [path] # Initialize project
|
|
215
|
-
|
|
216
|
-
# Query
|
|
217
|
-
superspec list # List changes
|
|
218
|
-
superspec list --specs # List specifications
|
|
219
|
-
superspec show [item] # Show details
|
|
220
|
-
|
|
221
|
-
# Validate
|
|
222
|
-
superspec validate [id] # Validate specification
|
|
223
|
-
superspec validate [id] --strict # Strict mode
|
|
224
|
-
|
|
225
|
-
# Verify
|
|
226
|
-
superspec verify [id] # Verify implementation matches specs
|
|
227
|
-
superspec verify [id] --strict # Fail on extra code/tests
|
|
228
|
-
superspec verify [id] --verbose # Show detailed matching
|
|
229
|
-
|
|
230
|
-
# Archive
|
|
231
|
-
superspec archive [id] # Archive change
|
|
232
|
-
superspec archive [id] --yes # Non-interactive mode
|
|
363
|
+
npm install -g superspec
|
|
233
364
|
```
|
|
234
365
|
|
|
235
|
-
|
|
366
|
+
### From Source
|
|
236
367
|
|
|
237
|
-
|
|
238
|
-
|
|
239
|
-
|
|
240
|
-
|
|
241
|
-
|
|
242
|
-
|
|
243
|
-
|
|
244
|
-
| `/superspec:finish-branch` | Complete branch (merge/PR/keep/discard) |
|
|
245
|
-
| `/superspec:archive` | Archive changes |
|
|
368
|
+
```bash
|
|
369
|
+
git clone https://github.com/HankLiu447/superspec.git
|
|
370
|
+
cd superspec
|
|
371
|
+
npm install
|
|
372
|
+
npm run build
|
|
373
|
+
npm link
|
|
374
|
+
```
|
|
246
375
|
|
|
247
|
-
|
|
376
|
+
### Requirements
|
|
248
377
|
|
|
249
|
-
|
|
250
|
-
-
|
|
251
|
-
-
|
|
378
|
+
- Node.js ≥ 18.0.0
|
|
379
|
+
- npm ≥ 8.0.0
|
|
380
|
+
- [Claude Code](https://claude.ai/claude-code) (for AI-powered skills)
|
|
252
381
|
|
|
253
|
-
|
|
254
|
-
- `superspec:plan` - Create TDD plan (after brainstorm)
|
|
255
|
-
- `git-worktree` - Git Worktree management
|
|
382
|
+
<br />
|
|
256
383
|
|
|
257
|
-
|
|
258
|
-
- `tdd` - TDD cycle (with `testing-anti-patterns.md` reference)
|
|
259
|
-
- `superspec:execute` - Subagent-driven development (default)
|
|
260
|
-
- `executing-plans` - Batch execution with checkpoints (alternative)
|
|
261
|
-
- `dispatching-parallel-agents` - For 2+ independent parallel tasks
|
|
262
|
-
- `systematic-debugging` - Systematic debugging (with support files)
|
|
384
|
+
## 🤝 Contributing
|
|
263
385
|
|
|
264
|
-
|
|
265
|
-
- `verification-before-completion` - Evidence before completion claims
|
|
266
|
-
- `receiving-code-review` - Handle code review feedback professionally
|
|
386
|
+
We welcome contributions! Please see our [Contributing Guide](CONTRIBUTING.md) for details.
|
|
267
387
|
|
|
268
|
-
|
|
269
|
-
|
|
270
|
-
|
|
388
|
+
1. Fork the repository
|
|
389
|
+
2. Create your feature branch (`git checkout -b feature/amazing-feature`)
|
|
390
|
+
3. Run tests (`npm test`)
|
|
391
|
+
4. Commit your changes (`git commit -m 'feat: add amazing feature'`)
|
|
392
|
+
5. Push to the branch (`git push origin feature/amazing-feature`)
|
|
393
|
+
6. Open a Pull Request
|
|
271
394
|
|
|
272
|
-
|
|
273
|
-
- `superspec:verify` - Verify implementation
|
|
274
|
-
- `superspec:finish-branch` - Complete branch (merge/PR/keep/discard)
|
|
275
|
-
- `superspec:archive` - Archive changes
|
|
395
|
+
<br />
|
|
276
396
|
|
|
277
|
-
##
|
|
397
|
+
## 📄 License
|
|
278
398
|
|
|
279
|
-
|
|
280
|
-
+------------------------------------------+
|
|
281
|
-
| Stage 1: Spec Compliance Review |
|
|
282
|
-
| - Read Spec files |
|
|
283
|
-
| - Check each Requirement is implemented |
|
|
284
|
-
| - Check each Scenario has a test |
|
|
285
|
-
| - Check no extra/missing features |
|
|
286
|
-
+------------------------------------------+
|
|
287
|
-
|
|
|
288
|
-
[After passing]
|
|
289
|
-
v
|
|
290
|
-
+------------------------------------------+
|
|
291
|
-
| Stage 2: Code Quality Review |
|
|
292
|
-
| - Error handling |
|
|
293
|
-
| - Type safety |
|
|
294
|
-
| - SOLID principles |
|
|
295
|
-
| - Test quality |
|
|
296
|
-
+------------------------------------------+
|
|
297
|
-
```
|
|
399
|
+
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
|
|
298
400
|
|
|
299
|
-
|
|
401
|
+
<br />
|
|
300
402
|
|
|
301
|
-
|
|
302
|
-
```
|
|
303
|
-
No production code without a failing test first
|
|
304
|
-
```
|
|
403
|
+
---
|
|
305
404
|
|
|
306
|
-
|
|
307
|
-
```
|
|
308
|
-
Specs are the source of truth. Changes are proposals.
|
|
309
|
-
```
|
|
405
|
+
<div align="center">
|
|
310
406
|
|
|
311
|
-
|
|
312
|
-
```
|
|
313
|
-
Every Scenario becomes a test. Every test traces back to a Scenario.
|
|
314
|
-
```
|
|
407
|
+
**⬡ SuperSpec** — Spec-Driven Development with TDD Discipline
|
|
315
408
|
|
|
316
|
-
|
|
317
|
-
```
|
|
318
|
-
No completion claims without fresh verification evidence
|
|
319
|
-
```
|
|
320
|
-
"It should work" is not evidence. Run the test. Show the output. Then claim completion.
|
|
409
|
+
<br />
|
|
321
410
|
|
|
322
|
-
|
|
411
|
+
[Report Bug](https://github.com/HankLiu447/superspec/issues) · [Request Feature](https://github.com/HankLiu447/superspec/issues) · [Discussions](https://github.com/HankLiu447/superspec/discussions)
|
|
323
412
|
|
|
324
|
-
|
|
413
|
+
<br />
|
|
325
414
|
|
|
326
|
-
|
|
415
|
+
Made with precision by [Hank Liu](https://github.com/HankLiu447)
|
|
327
416
|
|
|
328
|
-
|
|
417
|
+
</div>
|
package/dist/cli/index.js
CHANGED
|
File without changes
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "superspec",
|
|
3
|
-
"version": "0.1.
|
|
3
|
+
"version": "0.1.2",
|
|
4
4
|
"description": "SuperSpec - Unified spec-driven development framework",
|
|
5
5
|
"type": "module",
|
|
6
6
|
"main": "dist/index.js",
|
|
@@ -51,6 +51,7 @@
|
|
|
51
51
|
"@types/node": "^20.11.0",
|
|
52
52
|
"@typescript-eslint/eslint-plugin": "^6.19.0",
|
|
53
53
|
"@typescript-eslint/parser": "^6.19.0",
|
|
54
|
+
"@vitest/coverage-v8": "^1.6.1",
|
|
54
55
|
"eslint": "^8.56.0",
|
|
55
56
|
"typescript": "^5.3.3",
|
|
56
57
|
"vitest": "^1.2.0"
|