multica/CLAUDE.md
Naiyuan Qing a2d7501d57 refactor(web): restructure to feature-based architecture with zustand stores
- Remove tab system entirely (tab-store, tab-bar, tab-link)
- Split monolithic AuthContext into zustand auth + workspace stores
- Move issue components/config to features/issues/
- Move WebSocket provider to features/realtime/
- Move api.ts to shared/
- Migrate all consumers from useAuth() to direct store imports
- Simplify sidebar: replace hand-built dropdown with shadcn DropdownMenu,
  replace custom layout wrapper with SidebarInset
- Remove unused @multica/store and @multica/hooks dependencies
- Add @/ path alias and zustand dependency
- Update CLAUDE.md with feature-based architecture conventions

Net change: +293 / -2435 lines

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
2026-03-24 16:08:36 +08:00

7.4 KiB

CLAUDE.md

This file gives coding agents high-signal guidance for this repository.

1. 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

2. Architecture

Polyglot monorepo — Go backend + TypeScript frontend.

  • server/ — Go backend (Chi + sqlc + gorilla/websocket)
  • apps/web/ — Next.js 16 frontend (App Router)
  • packages/ — Shared TypeScript packages (ui, types, sdk, utils)

2.1 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 components and config Icons, pickers, status/priority config
features/realtime/ WebSocket connection WSProvider, useWSEvent

shared/ — Code used across multiple features. Currently only api.ts (SDK singleton).

2.2 State Management

  • Zustand for global client state (features/auth/store.ts, features/workspace/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: workspaceauth, realtimeauth, issuesworkspace. Never reverse.

2.3 Import Aliases

Use @/ alias (maps to apps/web/):

import { api } from "@/shared/api";
import { useAuthStore } from "@/features/auth";
import { useWorkspaceStore } from "@/features/workspace";
import { useWSEvent } from "@/features/realtime";
import { StatusIcon } from "@/features/issues/components";

Within a feature, use relative imports. Between features or to shared, use @/.

3. Core Workflow Commands

# 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
make migrate-up       # Run database migrations
make migrate-down     # Rollback migrations

# Infrastructure
make db-up            # Start shared PostgreSQL
make db-down          # Stop shared PostgreSQL

4. 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.

5. UI/UX Rules

  • Prefer packages/ui shadcn components over custom implementations.
  • shadcn official componentspackages/ui/src/components/ui/ — keep this directory clean; install missing components via npx shadcn add, do not mix in business code.
  • Shared business components & utilspackages/ui/src/components/common/ — reusable project-level UI components (e.g. ActorAvatar) and shared utilities live here.
  • Feature-specific componentsfeatures/<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.

6. 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.

7. Commit Rules

  • Use atomic commits grouped by logical intent.
  • Conventional format:
    • feat(scope): ...
    • fix(scope): ...
    • refactor(scope): ...
    • docs: ...
    • test(scope): ...
    • chore(scope): ...

8. Verification Commands

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:

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)

9. E2E Test Patterns

E2E tests should be self-contained. Use the TestApiClient fixture for data setup/teardown:

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
});