Development Guide

This repository uses pnpm and nx as its build system. Unless mentioned, all commands assume your working directory to be the project root.

To install dependencies: pnpm i && pnpm i -C packages/{core/adapter}

To build: npx nx build {core,adapter}

To test locally via Verdaccio:

Execute pnpm set registry http://localhost:4873/ --location project.
Run a local npm registry: nx local-registry.
If you have fetched dependencies at least once, the package metadata may linger in the cache and publishing may fail with 409 Conflict. The solution is to pnpm unpublish PKG@VERSION it first.
Remember to revert the change in .npmrc after testing.

Publishing

Make sure the repository is clean and use nx to publish:

Bump the version of the package you would like to publish.
Run the build command.
Run nx run PKG:nx-release-publish where PKG is the specific package.
FIXME: Running nx-release-publish directly is not recommended.