https://github.com/goldenbearkin/typescript-library-boilerplate

A tree-shakable typeScript library boilerplate
https://github.com/goldenbearkin/typescript-library-boilerplate

boilerplate mocha typescript

Last synced: about 1 month ago
JSON representation

A tree-shakable typeScript library boilerplate

• Host: GitHub
• URL: https://github.com/goldenbearkin/typescript-library-boilerplate
• Owner: goldenbearkin
• Created: 2017-02-20T18:33:55.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2023-05-06T09:11:23.000Z (over 1 year ago)
• Last Synced: 2024-10-08T18:34:01.755Z (about 1 month ago)
• Topics: boilerplate, mocha, typescript
• Language: TypeScript
• Size: 84 KB
• Stars: 7
• Watchers: 2
• Forks: 2
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
[![Build Status](https://travis-ci.org/goldenbearkin/typescript-library-boilerplate.svg?branch=master)](https://travis-ci.org/goldenbearkin/typescript-library-boilerplate)

[![Coverage Status](https://coveralls.io/repos/github/goldenbearkin/typescript-library-boilerplate/badge.svg?branch=master)](https://coveralls.io/github/goldenbearkin/typescript-library-boilerplate?branch=master)

# TypeScript Library Boilerplate

A simple tree-shakable TypeScript library boilerplate

# Stacks

- **unit test**: mocha, chai

- **code coverage**: nyc, wallabyjs(optional)

- **ci**: travis

# How to use?

Just clone it and use it.

# Commands list

````

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

````

# Testing

This boilerplate use Mocha as test framework. Wallaby.js is just supplementary for development.

Delete the wallaby.js if you don't want to use it.

# Reference

[http://blog.mgechev.com/2017/01/21/distributing-an-angular-library-aot-ngc-types](http://blog.mgechev.com/2017/01/21/distributing-an-angular-library-aot-ngc-types/)

# Please help

Welcome for PR

# License

MIT