Skip to content

Boilerplate for NPM modules with Typescript and all the best practices

License

Notifications You must be signed in to change notification settings

yousufkalim/npm-ts-boilerplate

Repository files navigation

NPM Module Boilerplate

Start developing your NPM module in seconds

Readymade boilerplate setup with all the best practices to kick-start your npm/node module development.

Happy hacking =)

Features

  • Microbundle for bundling
  • ES6/ESNext - Write ES6 code and Microbundle will make bundle of it to ES5 for backwards compatibility
  • Test - Jest with Istanbul coverage
  • Lint - Preconfigured ESlint with best practices
  • CI - TravisCI configuration setup
  • Minify - Built code will be minified for performance

Commands

  • npm run lint - Run ESlint
  • npm run build - Microbundle will transpile ES6 => ES5 and minify the code.
  • npm run dev - Microbundle will watch and create build on change.
  • npm run test - Run tests with jest.

Installation

Just clone this repo and remove .git folder.

License

MIT © Yousuf Kalim