Skip to content

chore: add AGENTS.md #189

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
romhml merged 1 commit into from
Jul 13, 2026
Merged

chore: add AGENTS.md #189

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 29 additions & 0 deletions AGENTS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
# AGENTS.md

## Repo shape
- pnpm workspace (`pnpm@10.19.0`) with `docs/`, `packages/*`, and `playgrounds/*` from `pnpm-workspace.yaml`.
- Main packages: `@compodium/core` (Vite/unplugin pipeline and runtime), `@compodium/vue` (Vite plugin wrapper), `@compodium/nuxt` (Nuxt module), private `@compodium/devtools` (Nuxt app on port 4242), and `@compodium/examples`.
- Source is ESM TypeScript/Vue. Shared build defaults live in root `build.config.ts`; package builds use `unbuild`, except the Nuxt module uses `nuxt-module-build`.
- `.npmrc` defaults to `filter=@compodium/*`, `shamefully-hoist=true`, and `strict-peer-dependencies=false`; account for the implicit filter when running pnpm commands.

## Commands
- Install: `pnpm install`
- Generate local stubs/prepare Nuxt apps: `pnpm dev:prepare`
- Dev all: `pnpm dev` (sets `COMPODIUM_DEVTOOLS_URL=http://localhost:4242`)
- Focused dev: `pnpm dev:nuxt`, `pnpm dev:vue`, or `pnpm dev:docs`
- Lint: `pnpm lint`
- Typecheck all workspaces: `pnpm typecheck` (not `pnpm typechecks`; README has a stale plural typo)
- Tests: `pnpm test`
- Focused tests: `pnpm test -- packages/vue/test/basic.spec.ts`, `pnpm test -- packages/nuxt/test/basic.nuxt.test.ts`, `pnpm test -- packages/devtools/test/codegen.test.ts`, or `pnpm test -- -t "basic"`
- Focused filters: `pnpm --filter @compodium/vue typecheck`, `pnpm --filter @compodium/nuxt typecheck`, `pnpm --filter devtools dev`

## Gotchas
- Run `pnpm dev:prepare` after dependency changes or before local dev/typecheck if workspace package stubs or Nuxt generated types are missing.
- Root Vitest sets `COMPODIUM_TEST=true`; Nuxt Vitest also sets `COMPODIUM_DEVTOOLS_URL=http://localhost:4242` and loads Vue matcher setup.
- Nuxt tests and dev expect the devtools app URL to be `http://localhost:4242`; root `dev:*` scripts set it automatically.
- The Nuxt module is dev-only: `packages/nuxt/src/module.ts` returns early when `!nuxt.options.dev`.
- Keep Vite pinned through root `resolutions.vite`; do not casually bump only a subpackage Vite version.
- `@compodium/core` prepack/build runs `unbuild && pnpm --filter devtools generate`; generated devtools output lands in `packages/core/dist/client/devtools`.
- `@compodium/devtools` is a private Nuxt app with SSR disabled, base URL `/__compodium__/devtools`, and default port `4242`.
- `@compodium/examples` prepack first generates Tailwind CSS from `src/assets/ui/base.css` into `src/assets/ui/index.css`.
- ESLint uses Nuxt flat config with stylistic rules (`commaDangle: 'never'`, `braceStyle: '1tbs'`) and intentionally allows `any`.
1 change: 1 addition & 0 deletions CLAUDE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
AGENTS.md
Loading