Common lib

About

• This project is used for pure just common utils, helpers, etc... This is an isomorphic lib that should run on all target browsers and node versions.

Notes

• This project should not make requests to our API or use any of our services.

Setup

Install

• npm ci

Commiting changes

• npm run commit - Runs git-cz. For breaking changes make sure to indicate that in the commit prompts so that semantic-release can do it's thing

Test

• npm test
• npm test -- path/to/file.js

Running

• npm start - runs storybook on port 3000

Local development

When adding/modifying function in the lib it will often be helpful to link it to the repo in which the changes need to be used. To do that run:

• npm link in the root of this repo
• npm link @revved/lib-common in the root of the other repo
• Use npm run rollup:watch for local dev to automatically rebuild on code changes. Else manually run rollup between changes. npm run rollup

Don't forget to update the lib-common dep after the MR in this repo is merged and published

Beta builds

• Run npm run deploy:beta from a branch that matches one of the branch patterns in .releaserc (except on develop or master as these should only be deployed by CI)
• e.g. run npm run deploy:beta from a branch beta will trigger a build if the other conditions are met for a patch, minor, major release