2.3.0

README.md

@@ -2,6 +2,10 @@
 Write npm modules with TypeScript without hassle.
 
 ## Status
+[![Build Status](https://travis-ci.org/pushrocks/npmts.svg?branch=master)](https://travis-ci.org/pushrocks/npmts)
+[![Dependency Status](https://david-dm.org/pushrocks/npmts.svg)](https://david-dm.org/pushrocks/npmts)
+[![bitHound Dependencies](https://www.bithound.io/github/pushrocks/npmts/badges/dependencies.svg)](https://www.bithound.io/github/pushrocks/npmts/master/dependencies/npm)
+[![bitHound Code](https://www.bithound.io/github/pushrocks/npmts/badges/code.svg)](https://www.bithound.io/github/pushrocks/npmts)
 [![Coverage Status](https://coveralls.io/repos/github/pushrocks/npmts/badge.svg?branch=master)](https://coveralls.io/github/pushrocks/npmts?branch=master)
 
 ## How to use npmts
@@ -22,6 +26,23 @@ Then use it in package.json's script section to trigger a build:
 ```
 
 ### Default behaviour
+
+**Execution order of tasks**
+
+1. Install typings
+2. Compile TypeScript
+3. Create Declaration Files
+4. Instrumentalize created JavaScript files with istanbul
+5. Run Tests
+6. Create Coverage report
+7. Upload Coverage reports to travis (must be activated, only triggers on travis)
+
+
+#### Typings
+**npmts** looks for `./ts/typings.json` by default and installs any defined typings to `.ts/typings/`.
+You can then reference the ./ts/typings/main.d.ts file in your TypeScript code.
+
+#### TypeScript
 by default npmts looks for `./ts/index.ts` and `./ts/test.ts` that will compile to
 `./index.js` and `./test.js`
 
@@ -34,13 +55,21 @@ You can reference it in your package.json like this:
 "typings": "./index.d.ts",
 ```
 
+#### Instrumentalize Code
+npmts instrumentalizes the created JavaScript code to create a coverage report.
+
+#### Tests
+When Typings have been installed, TypeScript + Declaration files have been transpiled and the resulting JS has been instrumentalized,
+npmts runs `.test/test.js` with mocha. 
+
 When requiring the module from other TypeScript files,
 the TypeScript Compiler will use the declaration file to resolve typings.
 
 
 
 ### Custom behaviour
-NPMTS looks for an npmts.json at the root of your package.
+Custom behaviour can be achieved through a config file at the root of your package.
+The file must be named **npmts.json**
 
 ```json
 {
@@ -58,6 +87,7 @@ NPMTS looks for an npmts.json at the root of your package.
 * **ts** You can list as many TypeScript files as you like. The key represents the source TypeScript file, the value the output file.
 * **typings** is an array of all direcories that have a typings.json present. Uses the new typings tool from npm.
 
+
 ## Readme for Devs
 There is a [README-dev.md](README-dev.md) in the repo.
 This is only of interest for you when looking to contribute to, improve or build upon this package.

index.js

@@ -168,7 +168,8 @@ var NpmtsCompile;
                 var tsStream = plugins.gulp.src(plugins.path.join(paths.cwd, key))
                     .pipe(plugins.g.typescript({
                     out: outputName,
-                    declaration: true
+                    declaration: true,
+                    target: "ES5"
                 }));
                 var stream = plugins.mergeStream([
                     tsStream.dts.pipe(plugins.gulp.dest(outputDir)),

package.json

@@ -1,6 +1,6 @@
 {
   "name": "npmts",
-  "version": "2.2.3",
+  "version": "2.3.0",
   "description": "write npm modules with TypeScript",
   "main": "index.js",
   "typings": "./index.d.ts",

test/assets/coverage/lcov-report/assets/index.html

@@ -77,7 +77,7 @@
 </div><!-- /wrapper -->
 <div class='footer quiet pad2 space-top1 center small'>
   Code coverage
-  generated by <a href="http://istanbul-js.org/" target="_blank">istanbul</a> at Thu Feb 11 2016 19:08:46 GMT+0100 (CET)
+  generated by <a href="http://istanbul-js.org/" target="_blank">istanbul</a> at Tue Feb 16 2016 10:28:50 GMT+0100 (CET)
 </div>
 </div>
 <script src="../prettify.js"></script>

test/assets/coverage/lcov-report/assets/index.js.html

@@ -76,7 +76,7 @@ module.exports = testplugin;
 </div><!-- /wrapper -->
 <div class='footer quiet pad2 space-top1 center small'>
   Code coverage
-  generated by <a href="http://istanbul-js.org/" target="_blank">istanbul</a> at Thu Feb 11 2016 19:08:46 GMT+0100 (CET)
+  generated by <a href="http://istanbul-js.org/" target="_blank">istanbul</a> at Tue Feb 16 2016 10:28:50 GMT+0100 (CET)
 </div>
 </div>
 <script src="../prettify.js"></script>

test/assets/coverage/lcov-report/index.html

@@ -77,7 +77,7 @@
 </div><!-- /wrapper -->
 <div class='footer quiet pad2 space-top1 center small'>
   Code coverage
-  generated by <a href="http://istanbul-js.org/" target="_blank">istanbul</a> at Thu Feb 11 2016 19:08:46 GMT+0100 (CET)
+  generated by <a href="http://istanbul-js.org/" target="_blank">istanbul</a> at Tue Feb 16 2016 10:28:50 GMT+0100 (CET)
 </div>
 </div>
 <script src="prettify.js"></script>

ts/npmts.compile.ts

@@ -70,7 +70,8 @@ module NpmtsCompile {
                 var tsStream = plugins.gulp.src(plugins.path.join(paths.cwd,key))
                     .pipe(plugins.g.typescript({
                         out: outputName,
-                        declaration: true
+                        declaration: true,
+                        target: "ES5"
                     }));
                 var stream = plugins.mergeStream([
                     tsStream.dts.pipe(plugins.gulp.dest(outputDir)),