Skip to content

Repository files navigation

NPM Package Template

npm version License: MIT TypeScript CI/CD

A modern, production-ready TypeScript npm package template from @open-templates.

Quick Start: Click Use this template, then run npm run init to copy personalized files from templates/ into the repo root.


Using this template

  1. Use this template on GitHub to create your repository.
  2. Clone and initialize:
git clone https://github.com/open-templates/npm-package-template.git my-package
cd my-package
npm run init

npm run init copies from templates/ (README, package.json, LICENSE, .github/CODEOWNERS, etc.) with your owner, repo, and package name. The hosted template keeps @open-templates branding until you run init.

See docs/INIT_TEMPLATE.md.


Features

  • TypeScript, tsup (ESM + CJS), Vitest, ESLint flat config
  • GitHub Actions: CI, publish (Trusted Publishing + NPM_TOKEN fallback), CodeQL
  • templates/ — adopter files; see templates/ABOUT_TEMPLATES.md

Scripts

Script Description
npm run init Copy templates/ → root with your GitHub/npm metadata
npm run dev lint + typecheck + test + build

Full list: docs/TEMPLATE_SETUP.md.


License

MIT — see LICENSE.

Maintained by @open-templates.

About

A comprehensive, production-ready TypeScript npm package template with automated publishing, testing, and modern tooling.

Topics

Resources

Code of conduct

Contributing

Security policy

Stars

3 stars

Watchers

0 watching

Forks

Releases

Packages

Used by

Contributors

Languages