Skip to content

MarwanEB/npm-package-template

Repository files navigation

npm-package-template

License Build Status Code coverage

An opinionated ready-to-use vanilla Typescript npm package template.

🔗 Dependencies

To bundle this project you need to install nvm (this will allow you to install and use the correct version of Node.js / npm for this project).

Library bundles with tsup.

📖 How to use

  1. Install the right version of node / npm
nvm install && nvm use
  1. Install dependencies
npm ci
  1. Add your code to src
  2. Add export statement to src/index.ts
  3. You can build your code with the following command (once the command works properly, you will see dist folder)
  4. Publish your package
npm publish

📝 TODO

  • Add tight eslint rules

🙏 Credit

Project forked from koji/npm-package-template-with-tsup.

About

An opinionated ready-to-use vanilla Typescript npm package template.

Topics

Resources

License

Stars

Watchers

Forks