Baldrick-dev-ts

CLI utilities to help with Markdown hygiene and release checks for TypeScript packages (ESM).

The current scope is intentionally small and focused to reduce setup time and dev-dependencies.

• TypeScript (ESM) friendly
• Markdown checks and formatting (remark + Prettier-based normalisation)
• Release checks and publishing helper
• Minimal config; tools invoked via npx
• Requires Node.js >= 22

Why this exists

Most projects only need a thin layer of polish and safety around docs and releases. This CLI keeps the toolchain tiny by:

• Focusing on the high‑value parts (Markdown + release checks).
• Using npx to run heavy tools on demand (no permanent dev-deps).
• Working out of the box with sensible defaults for ESM/TypeScript repos.

If you need full linting/testing stacks, use dedicated tools; this CLI won’t get in your way.

Quickstart

1. Prerequisite: Node.js 22+

2. Check your Markdown

npx baldrick-dev-ts markdown check --with-path-starting .

3. Fix formatting (wrap lines, bullet style, etc.)

npx baldrick-dev-ts markdown fix --with-path-starting .

4. Sanity‑check your release (no publish)

npx baldrick-dev-ts release check

Usage

Markdown: check and fix

# Check markdown under current repository (default extension .md)
npx baldrick-dev-ts markdown check --with-path-starting .

# Check markdown in .github/ only
npx baldrick-dev-ts markdown check --with-path-starting .github/

# Fix markdown formatting and line wrapping in-place
npx baldrick-dev-ts markdown fix --with-path-starting .

Release: dry-run check

# Check if the current version can be published (no publishing happens)
npx baldrick-dev-ts release check

Deprecated commands

• lint and test subcommands are no longer supported and only print a deprecation notice.

Acknowledgements

baldrick-dev-ts was initially created as a fork of the brilliant tsdx project. Eventually, the code has been massively refactored to match the new requirements, and very little remain of the tsdx starting point, except our gratitude to this initial project.

Documentation and links

• Code Maintenance
• Code Of Conduct
• Api for baldrick-dev-ts
• Contributing
• Glossary
• Diagram for the code base
• Vocabulary used in the code base
• Architectural Decision Records
• Contributors
• Dependencies

Installation & running

This package is ESM only.

Run without installing globally:

npx baldrick-dev-ts --help

Or install locally in your project and add scripts:

yarn add -D baldrick-dev-ts
yarn baldrick-dev-ts --help

Development

• Build: yarn build
• Lint: yarn lint (Biome via npx @biomejs/biome@latest)
• Unit tests: yarn test:ci (Node.js test runner)
• Coverage: yarn test:cov (via npx c8@latest)
• CLI smoke tests: yarn test:pest (baldrick-pest specs in pest-spec/)