TS Lib Template

A template project that make create a typescript library easily.

If you wanna known about more detail about build and publish, you can read in here.

Use degit clone template to your local machine.

npx degit git@github.com:wangkaiwd/typescript-library-template.git my-lib

Start project:

cd my-lib
pnpm install
pnpm dev

If you want to test your code in browser environment, you can try your code in playground directory

cd playground/vue-demo
pnpm dev

out of the box
Automatic linting and formatting use eslint and prettier
Build source code with rollup
Tests use vitest to make sure code quality
Automatic generate changelog.md and GitHub Release, using conventional-changelog
Intercept commit that have problems, using simple-git-hooks ,lint-staged combine with git hook
Support auto publish script, you can run npm run release when publish
Using vitepress write document
GitHub Action continuous integration

Provide feedback