Skip to content

AGENTS.md

Latest commit

 

History

History
118 lines (84 loc) · 3.8 KB

AGENTS.md

File metadata and controls

118 lines (84 loc) · 3.8 KB

Tempad Dev — agent guide (root)

Purpose

Provide a single entry point for coding agents. This file links to package-level guides and highlights repo-wide constraints and workflows.

Repo map (high level)

  • packages/extension/ — Figma plugin + MCP tools implementation
  • packages/mcp-server/ — MCP server runtime
  • packages/shared/ — shared types and contracts
  • packages/plugins/ — plugin-side code and transforms

Start here

  • packages/extension/AGENTS.md
  • packages/mcp-server/AGENTS.md
  • packages/shared/AGENTS.md
  • packages/plugins/AGENTS.md

Global conventions

  • Package manager: pnpm
  • Prefer repo-level scripts unless a package explicitly documents otherwise.
  • When creating commits, use Conventional Commits (for example: feat: ..., fix: ..., docs: ..., chore: ...).

Common commands

  • Typecheck: pnpm typecheck
  • Lint (and format): pnpm lint:fix
  • Test (watch): pnpm test
  • Test (run): pnpm test:run
  • Test (coverage): pnpm test:coverage
  • Extension node tests: pnpm --filter @tempad-dev/extension test:node
  • Extension browser tests: pnpm --filter @tempad-dev/extension test:browser
  • Extension browser setup: pnpm --filter @tempad-dev/extension test:setup

Doc index

  • TESTING.md
  • docs/testing/architecture.md
  • docs/extension/requirements.md
  • docs/extension/design.md

Guardrails

  • Keep changes minimal and consistent with existing style.
  • Avoid adding new global dependencies unless explicitly requested or approved.

Contributing & verification

Tech stack (repo-wide)

  • Package manager: pnpm (workspace scripts are commonly run as pnpm -r ...).
  • Language: TypeScript.
  • Extension: Vue 3 + WXT (Web Extension Toolkit).
  • MCP server: Node.js 18+ + @modelcontextprotocol/sdk + WebSocket transport.
  • Shared contracts: zod schemas.
  • Build tool (non-extension packages): tsdown.

Key scripts

Run these at repo root unless noted.

  • Dev extension: pnpm dev
  • Dev site: pnpm dev:site
  • Build everything: pnpm build
  • Build site: pnpm build:site
  • Build extension: pnpm build:ext
  • Build plugins: pnpm build:plugins
  • Build MCP: pnpm build:mcp
  • Typecheck all packages: pnpm typecheck
  • Lint all packages: pnpm lint / auto-fix: pnpm lint:fix
  • Test all packages: pnpm test:run
  • Coverage report: pnpm test:coverage
  • Format: pnpm format
  • Zip extension artifact: pnpm zip

Verification checklist (agent-driven changes)

Pick the checks that match your change.

  1. Always
  • pnpm typecheck
  • pnpm lint (or pnpm lint:fix)
  • pnpm test:run
  1. Extension UI / codegen
  • pnpm dev
  • In Figma, open TemPad Dev panel and validate the impacted section (e.g. “Inspect → Code”).
  1. Extension build / packaging
  • pnpm build:ext
  • pnpm zip
  1. Rewrite subsystem
  • pnpm --filter @tempad-dev/extension build:rewrite
  • Optional: pnpm --filter @tempad-dev/extension tsx scripts/check-rewrite.ts
    • Requires FIGMA_EMAIL, FIGMA_PASSWORD, FIGMA_FILE_KEY.
  1. MCP schemas / tool behavior
  • If you change tool schemas/contracts: update packages/shared first, then packages/mcp-server, then packages/extension.
  • Re-check payload limits and omission rules; see docs/extension/requirements.md and docs/extension/design.md.

Testing notes

  • Testing runbook and required checks: TESTING.md.
  • Testing architecture and coverage model: docs/testing/architecture.md.
  • Root coverage scope is configured in vitest.config.ts as the single source of truth.
  • Root coverage excludes build artifacts (**/dist/**, **/.output/**) to avoid polluted reports.
  • Root coverage provider is istanbul to avoid V8 remap parse failures under Vite 8 dependency trees.
  • Extension browser tests run in Playwright via packages/extension/vitest.browser.config.ts.
  • Do not introduce jsdom-based tests in this repository.