Nova shared libraries

This repository contains a collection of shared libraries used across the Nova ecosystem. These libraries are designed to be used across multiple projects and are intended to simplify the development process.

Usage

This package is published to npm. You can include it in your project by adding

    "@skillswaveca/nova-shared-libraries": "^3.6.1",

to your projects package.json or by running npm install @skillswaveca/nova-shared-libraries

Installation

This nova shared repository is a monorepo, which means that it contains multiple packages. It uses pnpm, so you will need to install that first

npm install -g pnpm

Once installed you can install the dependencies of the repository by running the following command:

pnpm install

Library documentation

You can find the documentation in the github pages of this repository. Here

If you want to generate the documentation for a single package you can run the following command:

pnpm run generate-docs --filter <package-name>

While it is not necessary to generate docs yourself as the CI will do it for you, you can aggregate the documentation of all the packages by running the following command:

pnpm run aggregate-docs

Testing

You can run all tests by running

pnpm -r test

Or you can run tests for an individual workspace by running

cd packages/{packageToTest}
pnpm run test

Developing locally

If you want to change this package simultaenously with a related Nova repo, you can do that using npm link (docs).

The basic steps are:

1. At the root of this repo, run npm link
2. Go to the repo you are working on and run npm link @skillswaveca/nova-shared-libraries
3. Any changes you make in @skillswaveca/nova-shared-libraries should be automatically included in the repo.

Adding a library to the repository

This repository contains a helper script for creating new libraries. You can run the following command to create a new library:

pnpm run create-library

After running the create-library script, you will be prompted to enter the name of the library you want to create and the description. The script will then create a new directory with the name you provided and will initialize a new package inside it.

> [email protected] create-library
> node ./scripts/create-library.js

Enter the package name: nova-model
Enter the package description: A library for defining models in the nova ecosystem