Skip to content

adding-a-package.md

Latest commit

 

History

History
38 lines (26 loc) · 1.43 KB

adding-a-package.md

File metadata and controls

38 lines (26 loc) · 1.43 KB

Adding a Package

Create the Package

  1. Add a new directory under packages/.
  2. Create package.json with name, version, description, license, repository.directory, engines.node, publishConfig.access, and files.
  3. Add a Pi manifest under pi when you need explicit extensions, skills, prompts, or themes paths.

TypeScript Packages

  • Extend ../../tsconfig.base.json.
  • Reuse the root Oxlint and Oxfmt config.
  • Add lint, format, format:check, typecheck, test, check, and pack:check scripts as needed.
  • Add docs/adrs/ when the package needs package-scoped architectural decision records.

ADRs

  • Keep monorepo-wide ADRs in docs/adrs/.
  • Keep package-specific ADRs in packages/<name>/docs/adrs/.
  • Use the plural directory name adrs/ for consistency with the rest of the repo.

Validation

Run:

pnpm --filter <package-name> run check
pnpm --filter <package-name> run pack:check
pnpm run validate:packages

When the package is meant for pi install, use pi install ./packages/<package-name> from the monorepo root as a maintainer smoke test of the publishable package layout. For day-to-day extension development, prefer loading the extension directly, for example with pi --extension.

Publishing Readiness

  • Keep package contents narrow with files.
  • Verify the package works from a tarball when practical.
  • Add a changeset when the package changes in a publishable way.