NPM Package TemplateModern TypeScript Package Starter

Everything you need to build, test, document, and publish high-quality npm packages.

Get Started

View on GitHub

📦

Dual Package Support

Build ESM and CommonJS with tsup. Ship packages that work everywhere.

🧪

Testing with Vitest

Fast unit testing with coverage reports. Catch bugs before they ship.

📝

Automated Documentation

VitePress for guides, TypeDoc for API reference. Deploy to GitHub Pages.

🔍

Quality Tooling

ESLint 9, Prettier, publint, and knip. Keep your code clean and your package valid.

🪝

Git Hooks

Husky + lint-staged. Automatic linting on commit, full checks on push.

🚀

Automated Releases

Changesets for versioning, GitHub Actions for CI/CD. Publish with confidence.

Quick Start

bash

# Clone the template
git clone https://github.com/MoaazKHASSAWNEH/NPM-Package.git my-package
cd my-package

# Initialize your package
node scripts/init-template.mjs

# Start developing
pnpm dev

What's Included

Category	Tools
Build	tsup (ESM + CJS + types)
Test	Vitest with V8 coverage
Lint	ESLint 9 flat config + Prettier
Documentation	VitePress + TypeDoc
Git Hooks	Husky + lint-staged
CI/CD	GitHub Actions
Releases	Changesets

Next Steps

Getting Started — Prerequisites and setup
Scripts Reference — All available npm scripts
Build & Exports — How the build works
CI/CD — GitHub Actions workflows
Releases — Publishing with Changesets