core-ts-lib

A library containing TypeScript that I am sharing among most TypeScript-based projects. This package is published using ES Modules only.

📦 Installation

To add to a repo, follow the instructions below for your environment:

For Node using NPM

Run yarn add @aneuhold/core-ts-lib

For Node using JSR

The below instructions still allow for things like Renovate to work, and normal commands with yarn such as yarn up.

1. Add the required JSR configuration to a .yarnrc.yml file if not there already:

   npmScopes:
     jsr:
       npmRegistryServer: 'https://npm.jsr.io'

2. Add the package with yarn add @jsr/aneuhold__core-ts-lib

For Deno

Run deno add jsr:@aneuhold/core-ts-lib

🟢 Usage

Pull in one of the services and use it like so:

import { Logger } from '@aneuhold/core-ts-lib';
// If using Node with JSR
// import { Logger } from '@jsr/aneuhold__core-ts-lib';

export default function logSomething() {
  Logger.info('Something');
}

See full documentation on usage at JSR!

🛠️ Development

Updating via PR

1. Create a new branch locally
2. Make some changes locally
3. Run yarn version patch
4. Push the branch up to a PR to make sure it passes checks
5. Once it passes checks, merge the PR and it will automatically get deployed.

Updating via Push to Main

1. Make changes locally
2. Run yarn version patch
3. Run yarn checkAll
4. Push it up to main. This will get automatically deployed.