Monorepo for experimental snaps dependencies.
Run yarn install
in the project root directory.
Do not run any installation commands in individual workspaces.
If you add a dependency with a lifecycle script, said dependency must be added to the devDependencies
and lavamoat.allow-scripts
config of the root package.json
file.
This is currently the only way to use @lavamoat/allow-scripts
in monorepos.
Run yarn build
to build all packages in correct order.
If you encounter any errors, try yarn build:clean
, and if that fails, check the TypeScript configuration (see below).
You can also run yarn build
in a specific package / workspace, although you have to ensure that its dependencies have been built.
Repository-wide watching is currently not possible due to the build processes of some packages.
The TypeScript configuration of this monorepo is brittle, and requires manual maintenance.
It uses TypeScript project references and composite
sub-projects (i.e. monorepo package).
In short, the root tsconfig.json
must contain an empty files
array, and references
to each interdependent project with a tsconfig.json
in its root directory.
Meanwhile, every sub-project must explicitly declare the relative paths to its local dependencies via its references
array.
If building from the monorepo root suddenly starts to fail, check if the errors are referring to monorepo packages, and verify that their tsconfig.json
files are configured correctly.
Some packages do not require a tsconfig.json
file.
These packages must be explicitly ignored in the TypeScript config lint script.
If a package is neither referenced nor ignored, linting will fail.
Run yarn test
and yarn lint
in the project root directory, or in a workspace.
Follow the usual release automation workflow, the publish locally from the monorepo root using:
yarn publish:all --otp=YOUR_NPM_OTP_CODE