telestoworld-commons v0.0.1

Commons

Set of common functionality accross Telestoworld projects.

Scripts

build

Build the lib for use

lint

Lint js files with tslint

docs

Builds an static page with the JSDoc documentation

test

Run tests using mocha and chai

Release

We use semantic-release to automate the release process of this package. Every time we merge to master, the CI will run semantic-release and it will publish a new version of the package. It will determine the next version of the package and it will generate release notes from the commit messages. That's why we enforce the following format for commit messages:

type: message

or

type(scope): messages

for example

feature(Map): added zoom levels

We use husky and validate-commit-msg to enforce this format on every commit.

Continuous Deployment

If you have commons as a dependency and you're deploying to a Linux system, you might run into an error like this one: commit 2dd8319 on CircleCI.

The error comes from the installation of node-hid, you need to have libusb available for it to work, and it's not present in all Linux systems.

You can see an example of a fix in this repos config.yml file.

node-hid is a dependency of ledgerco, which in turn is a dependency of ledger-wallet-provider, used by this lib.