🚀 Npm Package Stack

A minimal starter kit designed to build and publish a npm package with ease.

The Stack includes

• Git for version control
• Typescript for writing our code and keeping it type-safe
• @arethetypeswrong/cli for checking our exports
• tsup for compiling our TypeScript code into CJS and ESM
• Vitest for running our tests
• GitHub Actions for running our CI process
• Changesets for versioning and publishing our package
• Biome for formatting
• pnpm as fast, efficient package-manager

Installation

1. Fork the repository
2. Clone the repository git clone https://github.com/<your_github_username>/npm-package-stack.git
3. Navigate to the directory cd npm-package-stack
4. Make sure you edit the below properties in the package.json file
   • name
   • version
   • description
   • homepage
   • repository
   • keywords
   • author
   • license
5. Install dependencies pnpm install
6. For more scripts refer to package.json file

Make sure you have Node.js and pnpm installed in your machine

Scripts and Commands

1. pnpm build - compiles the typescript code using tsup with tsup.config.ts file as configuration
2. pnpm lint - lints the project using tsc
3. pnpm check-exports - checks if all exports from the package are correct
4. pnpm format - formats the project using biome
5. pnpm check-format - check if all files in the project are formatted correctly
6. pnpm test - test the project using vitest
7. pnpm dev - test the project using vitest in watch mode
8. pnpm prepublishOnly - run the ci script before running local-release script
9. pnpm local-release - run changeset version and publish to npm using changeset publish
10. pnpm ci - runs the CI process for GitHub actions

Project Structure

# GitHub
.
├── src
│   ├── functions.ts
│   ├── index.ts
│   └── types.ts
├── .gitignore
├── .npmignore
├── biome.json
├── package.json
├── pnpm-lock.yaml
├── README.md
├── tsconfig.json
└── tsup.config.ts

# Npm
.
├── dist
│   ├── index.d.mts
│   ├── index.d.ts
│   ├── index.js
│   └── index.mjs
├── package.json
└── README.md

Support & Contribute

If you found this project helpful or enjoyed using it, please consider giving it a ⭐️ on GitHub! It helps others find the project and motivates us to keep improving.