Skip to content
/ ts-lib-starter Public template

My TypeScript library starter

License

Notifications You must be signed in to change notification settings

u3u/ts-lib-starter

Repository files navigation

pkg-placeholder

npm version npm downloads codecov bundle JSDocs License

Using this template

  • Search pkg-placeholder and replace it with your custom package name.
  • Search u3u and replace it with your name.

Features

  • Package manager pnpm, fast and awesome!
  • Bundle with tsup, supports both cjs and esm formats at the same time
  • Test with vitest
  • Use the link: symlink to oneself for testing
  • Use GitHub action to generate changelog and automatically publish to NPM

Release

You need to add NPM_TOKEN to the secrets variable of your repository first, and then you can run npx bumpp to trigger the automated release workflow.

CommonJS

If you want to publish config like Prettier or ESLint, you may need to fix the default export.
Modify the build script in package.json and use fix-tsup-cjs to fix the default export and type definition

{
  "scripts": {
    "build": "tsup && npx fix-tsup-cjs"
  }
}

Install

pnpm add pkg-placeholder

License

MIT License © 2023 u3u

About

My TypeScript library starter

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published