Development

July 9, 2026 ยท View on GitHub

This document describes how you can lint, test, build and publish this project.

Prerequisite

Before you can start you must install and configure the following products on your development machine:

You will then need to clone this project and install the required dependencies:

git clone <repository_url> <dir_name>
cd <dir_name>
npm install

Linting/verifying source code

Check that the code is properly formatted and adheres to coding style.

npm run lint

Unit testing

Ensure that each unit of the library performs as expected.

npm run test

Testing locally

You can test the library while developing it, as follow:

  1. Make any modification to the source code

  2. Run the cli

    npm run start

Building the library

The library will be built in the ./dist directory.

npm run build

Publishing to NPM repository

This project comes with automatic continuous delivery (CD) using GitHub Actions.

  1. Bump the library version in ./package.json
  2. Push the changes
  3. Create a new GitHub release
  4. Watch the results in: Actions