TS Library template

TypeScript library template for creating npm packages.

Getting started

1. Ensure that you have the right version of node

nvm use

2. Install packages

npm i

Build

npm run build

Testing

npm t

How to contribute

Please refer to CONTRIBUTING.md.

Semantic Versioning

This project follows semantic versioning. I release patch versions for critical bugfixes, minor versions for new features or non-essential changes, and major versions for any breaking changes.

Built with

• TypeScript
• ESLint
• Prettier
• Babel
• Jest
• husky
• lint-staged

Before publishing

1. Change package name.
2. Fill out keywords section in your package.json.
3. Change private property in package.json to false.
4. Change author's name.
5. Check the license.
6. Fill out the following sections:
   • repository
   • bugs
   • homepage
7. Don't forget to set a version.
8. Check your package content:

npm pack --dry-run