0.0.5 โข Published 9 months ago
@stacksjs/dummy-bun-ts-pkg v0.0.5
The Simple Way
This is an opinionated TypeScript Starter kit to help kick-start development of your next Bun package.
๐ก Get Started
Luckily, it's incredibly easy to get your package development started:
# you may use this GitHub template or the following command:
bunx degit stacksjs/ts-starter my-pkg
cd my-pkg
# if you don't have pnpm installed, run `npm i -g pnpm`
bun i # install all deps
bun run build # builds the library for production-ready use
# how to create a git commit?
git add . # select the changes you want to commit
bun run commit # then simply answer the questions
# after you have successfully committed, you may create a "release"
bun run release # automates git commits, versioning, and changelog generations
Developer Experience (DX)
This Starter Kit comes pre-configured with the following:
- Powerful Build Engine - via unbuild
- Fully Typed APIs - via TypeScript 5.1
- Be a Good Commitizen - pre-configured Commitizen & git-cz setup to simplify semantic git commits, versioning, and changelog generations
- Built With Testing In Mind - pre-configured unit-testing powered by Bun
- Renovate - optimized & automated PR dependency updates
- GitHub Actions - runs your CI (fixes code style issues, tags releases & creates its changelogs, runs the test suite, etc.)
๐งช Testing
bun test
๐ Changelog
Please see our releases page for more information on what has changed recently.
๐ช๐ผ Contributing
Please see CONTRIBUTING for details.
๐ Community
For help, discussion about best practices, or any other conversation that would benefit from being searchable:
For casual chit-chat with others using this package:
Join the Stacks Discord Server
๐ License
The MIT License (MIT). Please see LICENSE for more information.
Made with โค๏ธ
0.0.5
9 months ago