@postmates/bizops-frontend-utils

bizops-frontend-utils

Common front end utility functions shared across Business Operations Repositories. See the following Proposal document outling the reasoning behind this library.

Getting Started

1. Install nvm to your local machine.
2. Run nvm install 10.13.0.
3. Run npm install.

Guide to writing utility functions

1. Add utility functions inside of the src/ directory
2. Include tests in the tests directory. Ensure that the utility function is 90% coveraged, per repository requirements.
3. Ensure that all new file(s) are linted by running, npm run lint
4. Document the purpose of the utility and provide an explanation under the src/UTILS.md file

Publishing utility functions

1. Log in to npm via npm login in your terminal
2. Increase the version of the application by going into the package.json file, and incrementing the version of the app.
3. Type npm publish
4. More information can be found in this publishing to npm link.
5. npm registry for bizops-front-utils found in the private postmates registry.