Skip to content

TS-DK: The TypeScript DevKit for building better TypeScript apps fast.

License

Notifications You must be signed in to change notification settings

Lievesley/ts-dk

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

22 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

TS-DK

TS-DK is the TypeScript DevKit: a growing set of TypeScript-first packages, patterns, and tooling intended to help you build better TypeScript apps faster.

  • Who it’s for: TypeScript developers building Node.js services, CLIs, and libraries who want high-quality, composable utilities and a clean DX.
  • What’s in here: a pnpm workspace monorepo (packages/*) plus a Docusaurus docs site with generated API reference.

Documentation

Packages

@private-test-org/debug

Lightweight logging utilities for Node.js with level + component filtering, console/file sinks, and simple composition helpers.

  • Source: packages/debug/
  • Package README: packages/debug/README.md
  • API: /api/debug/latest/

Quick start:

import {
    LogLevel,
    logMessage,
    startConsoleLogWriterWithMinLevel,
} from '@private-test-org/debug';

startConsoleLogWriterWithMinLevel(LogLevel.INFO);
logMessage({ level: LogLevel.INFO, component: 'app' }, 'Hello, %s', 'world');

Repo quick start (development)

Prerequisites

  • Node.js LTS (see .nvmrc)
  • pnpm 10+

Setup

pnpm install
pnpm prepare

Common commands

# Run tests across workspace packages
pnpm test

# Lint
pnpm run lint

# Build all packages
pnpm run build

# Generate API docs (TypeDoc) into packages/docs-site/docs/api
pnpm run docs:prepare

# Start docs site locally (generates API docs first)
pnpm run docs:start

# Build docs site (generates API docs first)
pnpm run docs:build

How API docs work

API docs are generated by TypeDoc into the Docusaurus docs tree:

  • Generator: scripts/prepareApiDocs.mjs
  • Output: packages/docs-site/docs/api/

Each package gets versioned output under api/<pkg>/v<version>/..., and the docs site also provides stable latest routes (redirects) under api/<pkg>/latest/....

License

ISC (see LICENSE).

About

TS-DK: The TypeScript DevKit for building better TypeScript apps fast.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 2

  •  
  •