Files
tolaria/CLAUDE.md

7.0 KiB
Raw Blame History

CLAUDE.md — Laputa App

BEFORE EVERY COMMIT

pnpm lint && npx tsc --noEmit
pnpm test
pnpm test:coverage                  # frontend ≥70%
cargo test
cargo llvm-cov --manifest-path src-tauri/Cargo.toml --no-clean --fail-under-lines 85

CodeScene Code Health — the pre-commit and pre-push hooks enforce:

  • Hotspot Code Health ≥ 9.5 (most-edited files)
  • Average Code Health ≥ 9.31 (project-wide, ALL files)

Both gates block commit/push. If either fails: extract hooks, split large components, reduce function complexity. Never add // eslint-disable, #[allow(...)], or as any to pass the gate. Check both scores via MCP CodeScene after every significant change:

  • hotspot_code_health.now ≥ 9.5
  • code_health.now ≥ 9.31 (average — do NOT ignore this one)

If Average Code Health is below 9.0, you must fix regressions before pushing — even in files you didn't directly modify, if your changes indirectly affected complexity.

Boy Scout Rule (Robert C. Martin): Leave every file you touch better than you found it. When working on any task:

  1. Before modifying a file, check its CodeScene health: mcp__codescene__code_health_review
  2. If the file has issues (complexity, duplication, large functions), fix them as part of your work
  3. After your changes, verify the file's score is higher than before: mcp__codescene__code_health_score
  4. The goal: every commit either maintains or raises the overall average. No commit should lower it.

This is not optional — it's how we incrementally raise the codebase quality with every task.

BEFORE FIRING laputa-task-done — Two-phase QA

Phase 1: Playwright (you do this)

Write a test in tests/smoke/<slug>.spec.ts that covers every acceptance criterion. The test must fail before your fix and pass after. Run it:

pnpm dev --port 5201 &
sleep 3
BASE_URL="http://localhost:5201" npx playwright test tests/smoke/<slug>.spec.ts

If your task touches filesystem, git, AI, MCP, or any native Tauri command: also test with pnpm tauri dev against ~/Laputa (not demo vault). Use osascript keyboard events — no mouse, no cliclick.

Phase 2: Native QA (Brian does this after push)

Brian installs the release build and runs keyboard-only QA. Phase 1 must pass first or the task goes to To Rework.

Fire done signal only after Phase 1 passes — two steps, both required:

# 1. Move task to In Review on Todoist
curl -s -X POST "https://api.todoist.com/api/v1/tasks/<task_id>/move" \
  -H "Authorization: Bearer $TODOIST_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"section_id": "6g3XjX33FF4Vj86M"}'

# 2. Notify Brian
openclaw system event --text "laputa-task-done:<task_id>" --mode now

Project

Tauri v2 + React + TypeScript desktop app. Reads a vault of markdown files with YAML frontmatter.

  • Spec: docs/PROJECT-SPEC.md | Architecture: docs/ARCHITECTURE.md | Abstractions: docs/ABSTRACTIONS.md
  • Wireframes: ui-design.pen | Luca's vault: ~/Laputa/ (~9200 markdown files)
  • Stack: Rust backend, React + BlockNote editor, Vitest + Playwright + cargo test, pnpm

How to Work

  • Push directly to main — no PRs ever. The pre-push hook runs all checks.
  • NEVER open a PR — branches diverge and cause rebase churn.
  • NEVER use --no-verify
  • Commit every 2030 min: feat:, fix:, refactor:, test:, docs:

TDD (mandatory)

Red → Green → Refactor → Commit. One cycle per commit. For bugs: write a failing regression test first, then fix. Exception: pure CSS/layout with no logic.

Test quality (Kent Beck's Desiderata): every test must be Isolated (no shared state), Deterministic (no flakiness), Fast, Behavioral (tests behavior not implementation), Structure-insensitive (refactoring doesn't break it), Specific (failure points to exact cause), Predictive (all pass = production-ready). Fix flaky/non-deterministic tests before adding new ones. E2E tests over unit tests for user flows.

Docs — Keep docs/ in sync

After adding a Tauri command, new component/hook, data model change, or new integration: update docs/ARCHITECTURE.md, docs/ABSTRACTIONS.md, and/or docs/GETTING-STARTED.md in the same commit. Use Mermaid for diagrams (not ASCII). Exception: spatial wireframe layouts.

Architecture Decision Records (ADRs)

ADRs live in docs/adr/. Before making an architectural choice, check existing ADRs there first.

When to create one: storage strategy, new dependency, platform support, core abstraction change, cross-cutting concern. Use /create-adr for the full template and instructions.

Timing: create the ADR in the same commit as the code that implements the decision — never before, never after. An ADR committed without the corresponding code is invalid.

When your work supersedes an existing ADR: do not edit the existing file — use /create-adr which covers the superseding flow.

Do not create ADRs for: bug fixes, UI styling, refactors, or test additions.

Design File (UI tasks)

  1. Open ui-design.pen first — study existing frames for visual language.
  2. Design in light mode. Create design/<slug>.pen for the task.
  3. On merge to main: merge frames into ui-design.pen, delete design/<slug>.pen.

Never modify the user vault for testing

~/Laputa/ is Luca's real vault. Never create, edit, or delete notes there for testing purposes.

Use the demo vault for all testing:

  • Playwright / Vitest: use the fixtures in tests/ or demo-vault-v2/
  • pnpm tauri dev manual testing: open demo-vault-v2/ as the vault, not ~/Laputa/
  • If a test genuinely requires the real vault (e.g. verifying git history), read only — never write

Any commit that touches ~/Laputa/ content is a bug. If you accidentally created test notes there, delete them before committing.

Vault Retrocompatibility

Every feature that depends on vault files must auto-bootstrap: check if file/folder exists on vault open, create with defaults if missing (silent, idempotent). Register with the central Cmd+K → "Repair Vault" command.

Keyboard-First + Menu Bar (mandatory)

Every feature must be reachable via keyboard. Every new command palette entry must also appear in the macOS menu bar (File / Edit / View / Note / Vault / Window). This is a QA requirement.

macOS / Tauri Gotchas

  • Option+N → special chars on macOS. Use e.code or Cmd+N.
  • Tauri menu accelerators: MenuItemBuilder::new(label).accelerator("CmdOrCtrl+1").
  • app.set_menu() replaces the ENTIRE menu bar — include all submenus.
  • mock-tauri.ts silently swallows Tauri calls — not a substitute for native app testing.

QA Scripts

bash ~/.openclaw/skills/laputa-qa/scripts/focus-app.sh laputa
bash ~/.openclaw/skills/laputa-qa/scripts/screenshot.sh /tmp/out.png
bash ~/.openclaw/skills/laputa-qa/scripts/shortcut.sh "command" "s"

Documentation Diagrams

Prefer Mermaid for all diagrams (flowchart, sequenceDiagram, classDiagram, stateDiagram-v2). ASCII only for spatial wireframe layouts. GitHub renders Mermaid natively.