Researa Utility Package

This repository serves as a centralized source for shared utility functions

Getting started

Node modules

Install all node modules before

npm install

Testing locally

Create a local build by running the following command within the /utility directory:

npm run pack

To use the local build you can update the package.json dependencies to point to the local build. When manually changing the dependency be diligent to revert back to the package hosted by NPM before committing changes to git.

The updated package.json should look similar to the following:

{
  // ...
  "dependencies": {
    // ...
    "@researa/utility": "file:../../packages/utility/pack/researa-utility-<version>.tgz",
    // ...
  }
  // ...
}

Publishing the package

To publish the package, first increment the package number following the semantic versioning standard.

Once the package has been thoroughly tested, the package can be published to NPM using the following command.

npm run publish