@boyingliu01/xp-gate 0.8.6 → 0.8.9
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/bin/xp-gate.js +18 -0
- package/hooks/pre-commit +565 -120
- package/lib/__tests__/doctor.test.js +143 -0
- package/lib/__tests__/shared-paths.test.js +110 -0
- package/lib/arch.js +49 -0
- package/lib/check.js +50 -0
- package/lib/doctor.js +66 -3
- package/lib/principles.js +48 -0
- package/lib/shared-paths.js +37 -1
- package/package.json +1 -1
- package/plugins/claude-code/.claude-plugin/plugin.json +2 -2
- package/plugins/claude-code/skills/delphi-review/AGENTS.md +3 -3
- package/plugins/claude-code/skills/sprint-flow/AGENTS.md +83 -36
- package/plugins/claude-code/skills/test-driven-development/SKILL.md +348 -48
- package/plugins/claude-code/skills/test-driven-development/testing-anti-patterns.md +299 -0
- package/plugins/claude-code/skills/test-specification-alignment/AGENTS.md +3 -3
- package/plugins/opencode/README.md +23 -7
- package/plugins/opencode/index.ts +41 -25
- package/plugins/opencode/package.json +1 -1
- package/plugins/opencode/skills/delphi-review/AGENTS.md +3 -3
- package/plugins/opencode/skills/sprint-flow/AGENTS.md +83 -36
- package/plugins/opencode/skills/test-driven-development/SKILL.md +348 -48
- package/plugins/opencode/skills/test-driven-development/testing-anti-patterns.md +299 -0
- package/plugins/opencode/skills/test-specification-alignment/AGENTS.md +3 -3
- package/plugins/qoder/plugin.json +20 -0
- package/plugins/qoder/skills/delphi-review/AGENTS.md +3 -3
- package/plugins/qoder/skills/sprint-flow/AGENTS.md +83 -36
- package/plugins/qoder/skills/test-driven-development/SKILL.md +348 -48
- package/plugins/qoder/skills/test-driven-development/testing-anti-patterns.md +299 -0
- package/plugins/qoder/skills/test-specification-alignment/AGENTS.md +3 -3
- package/skills/delphi-review/AGENTS.md +3 -3
- package/skills/sprint-flow/AGENTS.md +83 -36
- package/skills/test-driven-development/SKILL.md +348 -48
- package/skills/test-driven-development/testing-anti-patterns.md +299 -0
- package/skills/test-specification-alignment/AGENTS.md +3 -3
|
@@ -0,0 +1,299 @@
|
|
|
1
|
+
# Testing Anti-Patterns
|
|
2
|
+
|
|
3
|
+
**Load this reference when:** writing or changing tests, adding mocks, or tempted to add test-only methods to production code.
|
|
4
|
+
|
|
5
|
+
## Overview
|
|
6
|
+
|
|
7
|
+
Tests must verify real behavior, not mock behavior. Mocks are a means to isolate, not the thing being tested.
|
|
8
|
+
|
|
9
|
+
**Core principle:** Test what the code does, not what the mocks do.
|
|
10
|
+
|
|
11
|
+
**Following strict TDD prevents these anti-patterns.**
|
|
12
|
+
|
|
13
|
+
## The Iron Laws
|
|
14
|
+
|
|
15
|
+
```
|
|
16
|
+
1. NEVER test mock behavior
|
|
17
|
+
2. NEVER add test-only methods to production classes
|
|
18
|
+
3. NEVER mock without understanding dependencies
|
|
19
|
+
```
|
|
20
|
+
|
|
21
|
+
## Anti-Pattern 1: Testing Mock Behavior
|
|
22
|
+
|
|
23
|
+
**The violation:**
|
|
24
|
+
```typescript
|
|
25
|
+
// ❌ BAD: Testing that the mock exists
|
|
26
|
+
test('renders sidebar', () => {
|
|
27
|
+
render(<Page />);
|
|
28
|
+
expect(screen.getByTestId('sidebar-mock')).toBeInTheDocument();
|
|
29
|
+
});
|
|
30
|
+
```
|
|
31
|
+
|
|
32
|
+
**Why this is wrong:**
|
|
33
|
+
- You're verifying the mock works, not that the component works
|
|
34
|
+
- Test passes when mock is present, fails when it's not
|
|
35
|
+
- Tells you nothing about real behavior
|
|
36
|
+
|
|
37
|
+
**your human partner's correction:** "Are we testing the behavior of a mock?"
|
|
38
|
+
|
|
39
|
+
**The fix:**
|
|
40
|
+
```typescript
|
|
41
|
+
// ✅ GOOD: Test real component or don't mock it
|
|
42
|
+
test('renders sidebar', () => {
|
|
43
|
+
render(<Page />); // Don't mock sidebar
|
|
44
|
+
expect(screen.getByRole('navigation')).toBeInTheDocument();
|
|
45
|
+
});
|
|
46
|
+
|
|
47
|
+
// OR if sidebar must be mocked for isolation:
|
|
48
|
+
// Don't assert on the mock - test Page's behavior with sidebar present
|
|
49
|
+
```
|
|
50
|
+
|
|
51
|
+
### Gate Function
|
|
52
|
+
|
|
53
|
+
```
|
|
54
|
+
BEFORE asserting on any mock element:
|
|
55
|
+
Ask: "Am I testing real component behavior or just mock existence?"
|
|
56
|
+
|
|
57
|
+
IF testing mock existence:
|
|
58
|
+
STOP - Delete the assertion or unmock the component
|
|
59
|
+
|
|
60
|
+
Test real behavior instead
|
|
61
|
+
```
|
|
62
|
+
|
|
63
|
+
## Anti-Pattern 2: Test-Only Methods in Production
|
|
64
|
+
|
|
65
|
+
**The violation:**
|
|
66
|
+
```typescript
|
|
67
|
+
// ❌ BAD: destroy() only used in tests
|
|
68
|
+
class Session {
|
|
69
|
+
async destroy() { // Looks like production API!
|
|
70
|
+
await this._workspaceManager?.destroyWorkspace(this.id);
|
|
71
|
+
// ... cleanup
|
|
72
|
+
}
|
|
73
|
+
}
|
|
74
|
+
|
|
75
|
+
// In tests
|
|
76
|
+
afterEach(() => session.destroy());
|
|
77
|
+
```
|
|
78
|
+
|
|
79
|
+
**Why this is wrong:**
|
|
80
|
+
- Production class polluted with test-only code
|
|
81
|
+
- Dangerous if accidentally called in production
|
|
82
|
+
- Violates YAGNI and separation of concerns
|
|
83
|
+
- Confuses object lifecycle with entity lifecycle
|
|
84
|
+
|
|
85
|
+
**The fix:**
|
|
86
|
+
```typescript
|
|
87
|
+
// ✅ GOOD: Test utilities handle test cleanup
|
|
88
|
+
// Session has no destroy() - it's stateless in production
|
|
89
|
+
|
|
90
|
+
// In test-utils/
|
|
91
|
+
export async function cleanupSession(session: Session) {
|
|
92
|
+
const workspace = session.getWorkspaceInfo();
|
|
93
|
+
if (workspace) {
|
|
94
|
+
await workspaceManager.destroyWorkspace(workspace.id);
|
|
95
|
+
}
|
|
96
|
+
}
|
|
97
|
+
|
|
98
|
+
// In tests
|
|
99
|
+
afterEach(() => cleanupSession(session));
|
|
100
|
+
```
|
|
101
|
+
|
|
102
|
+
### Gate Function
|
|
103
|
+
|
|
104
|
+
```
|
|
105
|
+
BEFORE adding any method to production class:
|
|
106
|
+
Ask: "Is this only used by tests?"
|
|
107
|
+
|
|
108
|
+
IF yes:
|
|
109
|
+
STOP - Don't add it
|
|
110
|
+
Put it in test utilities instead
|
|
111
|
+
|
|
112
|
+
Ask: "Does this class own this resource's lifecycle?"
|
|
113
|
+
|
|
114
|
+
IF no:
|
|
115
|
+
STOP - Wrong class for this method
|
|
116
|
+
```
|
|
117
|
+
|
|
118
|
+
## Anti-Pattern 3: Mocking Without Understanding
|
|
119
|
+
|
|
120
|
+
**The violation:**
|
|
121
|
+
```typescript
|
|
122
|
+
// ❌ BAD: Mock breaks test logic
|
|
123
|
+
test('detects duplicate server', () => {
|
|
124
|
+
// Mock prevents config write that test depends on!
|
|
125
|
+
vi.mock('ToolCatalog', () => ({
|
|
126
|
+
discoverAndCacheTools: vi.fn().mockResolvedValue(undefined)
|
|
127
|
+
}));
|
|
128
|
+
|
|
129
|
+
await addServer(config);
|
|
130
|
+
await addServer(config); // Should throw - but won't!
|
|
131
|
+
});
|
|
132
|
+
```
|
|
133
|
+
|
|
134
|
+
**Why this is wrong:**
|
|
135
|
+
- Mocked method had side effect test depended on (writing config)
|
|
136
|
+
- Over-mocking to "be safe" breaks actual behavior
|
|
137
|
+
- Test passes for wrong reason or fails mysteriously
|
|
138
|
+
|
|
139
|
+
**The fix:**
|
|
140
|
+
```typescript
|
|
141
|
+
// ✅ GOOD: Mock at correct level
|
|
142
|
+
test('detects duplicate server', () => {
|
|
143
|
+
// Mock the slow part, preserve behavior test needs
|
|
144
|
+
vi.mock('MCPServerManager'); // Just mock slow server startup
|
|
145
|
+
|
|
146
|
+
await addServer(config); // Config written
|
|
147
|
+
await addServer(config); // Duplicate detected ✓
|
|
148
|
+
});
|
|
149
|
+
```
|
|
150
|
+
|
|
151
|
+
### Gate Function
|
|
152
|
+
|
|
153
|
+
```
|
|
154
|
+
BEFORE mocking any method:
|
|
155
|
+
STOP - Don't mock yet
|
|
156
|
+
|
|
157
|
+
1. Ask: "What side effects does the real method have?"
|
|
158
|
+
2. Ask: "Does this test depend on any of those side effects?"
|
|
159
|
+
3. Ask: "Do I fully understand what this test needs?"
|
|
160
|
+
|
|
161
|
+
IF depends on side effects:
|
|
162
|
+
Mock at lower level (the actual slow/external operation)
|
|
163
|
+
OR use test doubles that preserve necessary behavior
|
|
164
|
+
NOT the high-level method the test depends on
|
|
165
|
+
|
|
166
|
+
IF unsure what test depends on:
|
|
167
|
+
Run test with real implementation FIRST
|
|
168
|
+
Observe what actually needs to happen
|
|
169
|
+
THEN add minimal mocking at the right level
|
|
170
|
+
|
|
171
|
+
Red flags:
|
|
172
|
+
- "I'll mock this to be safe"
|
|
173
|
+
- "This might be slow, better mock it"
|
|
174
|
+
- Mocking without understanding the dependency chain
|
|
175
|
+
```
|
|
176
|
+
|
|
177
|
+
## Anti-Pattern 4: Incomplete Mocks
|
|
178
|
+
|
|
179
|
+
**The violation:**
|
|
180
|
+
```typescript
|
|
181
|
+
// ❌ BAD: Partial mock - only fields you think you need
|
|
182
|
+
const mockResponse = {
|
|
183
|
+
status: 'success',
|
|
184
|
+
data: { userId: '123', name: 'Alice' }
|
|
185
|
+
// Missing: metadata that downstream code uses
|
|
186
|
+
};
|
|
187
|
+
|
|
188
|
+
// Later: breaks when code accesses response.metadata.requestId
|
|
189
|
+
```
|
|
190
|
+
|
|
191
|
+
**Why this is wrong:**
|
|
192
|
+
- **Partial mocks hide structural assumptions** - You only mocked fields you know about
|
|
193
|
+
- **Downstream code may depend on fields you didn't include** - Silent failures
|
|
194
|
+
- **Tests pass but integration fails** - Mock incomplete, real API complete
|
|
195
|
+
- **False confidence** - Test proves nothing about real behavior
|
|
196
|
+
|
|
197
|
+
**The Iron Rule:** Mock the COMPLETE data structure as it exists in reality, not just fields your immediate test uses.
|
|
198
|
+
|
|
199
|
+
**The fix:**
|
|
200
|
+
```typescript
|
|
201
|
+
// ✅ GOOD: Mirror real API completeness
|
|
202
|
+
const mockResponse = {
|
|
203
|
+
status: 'success',
|
|
204
|
+
data: { userId: '123', name: 'Alice' },
|
|
205
|
+
metadata: { requestId: 'req-789', timestamp: 1234567890 }
|
|
206
|
+
// All fields real API returns
|
|
207
|
+
};
|
|
208
|
+
```
|
|
209
|
+
|
|
210
|
+
### Gate Function
|
|
211
|
+
|
|
212
|
+
```
|
|
213
|
+
BEFORE creating mock responses:
|
|
214
|
+
Check: "What fields does the real API response contain?"
|
|
215
|
+
|
|
216
|
+
Actions:
|
|
217
|
+
1. Examine actual API response from docs/examples
|
|
218
|
+
2. Include ALL fields system might consume downstream
|
|
219
|
+
3. Verify mock matches real response schema completely
|
|
220
|
+
|
|
221
|
+
Critical:
|
|
222
|
+
If you're creating a mock, you must understand the ENTIRE structure
|
|
223
|
+
Partial mocks fail silently when code depends on omitted fields
|
|
224
|
+
|
|
225
|
+
If uncertain: Include all documented fields
|
|
226
|
+
```
|
|
227
|
+
|
|
228
|
+
## Anti-Pattern 5: Integration Tests as Afterthought
|
|
229
|
+
|
|
230
|
+
**The violation:**
|
|
231
|
+
```
|
|
232
|
+
✅ Implementation complete
|
|
233
|
+
❌ No tests written
|
|
234
|
+
"Ready for testing"
|
|
235
|
+
```
|
|
236
|
+
|
|
237
|
+
**Why this is wrong:**
|
|
238
|
+
- Testing is part of implementation, not optional follow-up
|
|
239
|
+
- TDD would have caught this
|
|
240
|
+
- Can't claim complete without tests
|
|
241
|
+
|
|
242
|
+
**The fix:**
|
|
243
|
+
```
|
|
244
|
+
TDD cycle:
|
|
245
|
+
1. Write failing test
|
|
246
|
+
2. Implement to pass
|
|
247
|
+
3. Refactor
|
|
248
|
+
4. THEN claim complete
|
|
249
|
+
```
|
|
250
|
+
|
|
251
|
+
## When Mocks Become Too Complex
|
|
252
|
+
|
|
253
|
+
**Warning signs:**
|
|
254
|
+
- Mock setup longer than test logic
|
|
255
|
+
- Mocking everything to make test pass
|
|
256
|
+
- Mocks missing methods real components have
|
|
257
|
+
- Test breaks when mock changes
|
|
258
|
+
|
|
259
|
+
**your human partner's question:** "Do we need to be using a mock here?"
|
|
260
|
+
|
|
261
|
+
**Consider:** Integration tests with real components often simpler than complex mocks
|
|
262
|
+
|
|
263
|
+
## TDD Prevents These Anti-Patterns
|
|
264
|
+
|
|
265
|
+
**Why TDD helps:**
|
|
266
|
+
1. **Write test first** → Forces you to think about what you're actually testing
|
|
267
|
+
2. **Watch it fail** → Confirms test tests real behavior, not mocks
|
|
268
|
+
3. **Minimal implementation** → No test-only methods creep in
|
|
269
|
+
4. **Real dependencies** → You see what the test actually needs before mocking
|
|
270
|
+
|
|
271
|
+
**If you're testing mock behavior, you violated TDD** - you added mocks without watching test fail against real code first.
|
|
272
|
+
|
|
273
|
+
## Quick Reference
|
|
274
|
+
|
|
275
|
+
| Anti-Pattern | Fix |
|
|
276
|
+
|--------------|-----|
|
|
277
|
+
| Assert on mock elements | Test real component or unmock it |
|
|
278
|
+
| Test-only methods in production | Move to test utilities |
|
|
279
|
+
| Mock without understanding | Understand dependencies first, mock minimally |
|
|
280
|
+
| Incomplete mocks | Mirror real API completely |
|
|
281
|
+
| Tests as afterthought | TDD - tests first |
|
|
282
|
+
| Over-complex mocks | Consider integration tests |
|
|
283
|
+
|
|
284
|
+
## Red Flags
|
|
285
|
+
|
|
286
|
+
- Assertion checks for `*-mock` test IDs
|
|
287
|
+
- Methods only called in test files
|
|
288
|
+
- Mock setup is >50% of test
|
|
289
|
+
- Test fails when you remove mock
|
|
290
|
+
- Can't explain why mock is needed
|
|
291
|
+
- Mocking "just to be safe"
|
|
292
|
+
|
|
293
|
+
## The Bottom Line
|
|
294
|
+
|
|
295
|
+
**Mocks are tools to isolate, not things to test.**
|
|
296
|
+
|
|
297
|
+
If TDD reveals you're testing mock behavior, you've gone wrong.
|
|
298
|
+
|
|
299
|
+
Fix: Test real behavior or question why you're mocking at all.
|
|
@@ -1,9 +1,9 @@
|
|
|
1
1
|
# SKILLS/TEST-SPECIFICATION-ALIGNMENT KNOWLEDGE BASE
|
|
2
2
|
|
|
3
|
-
**Generated:** 2026-
|
|
4
|
-
**Commit:**
|
|
3
|
+
**Generated:** 2026-06-11
|
|
4
|
+
**Commit:** c18f82b
|
|
5
5
|
**Branch:** main
|
|
6
|
-
**Version:**
|
|
6
|
+
**Version:** 0.8.9.0
|
|
7
7
|
|
|
8
8
|
## OVERVIEW
|
|
9
9
|
Test-Specification Alignment Engine — two-stage validation ensuring tests accurately reflect requirements and design specs.
|
|
@@ -4,9 +4,21 @@ OpenCode plugin exposing xp-gate quality gates and AI workflow skills.
|
|
|
4
4
|
|
|
5
5
|
## Tools
|
|
6
6
|
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
7
|
+
These three tools are **dual-surface**: callable both as OpenCode tools (from
|
|
8
|
+
inside an OpenCode session) and as `xp-gate` CLI subcommands (from any shell).
|
|
9
|
+
Both paths produce identical output. See repo README for the matching CLI table.
|
|
10
|
+
|
|
11
|
+
- **gate-check** ⇄ `xp-gate check <path>`: Run user-invokable quality gates
|
|
12
|
+
(Gate 4 Principles + Gate 6 Architecture) on a file or directory.
|
|
13
|
+
- **gate-principles** ⇄ `xp-gate principles <path>`: Run Clean Code + SOLID
|
|
14
|
+
principles checker (Gate 4 standalone).
|
|
15
|
+
- **gate-arch** ⇄ `xp-gate arch`: Run architecture validation (Gate 6
|
|
16
|
+
standalone, layer boundary checks).
|
|
17
|
+
|
|
18
|
+
> Earlier docs said "all 6 quality gates" — that was inaccurate. `gate-check`
|
|
19
|
+
> intentionally runs only the two user-invokable gates (Principles + Arch); the
|
|
20
|
+
> full 10-gate pre-commit suite (Gate 0-9) is enforced by `xp-gate init`'s git
|
|
21
|
+
> hooks, not by this tool. Fixes #208.
|
|
10
22
|
|
|
11
23
|
## Installation
|
|
12
24
|
|
|
@@ -29,10 +41,14 @@ Or via local path (development):
|
|
|
29
41
|
## Requirements
|
|
30
42
|
|
|
31
43
|
- OpenCode v0.11+
|
|
32
|
-
-
|
|
33
|
-
-
|
|
34
|
-
- `
|
|
44
|
+
- One of:
|
|
45
|
+
- `xp-gate` CLI installed globally (`npm install -g @boyingliu01/xp-gate`) — **preferred**, or
|
|
46
|
+
- the xp-gate repo checked out locally with `src/principles/index.ts` reachable — **fallback** (the tool will shell out via `npx -y tsx`)
|
|
47
|
+
- `architecture.yaml` in repo root (for `gate-arch` only)
|
|
35
48
|
|
|
36
49
|
## Graceful Degradation
|
|
37
50
|
|
|
38
|
-
|
|
51
|
+
Every tool runs a chained shell-out: it first tries `xp-gate <subcommand>` and,
|
|
52
|
+
only if that's not on `PATH`, falls back to invoking the underlying checker
|
|
53
|
+
source directly. If both paths fail, the tool returns install instructions
|
|
54
|
+
instead of throwing.
|
|
@@ -1,75 +1,91 @@
|
|
|
1
1
|
/**
|
|
2
2
|
* XP-Gate OpenCode Plugin
|
|
3
3
|
*
|
|
4
|
-
* Exposes 3
|
|
5
|
-
* - gate-check: Run
|
|
6
|
-
* - gate-principles: Run Clean Code + SOLID principles checker
|
|
7
|
-
* - gate-arch: Run architecture validation
|
|
4
|
+
* Exposes 3 OpenCode tools that mirror the equivalent `xp-gate` CLI subcommands:
|
|
5
|
+
* - gate-check: Run user-invokable quality gates (Gate 4 Principles + Gate 6 Arch) on a path
|
|
6
|
+
* - gate-principles: Run Clean Code + SOLID principles checker (Gate 4 standalone)
|
|
7
|
+
* - gate-arch: Run architecture validation (Gate 6 standalone)
|
|
8
8
|
*
|
|
9
|
-
*
|
|
9
|
+
* Dual-surface design (fixes #208): every tool is callable BOTH from inside an
|
|
10
|
+
* OpenCode session (as these tools) AND from a plain shell (as `xp-gate check`,
|
|
11
|
+
* `xp-gate principles`, `xp-gate arch`). The tools prefer the global `xp-gate`
|
|
12
|
+
* CLI when available, but fall back to running the checker source directly via
|
|
13
|
+
* `npx -y tsx` so they work even before `npm install -g @boyingliu01/xp-gate`.
|
|
10
14
|
*/
|
|
11
|
-
import type { Plugin, PluginModule } from "@opencode-ai/plugin"
|
|
12
15
|
import { tool } from "@opencode-ai/plugin"
|
|
13
16
|
import { z } from "zod"
|
|
14
17
|
|
|
15
|
-
|
|
18
|
+
interface OpenCodePluginInput {
|
|
19
|
+
directory: string
|
|
20
|
+
$: (strings: TemplateStringsArray, ...values: unknown[]) => Promise<{ text(): Promise<string> }>
|
|
21
|
+
}
|
|
22
|
+
|
|
23
|
+
export const XpGatePlugin = async (input: OpenCodePluginInput) => {
|
|
16
24
|
const { directory, $ } = input
|
|
17
25
|
|
|
18
26
|
return {
|
|
19
27
|
tool: {
|
|
20
28
|
"gate-check": tool({
|
|
21
29
|
description:
|
|
22
|
-
"Run xp-gate quality
|
|
30
|
+
"Run xp-gate user-invokable quality gates (Gate 4 Principles + Gate 6 Architecture) on a file or directory. Prefers global xp-gate CLI; falls back to running checker source directly.",
|
|
23
31
|
args: {
|
|
24
32
|
path: z.string().describe("File or directory path (absolute or relative to workspace)"),
|
|
25
|
-
gates: z.array(z.string()).optional().describe("Optional gate subset (e.g. ['principles', '
|
|
33
|
+
gates: z.array(z.string()).optional().describe("Optional gate subset (e.g. ['principles', 'arch'])"),
|
|
26
34
|
},
|
|
27
35
|
async execute(args, ctx) {
|
|
28
36
|
const cwd = ctx.directory || directory
|
|
29
37
|
const target = args.path.startsWith("/") ? args.path : `${cwd}/${args.path}`
|
|
30
|
-
const
|
|
38
|
+
const gatesFlag = args.gates?.length ? ` --gates ${args.gates.join(",")}` : ""
|
|
39
|
+
// Prefer the installed xp-gate CLI. Fall back to invoking the same
|
|
40
|
+
// subcommand source directly via npx tsx so the tool still works in
|
|
41
|
+
// a fresh clone before `npm install -g @boyingliu01/xp-gate`.
|
|
42
|
+
const cmd = `cd "${cwd}" && (command -v xp-gate >/dev/null 2>&1 && xp-gate check "${target}"${gatesFlag} || node ${directory}/src/npm-package/bin/xp-gate.js check "${target}"${gatesFlag})`
|
|
31
43
|
try {
|
|
32
|
-
const result = await $`bash -c ${
|
|
44
|
+
const result = await $`bash -c ${cmd}`
|
|
33
45
|
const text = await result.text()
|
|
34
|
-
return text || "[XP-Gate] Check complete."
|
|
35
|
-
} catch (err
|
|
36
|
-
return `[XP-Gate] xp-gate CLI
|
|
46
|
+
return text || "[XP-Gate] Check complete (no violations)."
|
|
47
|
+
} catch (err) {
|
|
48
|
+
return `[XP-Gate] gate-check failed.\nInstall xp-gate CLI: npm install -g @boyingliu01/xp-gate\n${err instanceof Error ? err.message : ""}`
|
|
37
49
|
}
|
|
38
50
|
},
|
|
39
51
|
}),
|
|
40
52
|
"gate-principles": tool({
|
|
41
53
|
description:
|
|
42
|
-
"Run Clean Code + SOLID principles checker on a file.",
|
|
54
|
+
"Run Clean Code + SOLID principles checker (Gate 4 standalone) on a file or directory.",
|
|
43
55
|
args: {
|
|
44
|
-
path: z.string().describe("Source file path to check"),
|
|
56
|
+
path: z.string().describe("Source file or directory path to check"),
|
|
45
57
|
},
|
|
46
58
|
async execute(args, ctx) {
|
|
47
59
|
const cwd = ctx.directory || directory
|
|
48
60
|
const target = args.path.startsWith("/") ? args.path : `${cwd}/${args.path}`
|
|
49
|
-
|
|
61
|
+
// Try xp-gate CLI first, fall back to the principles source directly.
|
|
62
|
+
const cmd = `cd "${cwd}" && (command -v xp-gate >/dev/null 2>&1 && xp-gate principles "${target}" || npx -y tsx ${directory}/src/principles/index.ts --files "${target}" --format console)`
|
|
50
63
|
try {
|
|
51
64
|
const result = await $`bash -c ${cmd}`
|
|
52
65
|
const text = await result.text()
|
|
53
|
-
return text || "[XP-Gate] Principles check complete."
|
|
54
|
-
} catch (err
|
|
55
|
-
return `[XP-Gate] Principles checker failed.\
|
|
66
|
+
return text || "[XP-Gate] Principles check complete (no violations)."
|
|
67
|
+
} catch (err) {
|
|
68
|
+
return `[XP-Gate] Principles checker failed.\nInstall xp-gate CLI: npm install -g @boyingliu01/xp-gate\n${err instanceof Error ? err.message : ""}`
|
|
56
69
|
}
|
|
57
70
|
},
|
|
58
71
|
}),
|
|
59
72
|
"gate-arch": tool({
|
|
60
73
|
description:
|
|
61
|
-
"Run architecture validation (layer boundary checks) on the repository.",
|
|
74
|
+
"Run architecture validation (Gate 6 standalone, layer boundary checks) on the repository.",
|
|
62
75
|
args: {
|
|
63
76
|
config: z.string().describe("Path to architecture config file").default("architecture.yaml"),
|
|
64
77
|
},
|
|
65
78
|
async execute(args, ctx) {
|
|
66
79
|
const cwd = ctx.directory || directory
|
|
80
|
+
// Prefer xp-gate CLI; fall back to @archlinter/cli directly so the tool
|
|
81
|
+
// also works without xp-gate installed (matches gate-principles pattern).
|
|
82
|
+
const cmd = `cd "${cwd}" && (command -v xp-gate >/dev/null 2>&1 && xp-gate arch --config ${args.config} || npx -y @archlinter/cli scan . --config ${args.config})`
|
|
67
83
|
try {
|
|
68
|
-
const result = await $`bash -c ${
|
|
84
|
+
const result = await $`bash -c ${cmd}`
|
|
69
85
|
const text = await result.text()
|
|
70
86
|
return text || "[XP-Gate] Architecture check complete."
|
|
71
|
-
} catch (err
|
|
72
|
-
return `[XP-Gate] Architecture validation
|
|
87
|
+
} catch (err) {
|
|
88
|
+
return `[XP-Gate] Architecture validation failed.\nRequires architecture.yaml in repo root.\nInstall xp-gate CLI: npm install -g @boyingliu01/xp-gate\n${err instanceof Error ? err.message : ""}`
|
|
73
89
|
}
|
|
74
90
|
},
|
|
75
91
|
}),
|
|
@@ -77,7 +93,7 @@ export const XpGatePlugin: Plugin = async (input) => {
|
|
|
77
93
|
}
|
|
78
94
|
}
|
|
79
95
|
|
|
80
|
-
const pluginModule
|
|
96
|
+
const pluginModule = {
|
|
81
97
|
id: "xp-gate",
|
|
82
98
|
server: XpGatePlugin,
|
|
83
99
|
}
|
|
@@ -1,9 +1,9 @@
|
|
|
1
1
|
# SKILLS/DELPHI-REVIEW KNOWLEDGE BASE
|
|
2
2
|
|
|
3
|
-
**Generated:** 2026-
|
|
4
|
-
**Commit:**
|
|
3
|
+
**Generated:** 2026-06-11
|
|
4
|
+
**Commit:** c18f82b
|
|
5
5
|
**Branch:** main
|
|
6
|
-
**Version:**
|
|
6
|
+
**Version:** 0.8.9.0
|
|
7
7
|
|
|
8
8
|
## OVERVIEW
|
|
9
9
|
Delphi Consensus Review — multi-round anonymous expert review (≥91% threshold, 3 experts from ≥2 providers, domestic models only). Supports design + code-walkthrough modes.
|
|
@@ -1,68 +1,115 @@
|
|
|
1
1
|
# SKILLS/SPRINT-FLOW KNOWLEDGE BASE
|
|
2
2
|
|
|
3
|
-
**Generated:** 2026-
|
|
4
|
-
**
|
|
3
|
+
**Generated:** 2026-06-11
|
|
4
|
+
**Commit:** c18f82b
|
|
5
|
+
**Branch:** main
|
|
6
|
+
**Version:** 0.8.9.0
|
|
5
7
|
|
|
6
8
|
## OVERVIEW
|
|
7
|
-
|
|
9
|
+
**11-phase** development pipeline: ISOLATE → AUTO-ESTIMATE → THINK → PLAN → BUILD → REVIEW → USER ACCEPTANCE → FEEDBACK → SHIP → LAND → CLEANUP. Phase 2 default build mode is **ralph-loop** (REQ-level iteration, 40-67% token savings vs parallel). HARD-GATE in Phase 1: design must pass Delphi review (≥91% consensus) before any coding.
|
|
10
|
+
|
|
11
|
+
> **Doc drift**: README/CAPABILITIES still describe a "7-phase" pipeline. The canonical 11-phase model lives in `SKILL.md` and is what actually executes. See root `AGENTS.md` → "Known Drift" #4.
|
|
8
12
|
|
|
9
13
|
## STRUCTURE
|
|
10
14
|
```
|
|
11
15
|
skills/sprint-flow/
|
|
12
|
-
├── SKILL.md #
|
|
16
|
+
├── SKILL.md # 11-phase pipeline definition (canonical)
|
|
17
|
+
├── AGENTS.md # This file (mirrored to 7 other locations — DO NOT edit mirrors)
|
|
13
18
|
├── evals/ # Evaluation test cases
|
|
14
|
-
├── evolution-history.json
|
|
15
|
-
├── evolution-log.md
|
|
16
|
-
├── references/
|
|
17
|
-
│ ├── phase-0-
|
|
18
|
-
│
|
|
19
|
-
|
|
19
|
+
├── evolution-history.json
|
|
20
|
+
├── evolution-log.md
|
|
21
|
+
├── references/
|
|
22
|
+
│ ├── phase-minus-0-5-auto-estimate.md # Phase -0.5: AUTO-ESTIMATE
|
|
23
|
+
│ ├── phase-0-think.md # Phase 0: brainstorming → CONTEXT.md + ADR
|
|
24
|
+
│ ├── phase-1-plan.md # Phase 1: autoplan + delphi-review (HARD-GATE)
|
|
25
|
+
│ ├── phase-2-build.md # Phase 2: ralph-loop default + TDD + test-align
|
|
26
|
+
│ ├── phase-3-review.md # Phase 3: code-walkthrough + QA + benchmark
|
|
27
|
+
│ ├── phase-4-uat.md # Phase 4: USER ACCEPTANCE
|
|
28
|
+
│ ├── phase-5-feedback.md # Phase 5: retro + debugging + learn
|
|
29
|
+
│ ├── phase-6-ship.md # Phase 6: finishing-dev-branch + PR
|
|
30
|
+
│ ├── phase-7-land.md # Phase 7: land + deploy
|
|
31
|
+
│ ├── phase-8-cleanup.md # Phase 8: sprint branch cleanup
|
|
32
|
+
│ ├── force-levels.md # Phase forcing rules
|
|
33
|
+
│ └── components/ # Reusable phase building blocks
|
|
34
|
+
└── templates/
|
|
35
|
+
├── auto-estimate-output-template.md
|
|
36
|
+
├── auto-estimate-learning-log.md
|
|
37
|
+
├── pain-document-template.md
|
|
38
|
+
├── sprint-progress-template.md
|
|
39
|
+
├── sprint-summary-template.md
|
|
40
|
+
└── emergent-issues-template.md
|
|
20
41
|
```
|
|
21
42
|
|
|
22
43
|
## WHERE TO LOOK
|
|
23
44
|
| Task | Location | Notes |
|
|
24
45
|
|------|----------|-------|
|
|
25
|
-
| Pipeline
|
|
46
|
+
| Pipeline definition | SKILL.md | 11 phases with HARD-GATE between Phase 1 and Phase 2 |
|
|
47
|
+
| Auto-estimate phase | references/phase-minus-0-5-auto-estimate.md | Sizing pass before THINK |
|
|
26
48
|
| THINK phase | references/phase-0-think.md | brainstorming → CONTEXT.md + ADR |
|
|
27
|
-
|
|
|
49
|
+
| PLAN phase + HARD-GATE | references/phase-1-plan.md | autoplan → delphi-review → specification.yaml |
|
|
50
|
+
| BUILD phase | references/phase-2-build.md | ralph-loop (default) vs parallel |
|
|
51
|
+
| Force-level rules | references/force-levels.md | Defines when each phase becomes mandatory |
|
|
52
|
+
| Templates | templates/ | Auto-estimate, sprint progress/summary, pain doc, emergent issues |
|
|
53
|
+
|
|
54
|
+
## THE 11 PHASES
|
|
28
55
|
|
|
29
|
-
## 7 PHASES
|
|
30
56
|
| Phase | Name | Key Action | Hard Gate |
|
|
31
57
|
|-------|------|-----------|-----------|
|
|
32
|
-
|
|
|
33
|
-
|
|
|
34
|
-
|
|
|
58
|
+
| -1 | ISOLATE | Isolate working tree / worktree creation | — |
|
|
59
|
+
| -0.5 | AUTO-ESTIMATE | Sizing pass; emits estimate template | — |
|
|
60
|
+
| 0 | THINK | brainstorming → CONTEXT.md + ADR | — |
|
|
61
|
+
| 1 | PLAN | autoplan → delphi-review → specification.yaml | **HARD-GATE**: design must reach ≥91% Delphi consensus |
|
|
62
|
+
| 2 | BUILD | ralph-loop (REQ-level, default) + TDD + test-spec-alignment | — |
|
|
35
63
|
| 3 | REVIEW | code-walkthrough + QA + benchmark | — |
|
|
36
|
-
| 4 | USER
|
|
37
|
-
| 5 | FEEDBACK |
|
|
38
|
-
| 6 | SHIP | finishing-
|
|
64
|
+
| 4 | USER ACCEPTANCE | Manual verification | — |
|
|
65
|
+
| 5 | FEEDBACK | retro + debugging + `learn` (Sprint-level) | — |
|
|
66
|
+
| 6 | SHIP | finishing-a-development-branch → PR | — |
|
|
67
|
+
| 7 | LAND | land + deploy + canary | — |
|
|
68
|
+
| 8 | CLEANUP | Sprint branch cleanup (per `docs/plans/2026-06-06-sprint-branch-cleanup-design.md`) | — |
|
|
39
69
|
|
|
40
70
|
## CONVENTIONS
|
|
41
|
-
- ralph-loop is Phase 2
|
|
42
|
-
- delphi-review HARD-GATE in Phase 1
|
|
43
|
-
-
|
|
44
|
-
-
|
|
71
|
+
- **ralph-loop is Phase 2 default**. Each REQ runs in a clean context (no linear accumulation), saving 40-67% tokens vs parallel mode.
|
|
72
|
+
- **delphi-review HARD-GATE in Phase 1**: design must reach ≥91% consensus across ≥2 model providers, domestic models only. Unapproved → BLOCK coding.
|
|
73
|
+
- **`learn` is called twice**: once per REQ in Phase 2 (ralph-loop internal, `progress.log` permanent/contextual classification) and once in Phase 5 (Sprint-level retro).
|
|
74
|
+
- **Phase isolation**: each phase has explicit entry/exit criteria documented in its `references/phase-*.md` file.
|
|
75
|
+
- **Emergent Requirements** discovered in Phase 4 (USER ACCEPTANCE) are explicitly captured via `templates/emergent-issues-template.md` — never silently merged.
|
|
76
|
+
- **Auto-detection**: Phase 0 uses `src/npm-package/lib/ui-detector.ts` to pick the right tech-stack templates.
|
|
45
77
|
|
|
46
78
|
## ANTI-PATTERNS (THIS PROJECT)
|
|
47
|
-
- Do NOT skip delphi-review in Phase 1 — HARD-GATE blocks implementation
|
|
48
|
-
- Do NOT use parallel build mode unless explicitly requested
|
|
49
|
-
- Do NOT enter Phase 1 (PLAN) without completing THINK
|
|
50
|
-
-
|
|
79
|
+
- Do NOT skip `delphi-review` in Phase 1 — HARD-GATE blocks implementation.
|
|
80
|
+
- Do NOT use parallel build mode unless explicitly requested. Ralph-loop is the default for a reason.
|
|
81
|
+
- Do NOT enter Phase 1 (PLAN) without completing Phase 0 (THINK).
|
|
82
|
+
- Do NOT implement before design is APPROVED — Phase 1 must reach Delphi consensus first.
|
|
83
|
+
- Do NOT merge an Emergent Requirement into the original Sprint silently — capture it via the template.
|
|
84
|
+
- Do NOT terminate Delphi review before ≥91% consensus or 5 rounds, whichever first.
|
|
51
85
|
|
|
52
86
|
## UNIQUE STYLES
|
|
53
|
-
-
|
|
54
|
-
-
|
|
55
|
-
-
|
|
56
|
-
-
|
|
87
|
+
- **11 phases** including negative-numbered pre-phases (-1, -0.5) — intentional, captures the work that happens before "real" coding starts.
|
|
88
|
+
- **HARD-GATE** between PLAN and BUILD is enforced both in the SKILL.md instructions and in the Claude Code plugin's PreToolUse hook (`plugins/claude-code/bin/delphi-review-guard.sh`).
|
|
89
|
+
- **Per-REQ clean context in ralph-loop** = the core efficiency mechanism. Sprint-flow specifically chooses this over parallel mode.
|
|
90
|
+
- **Tech-stack auto-detection** via `--type` and `--lang` flags or `ui-detector.ts`.
|
|
57
91
|
|
|
58
92
|
## COMMANDS
|
|
59
93
|
```bash
|
|
94
|
+
/sprint-flow "开发用户登录" # Full 11-phase pipeline
|
|
95
|
+
/sprint-flow "开发用户登录" --type web-nextjs --lang typescript # Pin tech stack
|
|
96
|
+
/sprint-flow "开发用户登录" --phase build-only # Skip planning (advanced)
|
|
97
|
+
/sprint-flow "开发用户登录" --mode parallel # Legacy all-at-once (NOT default)
|
|
60
98
|
/delphi-review "开发用户登录" --type web-nextjs --lang typescript
|
|
61
|
-
/sprint-flow "开发用户登录" --phase build-only
|
|
62
|
-
/sprint-flow "开发用户登录" --mode parallel # Legacy all-at-once
|
|
63
99
|
```
|
|
64
100
|
|
|
65
101
|
## NOTES
|
|
66
|
-
- Integrates brainstorming, autoplan, delphi-review, TDD, test-specification-alignment
|
|
67
|
-
- ralph-loop internal learnings via progress.log (permanent
|
|
68
|
-
- Phase 5 calls gstack/learn for Sprint-level retrospective
|
|
102
|
+
- Integrates: brainstorming, autoplan, delphi-review, TDD, test-specification-alignment, qa, design-review, benchmark, systematic-debugging, retro, learn, finishing-a-development-branch.
|
|
103
|
+
- ralph-loop's internal learnings are persisted via `progress.log` (permanent vs contextual classification).
|
|
104
|
+
- Phase 5 calls `gstack/learn` for Sprint-level retrospective.
|
|
105
|
+
- Phase 8 cleanup behavior is governed by `docs/plans/2026-06-06-sprint-branch-cleanup-design.md`.
|
|
106
|
+
- This `AGENTS.md` is the canonical version. **7 byte-identical mirrors** exist at:
|
|
107
|
+
- `plugins/claude-code/skills/sprint-flow/AGENTS.md`
|
|
108
|
+
- `plugins/opencode/skills/sprint-flow/AGENTS.md`
|
|
109
|
+
- `plugins/qoder/skills/sprint-flow/AGENTS.md`
|
|
110
|
+
- `src/npm-package/skills/sprint-flow/AGENTS.md`
|
|
111
|
+
- `src/npm-package/plugins/claude-code/skills/sprint-flow/AGENTS.md`
|
|
112
|
+
- `src/npm-package/plugins/opencode/skills/sprint-flow/AGENTS.md`
|
|
113
|
+
- `src/npm-package/plugins/qoder/skills/sprint-flow/AGENTS.md`
|
|
114
|
+
Mirrors are updated by `scripts/copy-skills.sh`. Do NOT edit them by hand.
|
|
115
|
+
|