Skip to content

Commit 4a69c7d

Browse files
docs(claude): refresh CLAUDE.md for monorepo reality
- Fix commands (pnpm dev runs Tauri; add web filter, typecheck, test:e2e) - Add packages/{web,desktop} structure - Note catalog, commitlint, semantic-release, gh account conventions
1 parent 0daeadf commit 4a69c7d

1 file changed

Lines changed: 22 additions & 13 deletions

File tree

CLAUDE.md

Lines changed: 22 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,28 +1,33 @@
11
# openconcho
22

3-
Frontend UI for self-hosted Honcho instances — browse memories, peers, sessions, conclusions, and chat with memory context.
3+
Frontend UI for self-hosted Honcho instances — browse memories, peers, sessions, conclusions, and chat with memory context. Ships as a web app (`@openconcho/web`) and a Tauri desktop wrapper (`@openconcho/desktop`).
44

55
## Commands
66

77
| Command | Purpose |
88
|---------|---------|
9-
| `pnpm dev` | Start Vite dev server (http://localhost:5173) |
10-
| `pnpm build` | Production build to `dist/` |
11-
| `pnpm lint` | Biome lint check |
12-
| `pnpm lint:fix` | Biome lint + auto-fix |
13-
| `pnpm format` | Biome format check |
14-
| `pnpm test` | Run Vitest tests |
15-
| `pnpm generate:api` | Regenerate `src/api/schema.d.ts` from `openapi.json` |
9+
| `pnpm dev` | Launch Tauri desktop app (also starts the web dev server) |
10+
| `pnpm --filter @openconcho/web dev` | Web-only dev server on http://localhost:5173 |
11+
| `pnpm build` | Turbo: build web + desktop |
12+
| `pnpm lint` | Turbo: Biome check across packages |
13+
| `pnpm typecheck` | Turbo: tsc --noEmit across packages |
14+
| `pnpm test` | Turbo: Vitest (unit + integration), excludes `e2e/` |
15+
| `pnpm test:e2e` | Turbo: Playwright e2e (uncached) |
16+
| `pnpm --filter @openconcho/web generate:api` | Regen `src/api/schema.d.ts` from `openapi.json` |
1617

1718
## Structure
1819

1920
| Path | Purpose |
2021
|------|---------|
21-
| `src/routes/` | TanStack Router file-based routes (flat-route syntax) |
22-
| `src/components/` | Feature components grouped by domain |
23-
| `src/api/` | openapi-fetch client + TanStack Query hooks |
24-
| `src/lib/` | Config (localStorage) + theme utilities |
25-
| `src/hooks/` | Custom React hooks |
22+
| `packages/web/` | Vite + React 19 + TanStack Router/Query SPA |
23+
| `packages/web/src/routes/` | TanStack Router file-based routes (flat-route syntax) |
24+
| `packages/web/src/components/` | Feature components grouped by domain |
25+
| `packages/web/src/api/` | openapi-fetch client + TanStack Query hooks |
26+
| `packages/web/src/lib/` | Config (localStorage) + theme utilities |
27+
| `packages/web/src/hooks/` | Custom React hooks |
28+
| `packages/web/src/test/` | Vitest unit/integration tests + setup |
29+
| `packages/web/e2e/` | Playwright e2e specs |
30+
| `packages/desktop/` | Tauri shell that bundles the built web app |
2631
| `.claude/rules/` | Coding conventions (auto-loaded) |
2732
| `docs/` | Architecture and references |
2833

@@ -45,3 +50,7 @@ Read `docs/architecture.md` for component overview, data flow, and design decisi
4550
- **`framer-motion` Variants typing** — import `type Variants` and annotate objects; never use `as const` on variant objects
4651
- **Auth is optional** — token header only sent when non-empty; `checkConnection()` detects if auth is required
4752
- **CSS variables only** — no Tailwind color utilities for theme-aware colors; use `var(--text-1)` etc.
53+
- **Shared deps via pnpm catalog** — version-pinned in `pnpm-workspace.yaml`; reference as `"catalog:"` in package.json
54+
- **Conventional commits enforced** — commitlint runs in husky `commit-msg`; body lines must be ≤100 chars
55+
- **Releases via semantic-release**`.releaserc.json`; commits land on `main`, no manual version bumps
56+
- **GitHub account** — push under `offendingcommit` (`gh auth switch` if needed)

0 commit comments

Comments
 (0)