tlc-claude-code 0.6.4 → 0.7.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CLAUDE.md +59 -0
- package/README.md +240 -64
- package/autofix.md +327 -0
- package/bin/install.js +23 -2
- package/bug.md +255 -0
- package/build.md +167 -21
- package/ci.md +414 -0
- package/claim.md +189 -0
- package/config.md +236 -0
- package/deploy.md +516 -0
- package/docs.md +494 -0
- package/edge-cases.md +340 -0
- package/export.md +456 -0
- package/help.md +84 -1
- package/init.md +56 -7
- package/issues.md +376 -0
- package/new-project.md +68 -4
- package/package.json +4 -2
- package/plan.md +15 -1
- package/progress.md +17 -0
- package/quality.md +273 -0
- package/release.md +135 -0
- package/server/dashboard/index.html +708 -0
- package/server/index.js +406 -0
- package/server/lib/plan-parser.js +146 -0
- package/server/lib/project-detector.js +301 -0
- package/server/package.json +19 -0
- package/server.md +742 -0
- package/who.md +151 -0
package/CLAUDE.md
ADDED
|
@@ -0,0 +1,59 @@
|
|
|
1
|
+
# CLAUDE.md - TLC Project Instructions
|
|
2
|
+
|
|
3
|
+
## Planning System: TLC
|
|
4
|
+
|
|
5
|
+
This project uses **TLC (Test-Led Coding)** for all planning and development.
|
|
6
|
+
|
|
7
|
+
**DO NOT use Claude's internal task tools** (TaskCreate, TaskUpdate, TaskList) for project planning.
|
|
8
|
+
|
|
9
|
+
Instead, use TLC's file-based system:
|
|
10
|
+
|
|
11
|
+
| Purpose | TLC Location |
|
|
12
|
+
|---------|--------------|
|
|
13
|
+
| Project overview | `PROJECT.md` |
|
|
14
|
+
| Roadmap & phases | `.planning/ROADMAP.md` |
|
|
15
|
+
| Phase plans | `.planning/phases/{N}-PLAN.md` |
|
|
16
|
+
| Task status | Markers in PLAN.md: `[ ]`, `[>@user]`, `[x@user]` |
|
|
17
|
+
| Bugs/feedback | `.planning/BUGS.md` |
|
|
18
|
+
| Test status | `.planning/phases/{N}-TESTS.md` |
|
|
19
|
+
| Config | `.tlc.json` |
|
|
20
|
+
|
|
21
|
+
## Before Starting Work
|
|
22
|
+
|
|
23
|
+
Always run `/tlc:progress` or `/tlc` to understand current state.
|
|
24
|
+
|
|
25
|
+
## Workflow Commands
|
|
26
|
+
|
|
27
|
+
| Action | Command |
|
|
28
|
+
|--------|---------|
|
|
29
|
+
| See status | `/tlc` or `/tlc:progress` |
|
|
30
|
+
| Plan a phase | `/tlc:plan` |
|
|
31
|
+
| Build (test-first) | `/tlc:build` |
|
|
32
|
+
| Verify with human | `/tlc:verify` |
|
|
33
|
+
| Log a bug | `/tlc:bug` |
|
|
34
|
+
| Claim a task | `/tlc:claim` |
|
|
35
|
+
| Release a task | `/tlc:release` |
|
|
36
|
+
| See team status | `/tlc:who` |
|
|
37
|
+
|
|
38
|
+
## Test-First Development
|
|
39
|
+
|
|
40
|
+
All implementation follows **Red → Green → Refactor**:
|
|
41
|
+
|
|
42
|
+
1. **Red**: Write failing tests that define expected behavior
|
|
43
|
+
2. **Green**: Write minimum code to make tests pass
|
|
44
|
+
3. **Refactor**: Clean up while keeping tests green
|
|
45
|
+
|
|
46
|
+
Tests are written BEFORE implementation, not after.
|
|
47
|
+
|
|
48
|
+
## After TLC Updates
|
|
49
|
+
|
|
50
|
+
If TLC command files are updated, re-read them before executing. Check version in `package.json`.
|
|
51
|
+
|
|
52
|
+
## Multi-User Collaboration
|
|
53
|
+
|
|
54
|
+
When working with teammates:
|
|
55
|
+
- Claim tasks before starting: `/tlc:claim`
|
|
56
|
+
- Release if blocked: `/tlc:release`
|
|
57
|
+
- Check team status: `/tlc:who`
|
|
58
|
+
- Pull before claiming: `git pull`
|
|
59
|
+
- Push after claiming: `git push`
|
package/README.md
CHANGED
|
@@ -70,107 +70,224 @@ TLC knows where you are and what's next. No phase numbers to remember.
|
|
|
70
70
|
|
|
71
71
|
---
|
|
72
72
|
|
|
73
|
-
##
|
|
73
|
+
## Team Collaboration
|
|
74
74
|
|
|
75
|
-
|
|
75
|
+
TLC supports distributed teams with built-in coordination.
|
|
76
76
|
|
|
77
|
-
###
|
|
77
|
+
### Task Claiming
|
|
78
78
|
|
|
79
|
-
|
|
79
|
+
Prevent duplicate work when multiple engineers use Claude Code:
|
|
80
80
|
|
|
81
|
+
```bash
|
|
82
|
+
/tlc:claim 2 # Reserve task 2
|
|
83
|
+
/tlc:release 2 # Release if blocked
|
|
84
|
+
/tlc:who # See who's working on what
|
|
81
85
|
```
|
|
82
|
-
> /tlc
|
|
83
86
|
|
|
84
|
-
|
|
85
|
-
|
|
86
|
-
|
|
87
|
-
|
|
87
|
+
Task status tracked in PLAN.md:
|
|
88
|
+
```markdown
|
|
89
|
+
### Task 1: Create schema [x@alice] ← completed by alice
|
|
90
|
+
### Task 2: Add validation [>@bob] ← bob is working
|
|
91
|
+
### Task 3: Write tests [ ] ← available
|
|
92
|
+
```
|
|
88
93
|
|
|
89
|
-
|
|
94
|
+
### Bug Tracking
|
|
95
|
+
|
|
96
|
+
QA and engineers can log bugs via CLI or web UI:
|
|
97
|
+
|
|
98
|
+
```bash
|
|
99
|
+
/tlc:bug "Login fails with + symbol in email"
|
|
90
100
|
```
|
|
91
101
|
|
|
92
|
-
|
|
102
|
+
Bugs tracked in `.planning/BUGS.md`, committed to git.
|
|
93
103
|
|
|
94
|
-
###
|
|
104
|
+
### Dev Server
|
|
95
105
|
|
|
96
|
-
|
|
106
|
+
Launch a mini-Replit experience for your team:
|
|
97
107
|
|
|
108
|
+
```bash
|
|
109
|
+
/tlc:server
|
|
98
110
|
```
|
|
99
|
-
/tlc:coverage
|
|
100
|
-
```
|
|
101
111
|
|
|
102
|
-
|
|
112
|
+
- **Live preview** — Your app embedded in dashboard
|
|
113
|
+
- **Real-time logs** — App output, test results, git activity
|
|
114
|
+
- **Bug submission** — Web form with screenshot capture
|
|
115
|
+
- **Task board** — Who's working on what
|
|
116
|
+
|
|
117
|
+
Share URL with QA/PO: `http://192.168.1.x:3147`
|
|
103
118
|
|
|
119
|
+
---
|
|
120
|
+
|
|
121
|
+
## Test Quality
|
|
122
|
+
|
|
123
|
+
### Quality Scoring
|
|
124
|
+
|
|
125
|
+
Measure and improve test quality:
|
|
126
|
+
|
|
127
|
+
```bash
|
|
128
|
+
/tlc:quality
|
|
104
129
|
```
|
|
105
|
-
Coverage: 67% (24/36 files)
|
|
106
130
|
|
|
107
|
-
|
|
108
|
-
|
|
109
|
-
|
|
131
|
+
- Coverage percentage (lines, branches, functions)
|
|
132
|
+
- Edge case detection (null, empty, boundaries)
|
|
133
|
+
- Mutation testing score
|
|
134
|
+
- Prioritized recommendations
|
|
135
|
+
|
|
136
|
+
### Edge Case Generation
|
|
110
137
|
|
|
111
|
-
|
|
112
|
-
- src/api/users.ts
|
|
113
|
-
- src/api/orders.ts
|
|
138
|
+
AI-generated edge case tests:
|
|
114
139
|
|
|
115
|
-
|
|
140
|
+
```bash
|
|
141
|
+
/tlc:edge-cases src/auth/login.ts
|
|
116
142
|
```
|
|
117
143
|
|
|
118
|
-
|
|
144
|
+
Generates tests for null inputs, boundaries, unicode, security patterns.
|
|
145
|
+
|
|
146
|
+
### Auto-Fix
|
|
119
147
|
|
|
120
|
-
|
|
148
|
+
Automatic repair of failing tests:
|
|
121
149
|
|
|
122
|
-
|
|
123
|
-
|
|
124
|
-
|
|
150
|
+
```bash
|
|
151
|
+
/tlc:autofix
|
|
152
|
+
```
|
|
153
|
+
|
|
154
|
+
- Analyzes failure reason
|
|
155
|
+
- Attempts fix with reasoning
|
|
156
|
+
- Retries up to max attempts
|
|
157
|
+
- Reports what it couldn't fix
|
|
125
158
|
|
|
126
159
|
---
|
|
127
160
|
|
|
128
161
|
## Commands
|
|
129
162
|
|
|
163
|
+
### Core
|
|
164
|
+
|
|
130
165
|
| Command | What |
|
|
131
166
|
|---------|------|
|
|
132
167
|
| `/tlc` | **Smart entry point. Knows what's next.** |
|
|
133
168
|
| `/tlc:new-project` | Start fresh. Discuss stack, scaffold. |
|
|
134
169
|
| `/tlc:init` | Add TLC to existing codebase. |
|
|
135
|
-
| `/tlc:
|
|
170
|
+
| `/tlc:discuss` | Shape implementation approach. |
|
|
171
|
+
| `/tlc:plan` | Create task plan. |
|
|
172
|
+
| `/tlc:build` | Write tests → implement → verify. |
|
|
173
|
+
| `/tlc:verify` | Human acceptance testing. |
|
|
174
|
+
|
|
175
|
+
### Quality & Testing
|
|
176
|
+
|
|
177
|
+
| Command | What |
|
|
178
|
+
|---------|------|
|
|
136
179
|
| `/tlc:status` | Test pass/fail counts. |
|
|
180
|
+
| `/tlc:coverage` | Find untested code, write tests. |
|
|
181
|
+
| `/tlc:quality` | Test quality scoring and analysis. |
|
|
182
|
+
| `/tlc:edge-cases` | Generate edge case tests. |
|
|
183
|
+
| `/tlc:autofix` | Auto-fix failing tests. |
|
|
184
|
+
| `/tlc:config` | Configure test frameworks. |
|
|
185
|
+
|
|
186
|
+
### Team Collaboration
|
|
187
|
+
|
|
188
|
+
| Command | What |
|
|
189
|
+
|---------|------|
|
|
190
|
+
| `/tlc:claim` | Reserve a task. |
|
|
191
|
+
| `/tlc:release` | Release a claimed task. |
|
|
192
|
+
| `/tlc:who` | See who's working on what. |
|
|
193
|
+
| `/tlc:bug` | Log a bug or feedback. |
|
|
194
|
+
| `/tlc:server` | Start dev server with dashboard. |
|
|
195
|
+
|
|
196
|
+
### CI/CD & Integration
|
|
197
|
+
|
|
198
|
+
| Command | What |
|
|
199
|
+
|---------|------|
|
|
200
|
+
| `/tlc:ci` | Generate CI/CD pipelines (GitHub Actions, GitLab, etc.) |
|
|
201
|
+
| `/tlc:issues` | Sync with issue trackers (GitHub, Jira, Linear). |
|
|
202
|
+
| `/tlc:docs` | Generate API docs, architecture, onboarding guides. |
|
|
203
|
+
|
|
204
|
+
### Multi-Tool & Deployment
|
|
205
|
+
|
|
206
|
+
| Command | What |
|
|
207
|
+
|---------|------|
|
|
208
|
+
| `/tlc:export` | Export rules for Cursor, Copilot, Continue, Cody. |
|
|
209
|
+
| `/tlc:deploy` | VPS deployment with branch previews. |
|
|
210
|
+
|
|
211
|
+
### Utility
|
|
212
|
+
|
|
213
|
+
| Command | What |
|
|
214
|
+
|---------|------|
|
|
137
215
|
| `/tlc:quick` | One-off task with tests. |
|
|
216
|
+
| `/tlc:complete` | Tag release. |
|
|
217
|
+
| `/tlc:new-milestone` | Start next version. |
|
|
218
|
+
| `/tlc:progress` | Check current state. |
|
|
138
219
|
|
|
139
220
|
---
|
|
140
221
|
|
|
141
|
-
##
|
|
222
|
+
## Test Framework
|
|
223
|
+
|
|
224
|
+
TLC defaults to the **mocha ecosystem**:
|
|
225
|
+
|
|
226
|
+
| Library | Purpose |
|
|
227
|
+
|---------|---------|
|
|
228
|
+
| mocha | Test runner |
|
|
229
|
+
| chai | Assertions |
|
|
230
|
+
| sinon | Mocks/stubs/spies |
|
|
231
|
+
| proxyquire | Module mocking |
|
|
232
|
+
|
|
233
|
+
### Configuration
|
|
234
|
+
|
|
235
|
+
Configure frameworks in `.tlc.json`:
|
|
236
|
+
|
|
237
|
+
```json
|
|
238
|
+
{
|
|
239
|
+
"testFrameworks": {
|
|
240
|
+
"primary": "mocha",
|
|
241
|
+
"installed": ["mocha", "chai", "sinon", "proxyquire"],
|
|
242
|
+
"run": ["mocha"]
|
|
243
|
+
}
|
|
244
|
+
}
|
|
245
|
+
```
|
|
142
246
|
|
|
143
|
-
###
|
|
247
|
+
### Multi-Framework Support
|
|
144
248
|
|
|
145
|
-
|
|
249
|
+
Projects can have multiple test frameworks:
|
|
146
250
|
|
|
147
|
-
|
|
251
|
+
```json
|
|
252
|
+
{
|
|
253
|
+
"testFrameworks": {
|
|
254
|
+
"primary": "mocha",
|
|
255
|
+
"installed": ["mocha", "jest"],
|
|
256
|
+
"run": ["mocha", "jest"]
|
|
257
|
+
}
|
|
258
|
+
}
|
|
259
|
+
```
|
|
148
260
|
|
|
149
|
-
|
|
261
|
+
Use `/tlc:config` to manage frameworks.
|
|
150
262
|
|
|
151
|
-
|
|
263
|
+
---
|
|
152
264
|
|
|
153
|
-
|
|
265
|
+
## Handling Untested Code
|
|
154
266
|
|
|
155
|
-
###
|
|
267
|
+
### External PRs / Other Developers
|
|
156
268
|
|
|
157
|
-
|
|
269
|
+
Someone pushes code without tests? TLC catches it.
|
|
158
270
|
|
|
159
271
|
```
|
|
160
|
-
|
|
161
|
-
Scale: Small team
|
|
162
|
-
Data: Simple CRUD
|
|
272
|
+
> /tlc
|
|
163
273
|
|
|
164
|
-
|
|
165
|
-
|
|
274
|
+
Found 3 new files without tests:
|
|
275
|
+
- src/api/webhooks.ts (added 2 days ago)
|
|
276
|
+
- src/utils/retry.ts (added 2 days ago)
|
|
277
|
+
- src/services/notify.ts (added yesterday)
|
|
278
|
+
|
|
279
|
+
Add tests now? (Y/n)
|
|
166
280
|
```
|
|
167
281
|
|
|
168
|
-
###
|
|
282
|
+
### After "Vibe Coding" Sessions
|
|
283
|
+
|
|
284
|
+
Built something fast without tests? No judgment. Run:
|
|
285
|
+
|
|
286
|
+
```
|
|
287
|
+
/tlc:coverage
|
|
288
|
+
```
|
|
169
289
|
|
|
170
|
-
TLC
|
|
171
|
-
- Add TLC to a project others contribute to
|
|
172
|
-
- Catch untested code from any source
|
|
173
|
-
- Gradually improve coverage over time
|
|
290
|
+
TLC scans everything, creates a prioritized backlog.
|
|
174
291
|
|
|
175
292
|
---
|
|
176
293
|
|
|
@@ -186,21 +303,86 @@ TLC doesn't require everyone to use it. You can:
|
|
|
186
303
|
/tlc:complete → Tag release
|
|
187
304
|
```
|
|
188
305
|
|
|
189
|
-
### Team Project
|
|
306
|
+
### Team Project
|
|
190
307
|
|
|
191
308
|
```
|
|
192
|
-
/tlc:
|
|
193
|
-
/tlc:
|
|
194
|
-
/tlc
|
|
309
|
+
/tlc:server → Start dev server
|
|
310
|
+
/tlc:claim 1 → Claim task 1
|
|
311
|
+
/tlc:build → Build with tests
|
|
312
|
+
git push → Share progress
|
|
313
|
+
/tlc:release → Release when done
|
|
195
314
|
```
|
|
196
315
|
|
|
197
|
-
###
|
|
316
|
+
### QA Workflow
|
|
198
317
|
|
|
318
|
+
1. Open dashboard: `http://192.168.1.x:3147`
|
|
319
|
+
2. Test features in live preview
|
|
320
|
+
3. Submit bugs via web form
|
|
321
|
+
4. Verify fixes when ready
|
|
322
|
+
|
|
323
|
+
---
|
|
324
|
+
|
|
325
|
+
## Architecture
|
|
326
|
+
|
|
327
|
+
### Planning Files
|
|
328
|
+
|
|
329
|
+
| File | Purpose |
|
|
330
|
+
|------|---------|
|
|
331
|
+
| `PROJECT.md` | Project overview, tech stack |
|
|
332
|
+
| `.planning/ROADMAP.md` | Phases and progress |
|
|
333
|
+
| `.planning/phases/{N}-PLAN.md` | Task plans |
|
|
334
|
+
| `.planning/BUGS.md` | Bug tracker |
|
|
335
|
+
| `.tlc.json` | TLC configuration |
|
|
336
|
+
| `CLAUDE.md` | Instructions for Claude |
|
|
337
|
+
|
|
338
|
+
### Task Status Markers
|
|
339
|
+
|
|
340
|
+
```markdown
|
|
341
|
+
### Task 1: Create schema [ ] ← available
|
|
342
|
+
### Task 2: Add validation [>@alice] ← claimed by alice
|
|
343
|
+
### Task 3: Write tests [x@bob] ← completed by bob
|
|
199
344
|
```
|
|
200
|
-
|
|
201
|
-
|
|
202
|
-
|
|
203
|
-
|
|
345
|
+
|
|
346
|
+
---
|
|
347
|
+
|
|
348
|
+
## Agents
|
|
349
|
+
|
|
350
|
+
TLC uses specialized AI agents for different tasks. Most are invoked automatically.
|
|
351
|
+
|
|
352
|
+
### Research Agents
|
|
353
|
+
|
|
354
|
+
| Agent | Purpose |
|
|
355
|
+
|-------|---------|
|
|
356
|
+
| `tlc-competitor-analyst` | Competitive analysis |
|
|
357
|
+
| `tlc-market-researcher` | Market landscape |
|
|
358
|
+
| `tlc-tech-researcher` | Framework evaluation |
|
|
359
|
+
| `tlc-security-researcher` | Security best practices |
|
|
360
|
+
|
|
361
|
+
### Build Agents
|
|
362
|
+
|
|
363
|
+
| Agent | Purpose |
|
|
364
|
+
|-------|---------|
|
|
365
|
+
| `tlc-planner` | Create test-first plans |
|
|
366
|
+
| `tlc-executor` | Execute Red → Green → Refactor |
|
|
367
|
+
| `tlc-coverage-analyzer` | Find untested code |
|
|
368
|
+
| `tlc-verifier` | Verify phase completion |
|
|
369
|
+
|
|
370
|
+
---
|
|
371
|
+
|
|
372
|
+
## Roadmap
|
|
373
|
+
|
|
374
|
+
TLC v1.0 - Team Collaboration Release:
|
|
375
|
+
|
|
376
|
+
- [x] **Phase 1:** Core Infrastructure (multi-user, bug tracking, server spec)
|
|
377
|
+
- [x] **Phase 2:** Test Quality & Auto-Fix
|
|
378
|
+
- [x] **Phase 3:** TLC Dev Server (mini-Replit)
|
|
379
|
+
- [x] **Phase 4:** CI/CD Integration
|
|
380
|
+
- [x] **Phase 5:** Issue Tracker Integration
|
|
381
|
+
- [x] **Phase 6:** Team Documentation
|
|
382
|
+
- [x] **Phase 7:** Multi-Tool Support (Cursor, Copilot, Continue, Cody)
|
|
383
|
+
- [x] **Phase 8:** VPS Deployment Server (with auth & Slack webhooks)
|
|
384
|
+
|
|
385
|
+
All command specs implemented. Server code in `server/` directory.
|
|
204
386
|
|
|
205
387
|
---
|
|
206
388
|
|
|
@@ -227,12 +409,6 @@ Options:
|
|
|
227
409
|
|
|
228
410
|
---
|
|
229
411
|
|
|
230
|
-
## See Also
|
|
231
|
-
|
|
232
|
-
**Using GSD?** Check out [TDD Workflow](https://github.com/jurgencalleja/tdd) — same philosophy, integrates with GSD.
|
|
233
|
-
|
|
234
|
-
---
|
|
235
|
-
|
|
236
412
|
## License
|
|
237
413
|
|
|
238
414
|
MIT
|