This is a WIP and will ultimately replace a number of stand-alone modules
Interledger.JS has a long history of modules that have been added as experiments and abandoned or deprecated and replaced by new versions or alternatives. Since late 2018 a few key modules have stabilized and become key dependencies for various others.
For a while the community has been keen to put many of the core modules into a single monorepo. The current packages included are:
The monorepo is set up to use lerna and yarn workspaces. To get started run the following:
- yarn install - Yarn will install the dependencies and do the necessary linking. So no need to run
- yarn build
- yarn test - This will run the tests in all the packages.
Running script commands
Script commands such as
lint can be run from the root of the project by running
# All tests in all packages yarn test #Scoping to a package yarn test --scope=packages/<package-name>
or in the package directory
If you are interested in contributing, please read the contributing guidelines.
Note to maintainers: Versioning
Independent versioning is used for this project and releases can only be made from
master. You will need to set the
GH_TOKEN env variable to your
personal github access token. Please make sure that you are up to date with master and that the tests and linting pass. Then use the following to create a release:
# On master GH_TOKEN=<github-token> lerna version --conventional-commits --create-release github
and follow the command prompts. This will commit the package version changes and create the necessary tags - all of which will be pushed to master. It will also create changelogs and official github releases.
If you want to release an
alpha then run
# On master GH_TOKEN=<github-token> lerna version --conventional-commits --conventional-prerelease --create-release github
This will append
-alpha.<alpha-version> to the release name. The alpha release can be graduated (
1.0.1) by running
# On master GH_TOKEN=<github-token> lerna version --conventional-commits --conventional-graduate --create-release github