Packages

This directory exists to hold a variety of projects and libraries that we might publish as NPM packages. Typically used also elsewhere in Calypso and build on yarn start.

For projects that can produce independent, binary-like outputs deployed elsewhere, see /apps.

Adding a new package?

If you want to add a new project or package into this directory, then add a new directory and follow monorepo -documentation.

Building

Packages are built on Calypso's yarn so you don't need to build them manually, unless you are working directly on them.

If you must manually build a single package, run:

yarn workspace @automattic/package-name run prepare

Validating package.json

package.json is linted using ESLint. Run yarn eslint packages/*/package.json to validate them.

If you need exceptions to linting rules, add a ./eslintrc.js file to your package and disable the relevant rules.