RightCapital Frontend Libraries Mono repository

Introduction

This is a Mono repository contains a set of useful libraries/helpers in TypeScript.

it including the following packages:

• @rightcapital/exceptions: This library provides a set of standard Exceptions (API Reference)
• @rightcapital/assert: Type-safe assertion utilities for defensive programming (API Reference)
• @rightcapital/date-helpers: A utility class providing various date formatting and parsing methods in TypeScript (API Reference)
• @rightcapital/color-helpers: Color science related helpers (API Reference)

Development

See error handling conventions for guidance on assertions and error types.

If you are confused about Develop and README.md, please see the document How to Develop (to be done)

Adding new changes

1. After you have finished your changes, run git add with the files you have changed.
2. Run pnpm run commit to create a commit that follows the Conventional Commits specification (enforced via commitlint).

Releasing changes

1. Ensure there are no uncommitted changes in your working directory.
2. Run pnpm run change to create a version plan describing the change type and affected packages.
3. Push your branch and open a PR to main.
4. After the PR is merged, a Release PR is automatically created. Merging the Release PR triggers package publishing to npm.

Bootstrap

Install all dependencies:

pnpm install

Common commands

pnpm run build       # Build all packages
pnpm run test        # Run all tests
pnpm run lint        # Run ESLint + Prettier checks
pnpm run fix         # Auto-fix linting issues
pnpm run typecheck   # TypeScript type checking
pnpm run docs        # Generate API docs

Refs

• https://pnpm.io/workspaces
• https://nx.dev/features/manage-releases
• https://commitizen-tools.github.io/commitizen/
• https://www.conventionalcommits.org/