This package contains shared business logic between our Warp JS implementations: Web Components, React and Vue.
The aim of this package is to centralise logic that would otherwise be duplicated across our JavaScript library implementations. We wish to keep this package as raw JS as possible, while allowing for the libraries themselves to dictate the input and output types of certain functions, for example DOM operations.
This project uses
Semantic Release to
automate package publishing when making changes to the main
branch.
It is recommended to branch off the main
branch. Make sure main
branch is updated.
Follow conventional commits
when making changes. When your changes are ready for pull request, this should be
opened against the main
branch.
Please note that the version published will depend on your commit message structure. You can use commitizen to help follow this structure:
npm install -g commitizen
When installed, you should be able to type cz
or git cz
in your terminal to
commit your changes (replacing git commit
).