stacksjs / ts-starter Goto Github PK

View Code? Open in Web Editor NEW

1.0 1.0 2.0 2.14 MB

Quickly bootstrap your next TypeScript / Bun project.

License: MIT License

JavaScript 91.28% TypeScript 8.72%

ts-starter's Introduction

bun-ts-starter

This is an opinionated TypeScript Starter kit to help kick-start development of your next Bun package.

Get Started

It's rather simple to get your package development started:

# you may use this GitHub template or the following command:
bunx degit stacksjs/bun-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

Check out the package.json scripts for more commands.

Developer Experience (DX)

This Starter Kit comes pre-configured with the following:

Powerful Build Process - via Bun
Fully Typed APIs - via TypeScript
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:

Discussions on GitHub

For casual chit-chat with others using this package:

Join the Stacks Discord Server

Postcardware

Stacks OSS will always stay open-sourced, and we will always love to receive postcards from wherever Stacks is used! And we also publish them on our website. Thank you, Spatie.

Our address: Stacks.js, 5710 Crescent Park #107, Playa Vista 90094, CA, USA 🌎

📄 License

The MIT License (MIT). Please see LICENSE for more information.

Made with 💙

ts-starter's People

Contributors

Stargazers

Watchers

Forkers

mfeckie moooooork

ts-starter's Issues

Dependency Dashboard

This issue lists Renovate updates and detected dependencies. Read the Dependency Dashboard docs to learn more.

Repository problems

These problems occurred while renovating this repository. View logs.

WARN: Using npm packages for Renovate presets is now deprecated. Please migrate to repository-based presets instead.

Open

These updates have all been created already. Click a checkbox below to force a retry/rebase of any.

chore(deps): update all non-major dependencies (@commitlint/cli, @types/bun, @types/node, bumpp, cz-git, simple-git-hooks, typescript)

Detected dependencies

bun

package.json

@commitlint/cli ^19.2.0

@stacksjs/eslint-config ^0.59.11

@types/bun ^1.0.8

@types/node ^20.11.28

bumpp ^9.4.0

changelogen ^0.5.5

commitizen ^4.3.0

cz-git ^1.9.0

lint-staged ^15.2.2

simple-git-hooks ^2.11.0

typescript ^5.4.2

github-actions

.github/workflows/ci.yml

actions/checkout v4

oven-sh/setup-bun v1

actions/cache v4

actions/checkout v4

oven-sh/setup-bun v1

actions/cache v4

actions/checkout v4

oven-sh/setup-bun v1

actions/cache v4

.github/workflows/release.yml

actions/checkout v4

actions/setup-node v4

oven-sh/setup-bun v1

actions/cache v4

Check this box to trigger a request for Renovate to run again on this repository

README instructions fail

Describe the bug

bun install -d bun-plugin-dts-auto fails with Failed to parse argument due to unexpected single dash

And

After manually adding to package.json and running bun install, builds fail with the message

error: Could not resolve: "bun-plugin-dts-auto". Maybe you need to "bun install"?
import dts from 'bun-plugin-dts-auto'
                ^
/Users/experiments/totter/build.ts:1:17 16error: script "build" exited with code 1 (SIGHUP)

Reproduction

System Info

  System:
    OS: macOS 13.5
    CPU: (10) arm64 Apple M1 Pro
    Memory: 240.33 MB / 32.00 GB
    Shell: 5.9 - /opt/homebrew/bin/zsh
  Binaries:
    Node: 18.16.1 - ~/.asdf/installs/nodejs/18.16.1/bin/node
    Yarn: 1.22.19 - ~/.yarn/bin/yarn
    npm: 8.19.4 - ~/.asdf/plugins/nodejs/shims/npm
    pnpm: 8.6.10 - ~/Library/pnpm/pnpm
    Watchman: 2023.07.24.00 - /opt/homebrew/bin/watchman
  Browsers:
    Brave Browser: 115.1.56.20
    Chrome: 115.0.5790.114
    Edge: 114.0.1823.67
    Safari: 16.6

Used Package Manager

bun

Validations

Follow our Code of Conduct
Read the Contributing Guide.
Check that there isn't already an issue that reports the same bug to avoid creating a duplicate.
Check that this is a concrete bug. For Q&A, please open a GitHub Discussion instead.
The provided reproduction is a minimal reproducible of the bug.