0.0.2 • Published 11 months ago

npm-package-stack v0.0.2

Weekly downloads
-
License
MIT
Repository
github
Last release
11 months ago

šŸš€ Npm Package Stack

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

The Stack includes

  • Typescript for type safe and maintainable npm package
  • tsup for build the package
  • Biome for formatting and linting
  • pnpm as fast, efficient package-manager

Installation

  1. Clone the repository git clone https://github.com/rahu1gg/npm-package-stack.git
  2. Navigate to the directory cd npm-package-stack
  3. Make sure you edit the below properties in the package.json file
    • name
    • version
    • description
    • homepage
    • repository
    • keywords
    • author
    • license
  4. Install dependencies pnpm install
  5. Building the package pnpm build

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

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.

0.0.2

11 months ago

0.0.1

11 months ago