- pnpm workspace (
pnpm@10.19.0) withdocs/,packages/*, andplaygrounds/*frompnpm-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 useunbuild, except the Nuxt module usesnuxt-module-build. .npmrcdefaults tofilter=@compodium/*,shamefully-hoist=true, andstrict-peer-dependencies=false; account for the implicit filter when running pnpm commands.
- Install:
pnpm install - Generate local stubs/prepare Nuxt apps:
pnpm dev:prepare - Dev all:
pnpm dev(setsCOMPODIUM_DEVTOOLS_URL=http://localhost:4242) - Focused dev:
pnpm dev:nuxt,pnpm dev:vue, orpnpm dev:docs - Lint:
pnpm lint - Typecheck all workspaces:
pnpm typecheck(notpnpm 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, orpnpm test -- -t "basic" - Focused filters:
pnpm --filter @compodium/vue typecheck,pnpm --filter @compodium/nuxt typecheck,pnpm --filter devtools dev
- Run
pnpm dev:prepareafter 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 setsCOMPODIUM_DEVTOOLS_URL=http://localhost:4242and loads Vue matcher setup. - Nuxt tests and dev expect the devtools app URL to be
http://localhost:4242; rootdev:*scripts set it automatically. - The Nuxt module is dev-only:
packages/nuxt/src/module.tsreturns early when!nuxt.options.dev. - Keep Vite pinned through root
resolutions.vite; do not casually bump only a subpackage Vite version. @compodium/coreprepack/build runsunbuild && pnpm --filter devtools generate; generated devtools output lands inpackages/core/dist/client/devtools.@compodium/devtoolsis a private Nuxt app with SSR disabled, base URL/__compodium__/devtools, and default port4242.@compodium/examplesprepack first generates Tailwind CSS fromsrc/assets/ui/base.cssintosrc/assets/ui/index.css.- ESLint uses Nuxt flat config with stylistic rules (
commaDangle: 'never',braceStyle: '1tbs') and intentionally allowsany.