## Store migration (packages → features) - Delete `packages/store/` — stores moved into web app's feature modules - Delete `packages/hooks/` — replaced by feature-level hooks - `features/issues/store.ts` — useIssueStore (was packages/store/issue-store) - `features/inbox/store.ts` — useInboxStore (was packages/store/inbox-store) - `features/workspace/store.ts` — absorbs agent state (was packages/store/agent-store) - All imports updated from `@multica/store` → `@/features/*/store` ## Global modal system - `features/modals/store.ts` — useModalStore (zustand) - `features/modals/registry.tsx` — ModalRegistry renders active modal - Mounted in app/layout.tsx alongside Toaster - Create Workspace dialog now works (was broken: DropdownMenu ate click) ## Workspace real-time sync - useRealtimeSync subscribes to workspace:updated, member:removed - Member removal → auto-switch to another workspace - Workspace settings update → sidebar reflects name change - Workspace switch → parallel fetch issues + inbox + agents ## Bug fixes - theme-provider: guard event.key for IME composition (isComposing check) - task.go: publish comment:created + inbox:new events on task complete/fail - listeners.go: broadcast comment:created, workspace:updated, member events - events.go: add EventCommentUpdated, EventCommentDeleted constants ## Cleanup - Remove _features/ tracking files (dev-only, not for main) - Remove server/server binary from worktree - Update CLAUDE.md to reflect new architecture Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
256 lines
12 KiB
Markdown
256 lines
12 KiB
Markdown
# CLAUDE.md
|
|
|
|
This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.
|
|
|
|
## Project Context
|
|
|
|
Multica is an AI-native task management platform — like Linear, but with AI agents as first-class citizens.
|
|
|
|
- Agents can be assigned issues, create issues, comment, and change status
|
|
- Supports local (daemon) and cloud agent runtimes
|
|
- Built for 2-10 person AI-native teams
|
|
|
|
## Architecture
|
|
|
|
**Polyglot monorepo** — Go backend + TypeScript frontend.
|
|
|
|
- `server/` — Go backend (Chi router, sqlc for DB, gorilla/websocket for real-time)
|
|
- `apps/web/` — Next.js 16 frontend (App Router)
|
|
- `packages/` — Shared TypeScript packages (ui, types, sdk, store, hooks, utils)
|
|
|
|
### Web App Structure (`apps/web/`)
|
|
|
|
The frontend uses a **feature-based architecture** with three layers:
|
|
|
|
```
|
|
apps/web/
|
|
├── app/ # Routing layer (thin shells — import from features/)
|
|
├── features/ # Business logic, organized by domain
|
|
├── shared/ # Cross-feature utilities (api client)
|
|
```
|
|
|
|
**`app/`** — Next.js App Router pages. Route files should be thin: import and re-export from `features/`. Layout components and route-specific glue (redirects, auth guards) live here. Shared layout components (e.g. `app-sidebar`) stay in `app/(dashboard)/_components/`.
|
|
|
|
**`features/`** — Domain modules, each with its own components, hooks, stores, and config:
|
|
|
|
| Feature | Purpose | Exports |
|
|
|---|---|---|
|
|
| `features/auth/` | Authentication state | `useAuthStore`, `AuthInitializer` |
|
|
| `features/workspace/` | Workspace, members, agents | `useWorkspaceStore`, `useActorName` |
|
|
| `features/issues/` | Issue state, components, config | `useIssueStore`, icons, pickers, status/priority config |
|
|
| `features/inbox/` | Inbox notification state | `useInboxStore` |
|
|
| `features/realtime/` | WebSocket connection + sync | `WSProvider`, `useWSEvent`, `useRealtimeSync` |
|
|
|
|
**`shared/`** — Code used across multiple features. Currently only `api.ts` (SDK singleton).
|
|
|
|
### State Management
|
|
|
|
- **Zustand** for global client state — one store per feature domain (`features/auth/store.ts`, `features/workspace/store.ts`, `features/issues/store.ts`, `features/inbox/store.ts`).
|
|
- **React Context** only for connection lifecycle (`WSProvider` in `features/realtime/`).
|
|
- **Local `useState`** for component-scoped UI state (forms, modals, filters).
|
|
- Do not use React Context for data that can be a zustand store.
|
|
|
|
**Store conventions:**
|
|
- One store per feature domain. Import via `useAuthStore(selector)` or `useWorkspaceStore(selector)`.
|
|
- Stores must not call `useRouter` or any React hooks — keep navigation in components.
|
|
- Cross-store reads use `useOtherStore.getState()` inside actions (not hooks).
|
|
- Dependency direction: `workspace` → `auth`, `realtime` → `auth`, `issues` → `workspace`. Never reverse.
|
|
|
|
### Import Aliases
|
|
|
|
Use `@/` alias (maps to `apps/web/`):
|
|
```typescript
|
|
import { api } from "@/shared/api";
|
|
import { useAuthStore } from "@/features/auth";
|
|
import { useWorkspaceStore } from "@/features/workspace";
|
|
import { useIssueStore } from "@/features/issues";
|
|
import { useInboxStore } from "@/features/inbox";
|
|
import { useWSEvent } from "@/features/realtime";
|
|
import { StatusIcon } from "@/features/issues/components";
|
|
```
|
|
|
|
Within a feature, use relative imports. Between features or to shared, use `@/`.
|
|
|
|
### Data Flow
|
|
|
|
```
|
|
Browser → ApiClient (SDK) → REST API (Chi handlers) → sqlc queries → PostgreSQL
|
|
Browser ← WSClient (SDK) ← WebSocket ← Hub.Broadcast() ← Handlers/TaskService
|
|
```
|
|
|
|
### Backend Structure (`server/`)
|
|
|
|
- **Entry points** (`cmd/`): `server` (HTTP API), `multica` (CLI — daemon, agent management, config), `migrate`
|
|
- **Handlers** (`internal/handler/`): One file per domain (issue, comment, agent, auth, daemon, etc.). Each handler holds `Queries`, `DB`, `Hub`, and `TaskService`.
|
|
- **Real-time** (`internal/realtime/`): Hub manages WebSocket clients. Server broadcasts events; inbound WS message routing is still TODO.
|
|
- **Auth** (`internal/auth/` + `internal/middleware/`): JWT (HS256). Middleware sets `X-User-ID` and `X-User-Email` headers. Login creates user on-the-fly if not found.
|
|
- **Task lifecycle** (`internal/service/task.go`): Orchestrates agent work — enqueue → claim → start → complete/fail. Syncs issue status automatically and broadcasts WS events at each transition.
|
|
- **Agent SDK** (`pkg/agent/`): Unified `Backend` interface for executing prompts via Claude Code or Codex. Each backend spawns its CLI and streams results via `Session.Messages` + `Session.Result` channels.
|
|
- **Daemon** (`internal/daemon/`): Local agent runtime — auto-detects available CLIs (claude, codex), registers runtimes, polls for tasks, routes by provider.
|
|
- **CLI** (`internal/cli/`): Shared helpers for the `multica` CLI — API client, config management, output formatting.
|
|
- **Database**: sqlc generates Go code from SQL in `pkg/db/queries/` → `pkg/db/generated/`. Migrations in `migrations/`.
|
|
- **Routes** (`cmd/server/router.go`): Public routes (auth, health, ws) + protected routes (require JWT) + daemon routes (unauthenticated, separate auth model).
|
|
|
|
### Key Packages
|
|
|
|
- **`@multica/sdk`**: `ApiClient` (REST) and `WSClient` (WebSocket) classes. All backend communication goes through here.
|
|
- **`@multica/types`**: Shared domain types + WebSocket event types (issue:created/updated/deleted, task:*, agent:status, comment:*, inbox:new, daemon:*).
|
|
- **`@multica/ui`**: shadcn/ui component library with Radix primitives, Tailwind CSS 4, Shiki syntax highlighting for markdown.
|
|
|
|
### Multi-tenancy
|
|
|
|
All queries filter by `workspace_id`. Membership checks gate access. `X-Workspace-ID` header routes requests to the correct workspace.
|
|
|
|
### Agent Assignees
|
|
|
|
Assignees are polymorphic — can be a member or an agent. `assignee_type` + `assignee_id` on issues. Agents render with distinct styling (purple background, robot icon).
|
|
|
|
## Commands
|
|
|
|
```bash
|
|
# One-click setup & run
|
|
make setup # First-time: ensure shared DB, create app DB, migrate
|
|
make start # Start backend + frontend together
|
|
make stop # Stop app processes for the current checkout
|
|
make db-down # Stop the shared PostgreSQL container
|
|
|
|
# Frontend
|
|
pnpm install
|
|
pnpm dev:web # Next.js dev server (port 3000)
|
|
pnpm build # Build all TS packages
|
|
pnpm typecheck # TypeScript check
|
|
pnpm test # TS tests (Vitest)
|
|
|
|
# Backend (Go)
|
|
make dev # Run Go server (port 8080)
|
|
make daemon # Run local daemon
|
|
make test # Go tests
|
|
make sqlc # Regenerate sqlc code after editing SQL in server/pkg/db/queries/
|
|
make migrate-up # Run database migrations
|
|
make migrate-down # Rollback migrations
|
|
|
|
# Run a single Go test
|
|
cd server && go test ./internal/handler/ -run TestName
|
|
|
|
# Run a single TS test
|
|
pnpm --filter @multica/web exec vitest run src/path/to/file.test.ts
|
|
|
|
# Run a single E2E test (requires backend + frontend running)
|
|
pnpm exec playwright test e2e/tests/specific-test.spec.ts
|
|
|
|
# Infrastructure
|
|
make db-up # Start shared PostgreSQL
|
|
make db-down # Stop shared PostgreSQL
|
|
```
|
|
|
|
### Worktree Support
|
|
|
|
For isolated feature testing with a separate database:
|
|
```bash
|
|
make worktree-env # Generate .env.worktree with unique DB/ports
|
|
make setup-worktree # Setup using .env.worktree
|
|
make start-worktree # Start using .env.worktree
|
|
```
|
|
|
|
## Coding Rules
|
|
|
|
- TypeScript strict mode is enabled; keep types explicit.
|
|
- Go code follows standard Go conventions (gofmt, go vet).
|
|
- Keep comments in code **English only**.
|
|
- Prefer existing patterns/components over introducing parallel abstractions.
|
|
- Unless the user explicitly asks for backwards compatibility, do **not** add compatibility layers, fallback paths, dual-write logic, legacy adapters, or temporary shims.
|
|
- If a flow or API is being replaced and the product is not yet live, prefer removing the old path instead of preserving both old and new behavior.
|
|
- Treat compatibility code as a maintenance cost, not a default safety mechanism. Avoid "just in case" branches that make the codebase harder to reason about.
|
|
- Avoid broad refactors unless required by the task.
|
|
|
|
## UI/UX Rules
|
|
|
|
- Prefer `packages/ui` shadcn components over custom implementations.
|
|
- **shadcn official components** → `packages/ui/src/components/ui/` — keep this directory clean; install missing components via `npx shadcn add`, do not mix in business code.
|
|
- **Shared business components & utils** → `packages/ui/src/components/common/` — reusable project-level UI components (e.g. ActorAvatar) and shared utilities live here.
|
|
- **Feature-specific components** → `features/<domain>/components/` — issue icons, pickers, and other domain-bound UI live inside their feature module, not in `packages/ui`.
|
|
- Use shadcn design tokens for styling (e.g. `bg-primary`, `text-muted-foreground`, `text-destructive`). Avoid hardcoded color values (e.g. `text-red-500`, `bg-gray-100`).
|
|
- Do not introduce extra state (useState, context, reducers) unless explicitly required by the design. Prefer zustand stores for shared state over React Context.
|
|
- Pay close attention to **overflow** (truncate long text, scrollable containers), **alignment**, and **spacing** consistency.
|
|
- When unsure about interaction or state design, ask — the user will provide direction.
|
|
|
|
## Testing Rules
|
|
|
|
- **TypeScript**: Vitest. Mock external/third-party dependencies only.
|
|
- **Go**: Standard `go test`. Tests should create their own fixture data in a test database.
|
|
|
|
## Commit Rules
|
|
|
|
- Use atomic commits grouped by logical intent.
|
|
- Conventional format:
|
|
- `feat(scope): ...`
|
|
- `fix(scope): ...`
|
|
- `refactor(scope): ...`
|
|
- `docs: ...`
|
|
- `test(scope): ...`
|
|
- `chore(scope): ...`
|
|
|
|
## Minimum Pre-Push Checks
|
|
|
|
```bash
|
|
make check # Runs all checks: typecheck, unit tests, Go tests, E2E
|
|
```
|
|
|
|
Run verification only when the user explicitly asks for it.
|
|
|
|
For targeted checks when requested:
|
|
```bash
|
|
pnpm typecheck # TypeScript type errors only
|
|
pnpm test # TS unit tests only (Vitest)
|
|
make test # Go tests only
|
|
pnpm exec playwright test # E2E only (requires backend + frontend running)
|
|
```
|
|
|
|
## AI Agent Verification Loop
|
|
|
|
After writing or modifying code, always run the full verification pipeline:
|
|
|
|
```bash
|
|
make check
|
|
```
|
|
|
|
This runs all checks in sequence:
|
|
1. TypeScript typecheck (`pnpm typecheck`)
|
|
2. TypeScript unit tests (`pnpm test`)
|
|
3. Go tests (`go test ./...`)
|
|
4. E2E tests (auto-starts backend + frontend if needed, runs Playwright)
|
|
|
|
**Workflow:**
|
|
- Write code to satisfy the requirement
|
|
- Run `make check`
|
|
- If any step fails, read the error output, fix the code, and re-run `make check`
|
|
- Repeat until all checks pass
|
|
- Only then consider the task complete
|
|
|
|
**Quick iteration:** If you know only TypeScript or Go is affected, run individual checks first for faster feedback, then finish with a full `make check` before marking work complete.
|
|
|
|
## E2E Test Patterns
|
|
|
|
E2E tests should be self-contained. Use the `TestApiClient` fixture for data setup/teardown:
|
|
|
|
```typescript
|
|
import { loginAsDefault, createTestApi } from "./helpers";
|
|
import type { TestApiClient } from "./fixtures";
|
|
|
|
let api: TestApiClient;
|
|
|
|
test.beforeEach(async ({ page }) => {
|
|
api = await createTestApi(); // logged-in API client
|
|
await loginAsDefault(page); // browser session
|
|
});
|
|
|
|
test.afterEach(async () => {
|
|
await api.cleanup(); // delete any data created during the test
|
|
});
|
|
|
|
test("example", async ({ page }) => {
|
|
const issue = await api.createIssue("Test Issue"); // create via API
|
|
await page.goto(`/issues/${issue.id}`); // test via UI
|
|
// api.cleanup() in afterEach removes the issue
|
|
});
|
|
```
|