https://github.com/flarebyte/baldrick-dev-ts
CLI for TypeScript package development
https://github.com/flarebyte/baldrick-dev-ts
cli experimental npm-cli
Last synced: about 1 month ago
JSON representation
CLI for TypeScript package development
- Host: GitHub
- URL: https://github.com/flarebyte/baldrick-dev-ts
- Owner: flarebyte
- License: mit
- Created: 2021-08-25T15:38:18.000Z (almost 5 years ago)
- Default Branch: main
- Last Pushed: 2025-09-20T15:50:06.000Z (10 months ago)
- Last Synced: 2025-09-20T16:24:05.122Z (10 months ago)
- Topics: cli, experimental, npm-cli
- Language: TypeScript
- Homepage:
- Size: 392 KB
- Stars: 0
- Watchers: 1
- Forks: 1
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# 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
```bash
npx baldrick-dev-ts markdown check --with-path-starting .
```
3) Fix formatting (wrap lines, bullet style, etc.)
```bash
npx baldrick-dev-ts markdown fix --with-path-starting .
```
4) Sanity‑check your release (no publish)
```bash
npx baldrick-dev-ts release check
```
## Usage
Markdown: check and fix
```bash
# 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
```bash
# 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](https://github.com/jaredpalmer/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](MAINTENANCE.md)
- [Code Of Conduct](CODE_OF_CONDUCT.md)
- [Api for baldrick-dev-ts](API.md)
- [Contributing](CONTRIBUTING.md)
- [Glossary](GLOSSARY.md)
- [Diagram for the code base](INTERNAL.md)
- [Vocabulary used in the code base](CODE_VOCABULARY.md)
- [Architectural Decision Records](DECISIONS.md)
- [Contributors](https://github.com/flarebyte/baldrick-dev-ts/graphs/contributors)
- [Dependencies](https://github.com/flarebyte/baldrick-dev-ts/network/dependencies)
## Installation & running
This package is [ESM only](https://blog.sindresorhus.com/get-ready-for-esm-aa53530b3f77).
Run without installing globally:
```bash
npx baldrick-dev-ts --help
```
Or install locally in your project and add scripts:
```bash
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/`)