Contributing

pnpm install
pnpm exec playwright install chromium

pnpm typecheck && pnpm test && pnpm test:e2e

• Packages live in packages/. Workspace packages resolve each other's TypeScript sources through the source export condition, so you don't need to build them during development. pnpm test and pnpm test:e2e build first, so they test what gets published.

• Adding an action:

  1. Add its schema to packages/protocol/src/schemas.ts.
  2. Implement it in packages/host (background group, content group or frame bridge).
  3. Add it to a group so permissionsFor() knows what it needs.
  4. Test it in tests/e2e.
  5. Run pnpm docs:actions.

  Actions must stay declarative: no running code, scripts or HTML sent by a controller (Chrome Web Store policy, and the security model).

• Templates for npm create extension-use are in packages/create-extension-use/templates. shared/ is copied first, then the template's own folder. A .skip file lists shared files a template doesn't want.

• Releases use changesets: run pnpm changeset in your PR to describe the change.

Working on these docs

The site is built with VitePress from the docs/ folder.

pnpm docs:dev

pnpm docs:build

The site is served at extension-use.appzlr.com by a Cloudflare Worker with static assets (docs/wrangler.jsonc). To publish, with wrangler logged in:

pnpm docs:deploy

• The action reference is generated from the schemas. Run pnpm docs:actions after changing an action, and don't edit actions.md by hand.
• The package picker is a Vue component in docs/.vitepress/theme/components/PackagePicker.vue. Update it when an option, entry point or command changes.
• Link between pages with relative .md paths, so links work on GitHub and on the site.