tlc-claude-code 0.6.0 → 0.6.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/README.md +121 -58
- package/bin/install.js +1 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -30,23 +30,98 @@ No manual testing. No "does this work?" No vibes.
|
|
|
30
30
|
|
|
31
31
|
---
|
|
32
32
|
|
|
33
|
-
##
|
|
33
|
+
## Getting Started
|
|
34
|
+
|
|
35
|
+
### New Project
|
|
36
|
+
|
|
37
|
+
Starting from scratch? TLC guides you through everything.
|
|
38
|
+
|
|
39
|
+
```
|
|
40
|
+
/tlc:new-project
|
|
41
|
+
```
|
|
42
|
+
|
|
43
|
+
1. **Discuss requirements** — What are you building? Who uses it? What scale?
|
|
44
|
+
2. **Choose stack** — TLC suggests tech based on your answers, you approve or adjust
|
|
45
|
+
3. **Create roadmap** — Break work into phases
|
|
46
|
+
4. **Build with tests** — Each phase: write tests first, then implement
|
|
47
|
+
|
|
48
|
+
### Existing Project
|
|
49
|
+
|
|
50
|
+
Have code already? TLC adds test coverage without disrupting your workflow.
|
|
34
51
|
|
|
35
|
-
```bash
|
|
36
|
-
npx tlc-claude-code # Install
|
|
37
52
|
```
|
|
53
|
+
/tlc:init
|
|
54
|
+
```
|
|
55
|
+
|
|
56
|
+
1. **Scan codebase** — TLC detects your stack, test framework, project structure
|
|
57
|
+
2. **Find gaps** — Identifies files without tests, prioritizes critical paths
|
|
58
|
+
3. **Write tests** — Adds tests one file at a time, starting with highest priority
|
|
59
|
+
4. **Continue normally** — New features use test-first approach going forward
|
|
38
60
|
|
|
39
|
-
|
|
61
|
+
### After Setup
|
|
62
|
+
|
|
63
|
+
Once initialized, just run:
|
|
40
64
|
|
|
41
65
|
```
|
|
42
66
|
/tlc
|
|
43
67
|
```
|
|
44
68
|
|
|
45
|
-
|
|
69
|
+
TLC knows where you are and what's next. No phase numbers to remember.
|
|
70
|
+
|
|
71
|
+
---
|
|
46
72
|
|
|
47
|
-
|
|
48
|
-
|
|
49
|
-
|
|
73
|
+
## Handling Untested Code
|
|
74
|
+
|
|
75
|
+
Code comes from many sources. Not all of it has tests.
|
|
76
|
+
|
|
77
|
+
### External PRs / Other Developers
|
|
78
|
+
|
|
79
|
+
Someone pushes code without tests? TLC catches it.
|
|
80
|
+
|
|
81
|
+
```
|
|
82
|
+
> /tlc
|
|
83
|
+
|
|
84
|
+
Found 3 new files without tests:
|
|
85
|
+
- src/api/webhooks.ts (added 2 days ago)
|
|
86
|
+
- src/utils/retry.ts (added 2 days ago)
|
|
87
|
+
- src/services/notify.ts (added yesterday)
|
|
88
|
+
|
|
89
|
+
Add tests now? (Y/n)
|
|
90
|
+
```
|
|
91
|
+
|
|
92
|
+
TLC tracks what's tested. When new untested code appears, it flags it.
|
|
93
|
+
|
|
94
|
+
### After "Vibe Coding" Sessions
|
|
95
|
+
|
|
96
|
+
Built something fast without tests? No judgment. Run:
|
|
97
|
+
|
|
98
|
+
```
|
|
99
|
+
/tlc:coverage
|
|
100
|
+
```
|
|
101
|
+
|
|
102
|
+
TLC scans everything, creates a prioritized backlog:
|
|
103
|
+
|
|
104
|
+
```
|
|
105
|
+
Coverage: 67% (24/36 files)
|
|
106
|
+
|
|
107
|
+
Critical (no tests):
|
|
108
|
+
- src/auth/session.ts ← security
|
|
109
|
+
- src/payments/charge.ts ← money
|
|
110
|
+
|
|
111
|
+
High priority:
|
|
112
|
+
- src/api/users.ts
|
|
113
|
+
- src/api/orders.ts
|
|
114
|
+
|
|
115
|
+
Add to backlog and start? (Y/n)
|
|
116
|
+
```
|
|
117
|
+
|
|
118
|
+
### Continuous Coverage
|
|
119
|
+
|
|
120
|
+
TLC integrates with your workflow:
|
|
121
|
+
|
|
122
|
+
- **Before builds** — `/tlc:status` shows pass/fail counts
|
|
123
|
+
- **Before releases** — `/tlc:coverage` ensures nothing slipped through
|
|
124
|
+
- **Daily habit** — `/tlc` reminds you of untested code
|
|
50
125
|
|
|
51
126
|
---
|
|
52
127
|
|
|
@@ -56,10 +131,10 @@ Mid-project? It picks up where you left off.
|
|
|
56
131
|
|---------|------|
|
|
57
132
|
| `/tlc` | **Smart entry point. Knows what's next.** |
|
|
58
133
|
| `/tlc:new-project` | Start fresh. Discuss stack, scaffold. |
|
|
59
|
-
| `/tlc:init` | Add TLC to existing
|
|
60
|
-
| `/tlc:coverage` | Find untested
|
|
61
|
-
| `/tlc:
|
|
62
|
-
| `/tlc:
|
|
134
|
+
| `/tlc:init` | Add TLC to existing codebase. |
|
|
135
|
+
| `/tlc:coverage` | Find untested code, write tests. |
|
|
136
|
+
| `/tlc:status` | Test pass/fail counts. |
|
|
137
|
+
| `/tlc:quick` | One-off task with tests. |
|
|
63
138
|
|
|
64
139
|
---
|
|
65
140
|
|
|
@@ -73,7 +148,11 @@ TLC: plan → **write failing tests** → build until tests pass
|
|
|
73
148
|
|
|
74
149
|
The tests *are* the spec. No ambiguity.
|
|
75
150
|
|
|
76
|
-
### 2.
|
|
151
|
+
### 2. Catches Coverage Gaps
|
|
152
|
+
|
|
153
|
+
New code without tests? TLC notices. External PRs? Flagged. Post-hackathon cleanup? Prioritized backlog ready.
|
|
154
|
+
|
|
155
|
+
### 3. Smart Stack Selection
|
|
77
156
|
|
|
78
157
|
Don't pick tech in a vacuum. TLC asks what you're building, who uses it, what scale — then suggests the right stack.
|
|
79
158
|
|
|
@@ -86,72 +165,56 @@ Data: Simple CRUD
|
|
|
86
165
|
→ Why: Fast to build, cheap to host, fits your needs
|
|
87
166
|
```
|
|
88
167
|
|
|
89
|
-
###
|
|
168
|
+
### 4. Works With Your Team
|
|
90
169
|
|
|
91
|
-
|
|
170
|
+
TLC doesn't require everyone to use it. You can:
|
|
171
|
+
- Add TLC to a project others contribute to
|
|
172
|
+
- Catch untested code from any source
|
|
173
|
+
- Gradually improve coverage over time
|
|
92
174
|
|
|
93
|
-
|
|
94
|
-
┌──────────────────────────────────────────────────────┐
|
|
95
|
-
│ Agents │
|
|
96
|
-
│ [1] ● Working on #42: Auth flow │
|
|
97
|
-
│ [2] ● Working on #43: User CRUD │
|
|
98
|
-
│ [3] ○ Idle │
|
|
99
|
-
└──────────────────────────────────────────────────────┘
|
|
100
|
-
```
|
|
175
|
+
---
|
|
101
176
|
|
|
102
|
-
|
|
177
|
+
## Workflow Examples
|
|
103
178
|
|
|
104
|
-
|
|
179
|
+
### Solo Developer, New Project
|
|
105
180
|
|
|
106
|
-
|
|
181
|
+
```
|
|
182
|
+
/tlc:new-project → Discuss requirements, choose stack
|
|
183
|
+
/tlc → Build phase 1 (tests first)
|
|
184
|
+
/tlc → Build phase 2 (tests first)
|
|
185
|
+
...
|
|
186
|
+
/tlc:complete → Tag release
|
|
187
|
+
```
|
|
107
188
|
|
|
108
|
-
|
|
189
|
+
### Team Project, Existing Codebase
|
|
109
190
|
|
|
110
|
-
|
|
191
|
+
```
|
|
192
|
+
/tlc:init → Set up TLC, scan codebase
|
|
193
|
+
/tlc:coverage → Write tests for critical paths
|
|
194
|
+
/tlc → Continue with test-first for new work
|
|
195
|
+
```
|
|
111
196
|
|
|
112
|
-
|
|
197
|
+
### After External Contributions
|
|
113
198
|
|
|
114
199
|
```
|
|
115
|
-
|
|
116
|
-
|
|
117
|
-
|
|
118
|
-
│ Building login endpoint... │ #43 User CRUD │
|
|
119
|
-
│ ✓ Created tests/auth.test.ts │ #44 Dashboard │
|
|
120
|
-
│ ✓ Tests failing (expected) ├──────────────────────┤
|
|
121
|
-
│ Implementing... │ Agents (2/3) │
|
|
122
|
-
│ │ [1] ● #42 │
|
|
123
|
-
│ │ [2] ● #43 │
|
|
124
|
-
│ │ [3] ○ Idle │
|
|
125
|
-
├─────────────────────────────────┼──────────────────────┤
|
|
126
|
-
│ > add password reset flow │ Tests: 23/23 ✓ │
|
|
127
|
-
└─────────────────────────────────┴──────────────────────┘
|
|
200
|
+
git pull → Get latest changes
|
|
201
|
+
/tlc → "Found 2 untested files. Add tests?"
|
|
202
|
+
y → Tests written for new code
|
|
128
203
|
```
|
|
129
204
|
|
|
130
|
-
TUI dashboard. Multiple panes. Real-time updates.
|
|
131
|
-
|
|
132
205
|
---
|
|
133
206
|
|
|
134
207
|
## Philosophy
|
|
135
208
|
|
|
136
209
|
**Tests define behavior. Code makes tests pass.**
|
|
137
210
|
|
|
138
|
-
- Tests written BEFORE code
|
|
139
|
-
-
|
|
140
|
-
-
|
|
211
|
+
- Tests written BEFORE code (for new features)
|
|
212
|
+
- Untested code gets flagged (for external contributions)
|
|
213
|
+
- Coverage gaps get prioritized (for legacy code)
|
|
141
214
|
- Human verification still happens — tests catch logic errors, you catch "not what I meant"
|
|
142
215
|
|
|
143
216
|
---
|
|
144
217
|
|
|
145
|
-
## vs Other Approaches
|
|
146
|
-
|
|
147
|
-
| Approach | Process | Result |
|
|
148
|
-
|----------|---------|--------|
|
|
149
|
-
| Vibe coding | Build → hope | Works until it doesn't |
|
|
150
|
-
| Manual TDD | Write tests yourself | Slow, easy to skip |
|
|
151
|
-
| **TLC** | Tests auto-generated first | Fast, guaranteed coverage |
|
|
152
|
-
|
|
153
|
-
---
|
|
154
|
-
|
|
155
218
|
## Install
|
|
156
219
|
|
|
157
220
|
```bash
|
|
@@ -159,7 +222,7 @@ npx tlc-claude-code
|
|
|
159
222
|
```
|
|
160
223
|
|
|
161
224
|
Options:
|
|
162
|
-
- `--global` — Available
|
|
225
|
+
- `--global` — Available in all projects
|
|
163
226
|
- `--local` — This project only
|
|
164
227
|
|
|
165
228
|
---
|
package/bin/install.js
CHANGED