/rollup-typescript-mocha-template

Primary LanguageJavaScript

Rollup, Typescript, & Mocha Starter Project

This package contains a compact and lightweight TypeScript 2.0 boilerplate that export a single file.

Estimated bundle time: 0.3 ms. (Depends on your computer.)

Features

  • Statically typed build system for working with Typescript 2.0 Pre
  • Consistent code style with TSLint.
  • Coverage report with Istanbul
  • Dead code elimination
  • VSCode integration
  • Optional JSDOM
  • Rollup for bundling
  • Bublé as the ES2015 compiler
  • Sinon for test doubles
  • Mocha & Chai de facto standard
  • JSX
  • Environment variabels
  • Easy debugging

npm Scripts

  • build - creates a development and production bundle
  • build:dev - creates a development bundle
  • build:prod - creates a production bundle
  • coverage - shows the coverage report
  • clean - remove the dist, coverage and build folders
  • test - run all unit tests in the node.js environment
  • test:jsdom - run all unit tests in the node.js environment with jsdom
  • lint - validates all source and test files
  • lint-src - validates all source files
  • lint-tests - validates all test files
  • release - build the library, push to NPM and Github
  • watch:tests - run all unit tests and watch files for changes
  • watch:build - watch your TypeScript files and trigger recompilation on changes
  • update:dependencies - update npm packages

Usage

You can simply use this project as a drop-in replacement for any TypeScript projects if you need something fast, and lightweight. Just replace the ./src and ./test folder and it should work right out of the box.

Both Travis CI and Circle CI are supported.

Coverage reports

The coverage reports are generated with Istanbul, and delivered to coveralls.io and codecov by Travis CI.

Istanbul generate a 100% correct coverage report. See the source and test files and do a comparison.

FAQ

How to use this boilerplate with Karma?

NPM install the Karma package and type karma init on the command line. The test files are pre-transpilled by TypeScript and located here build/test/specs/**/*.js. Install a Karma preprocessor, and the NPM packages you may need.

Is JSX supported?

Yes. Both TSX and JSX. By default Bublé are configured to be used with React. You may change this inside the rollup.config.js file.

Why is everything so strict?

What do you mean? The TypeScript compiler have it's rules to follow, as well as TSLint. Everytime you bundle, run a watch task or run the unit tests, things get validated. You can't compile the source code or run unit tests if there are errors in your code.

When should I consider using this boilerplate?

You may consider this is if you need a lightweight, fast boilerplate that export a single file.

What's the browser compatibility?

As a rule of thumb, TypeScript works best in IE9 and above.

Do I need to customize this boilerplate?

Nope. You only have to change the name on the boilerplate in the package.json.