BitSquare/Codeman
2
0
Fork 0
mirror of https://github.com/Ark0N/Codeman.git synced 2026-10-09 00:49:41 +02:00
Code Issues Packages Projects Releases Wiki Activity

docs: add E2E testing section and state store debouncing pattern

Browse Source 
- Make dev mode GOTCHA more prominent with warning emoji
- Add State Store Debouncing pattern documenting 100ms debounce
- Add dedicated E2E Testing section with quick test sequence
- Move E2E info from Notes to its own section

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
This commit is contained in:
arkon
2026-01-19 12:55:08 +01:00
co-authored by Claude Opus 4.5
parent 66c8f323a8
commit 0949b52830
1 changed files with 23 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files
CLAUDE.md
+23 -3
View File
@@ -22,8 +22,8 @@ npx tsx src/index.ts web -p 8080 # Dev mode with custom port
node dist/index.js web # After npm run build node dist/index.js web # After npm run build
claudeman web # After npm link claudeman web # After npm link
# GOTCHA: `npm run dev` runs CLI help, NOT the web server # ⚠️ GOTCHA: `npm run dev` runs CLI help, NOT the web server!
# Always use `npx tsx src/index.ts web` for development # Always use `npx tsx src/index.ts web` for development
# Testing (vitest - tests run against WebServer, no real Claude CLI spawned) # Testing (vitest - tests run against WebServer, no real Claude CLI spawned)
npm run test # Run all tests once npm run test # Run all tests once
@@ -163,6 +163,10 @@ The frontend uses vanilla JS with xterm.js. Key patterns:
- **Tab management**: `switchToSession()` handles terminal buffer restore + resize - **Tab management**: `switchToSession()` handles terminal buffer restore + resize
- **60fps rendering**: Server batches at 16ms intervals, client uses `requestAnimationFrame` - **60fps rendering**: Server batches at 16ms intervals, client uses `requestAnimationFrame`
### State Store Debouncing
State writes to `~/.claudeman/state.json` are debounced (100ms) to prevent excessive disk I/O during rapid updates. The `StateStore` class batches rapid state changes and writes once after activity settles.
## Adding New Features ## Adding New Features
### New API Endpoint ### New API Endpoint
@@ -216,8 +220,24 @@ Long-running sessions are supported with automatic trimming:
| Line buffer | 64KB | (flushed every 100ms) | | Line buffer | 64KB | (flushed every 100ms) |
| Respawn buffer | 1MB | 512KB | | Respawn buffer | 1MB | 512KB |
## E2E Testing (agent-browser)
Browser automation for testing the web UI. See README.md for full setup.
```bash
# Quick test sequence
npx agent-browser open http://localhost:3000
npx agent-browser wait --load networkidle
npx agent-browser snapshot
npx agent-browser find text "Run Claude" click
npx agent-browser wait 2000
npx agent-browser snapshot
npx agent-browser close
```
Full test plan available at `.claude/skills/e2e-test.md`.
## Notes ## Notes
- State persists to `~/.claudeman/state.json` and `~/.claudeman/screens.json` - State persists to `~/.claudeman/state.json` and `~/.claudeman/screens.json`
- Cases created in `~/claudeman-cases/` by default - Cases created in `~/claudeman-cases/` by default
- E2E testing available via agent-browser (see `.claude/skills/e2e-test.md`)