Typescript Library Boilerplate Generator

Yeoman generator for a simple tree-shakable typeScript library boilerplate.

Out of the box, you have:

• Mocha - unit test framework.
• Travis CI - continuous integration platform for GitHub projects.
• Istanbul - provide code coverage report.
• Tslint - linter for TypeScript source files.

Installation

First, install Yeoman and generator-typescript-library-boilerplate using npm (we assume you have pre-installed node.js).

npm install -g yo
npm install -g generator-typescript-library-boilerplate

Then generate the new project under your desired folder:

yo typescript-library-boilerplate

Go to https://travis-ci.org to activate CI as well as the build badge.

Go to https://coveralls.io to activate the coverage badge.

Scripts

yarn test           // run test(mocha) and coverage report(nyc)
yarn test:watch     // run test on watch mode (without coverage report)
yarn build          // build for both esm (ES5 + ES2015 module) and ES5 UMD bundle, at dist folder.
yarn lint           // run lint against lib and test

License

MIT © goldenbearkin