Introduction

The @vode-app/common package is a shared library for Vode App, providing utilities and types that can be used across both frontend and backend projects.

Table of Contents

1. Quick Start
2. Documentation
3. DevOps
   1. Change Management
   2. Publish
      1. npmjs.org
      2. Custom registry

Quick Start

<QUICK START INSTRUCTIONS>

Documentation

<DOCUMENTATION>

DevOps

bun update
bun install

bun run clean
bun run build
bun run tests

bun run --watch scripts/dev.ts

# see publish section for publish instructions

Change Management

1. Create a new branch for the change.
2. Make the changes and commit.
3. Bump the version in package.json.
4. Add an entry for the new version in CHANGELOG.md.
5. Pull request the branch.
6. Ensure package artifacts are current.
7. Publish.

Publish

See the following sources to configure the target registry and authentication.

• Configuring npm - npmrc
• Bun package manager - install.registry

⚠️ Package Scope and the authentication for the target registry must be aligned.

npmjs.org

Publish to the public npm registry.

# authenticate
npm login
# publish
bun publish --registry https://registry.npmjs.org/ --access public

Custom registry

# placeholder:
  # <SCOPE_WITHOUT_AT: <SCOPE_WITHOUT_AT>
  # <REGISTRY_URL: <REGISTRY_URL>
  # <BUN_PUBLISH_AUTH_TOKEN: <BUN_PUBLISH_AUTH_TOKEN>

~/.bunfig.toml or bunfig.toml:

[install.scopes]
"<SCOPE_WITHOUT_AT>" = { url = "<REGISTRY_URL>", token = "$BUN_PUBLISH_AUTH_TOKEN" }

# authenticate
$env:BUN_PUBLISH_AUTH_TOKEN = "<BUN_PUBLISH_AUTH_TOKEN>"
# publish
bun publish