TypeScript Library Starter Template

TypeScript library starter template, provides VitePress documentation, supports building ESM, CJS and IIFE formats.

• Live Demo
• Play on Stackblitz

Features

• Build package with tsup - Bundle your TypeScript library with no config.
• Out-of-the-box unit testing with Vitest.
• VitePress documentation - Deploy on Netlify with zero-config, supports other deployment methods as well.
• Manage versions using the bumpp, and publish to npm with zero-configPublish to npm with zero-config.

Usage

Create a repo from this template on GitHub.

git clone <git remote url>

Install npm dependencies.

cd starter-lib-ts # Or your project directory

pnpm i # If you don't have pnpm installed, run: npm install -g pnpm

Just run dev script to build your files.

pnpm dev

Open documentation for the library, you can run:

pnpm docs:dev

To build the library, you can run:

pnpm build

If you want to publish it, you can run:

pnpm release

Clean Template

If you prefer to do it manually with the cleaner git history:

npx degit starter-collective/starter-lib-ts

cd starter-lib-ts

pnpm i # If you don't have pnpm installed, run: npm install -g pnpm

When you use this template, try follow the checklist to update your info properly:

• Change the package name in package.json and the global iife variable in tsup.config.ts.
• Update the website information, favicon, and logo icons in docs/*.

License

MIT License © 2024-PRESENT Kieran Wang