From 8372c1437c6d06d33a3680e9e07e248ef1317a24 Mon Sep 17 00:00:00 2001 From: PhilKunz Date: Sat, 3 Sep 2016 18:50:09 +0200 Subject: [PATCH] fixes #8 --- README.md | 13 ++++++++++--- dist/npmts.compile.js | 3 ++- docs/default.md | 2 +- docs/examples.md | 2 +- docs/index.md | 13 ++++++++++--- docs/install.md | 2 +- ts/npmts.compile.ts | 3 ++- 7 files changed, 27 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index 4f68565..219c1e2 100644 --- a/README.md +++ b/README.md @@ -17,10 +17,17 @@ Write npm modules with TypeScript without hassle. TypeScript ready. Fully ES6. [![node](https://img.shields.io/badge/node->=%206.x.x-blue.svg)](https://nodejs.org/dist/latest-v6.x/docs/api/) ## Introduction -NPMTS is your friend when it comes to write, test, publish and document NPM modules written in TypeScript. -By default NPMTS will **bundle declaration files**. As a result npm module **code completion in editors like Visual Studio Code** works. +NPMTS is your friend when writing, testing, publishing and documenting npm modules written in TypeScript. -There is a docker image available that includes npmts to make CI a breeze: +npmts will + +1. check your dependencies and package.json +1. transpile your code with tsc, +1. document your code with typedoc, +1. test your code with mocha +1. create coverage with istanbul + +This works on your machine and in CI. There is a prebuild docker image available that includes npmts to make CI a breeze: [hosttoday/ht-docker-node:npmts on Dockerhub](https://hub.docker.com/r/hosttoday/ht-docker-node/) For further information read the docs. diff --git a/dist/npmts.compile.js b/dist/npmts.compile.js index 8ea4e7c..91e3f19 100644 --- a/dist/npmts.compile.js +++ b/dist/npmts.compile.js @@ -20,7 +20,8 @@ var compileTs = function (tsFileArrayArg, tsOptionsArg) { var compilerOptions = { declaration: tsOptionsCombined.declaration, module: plugins.tsn.ModuleKind[tsOptionsCombined.module], - target: plugins.tsn.ScriptTarget[tsOptionsCombined.target] + target: plugins.tsn.ScriptTarget[tsOptionsCombined.target], + exclude: "node_modules/**/*" }; return compilerOptions; }; diff --git a/docs/default.md b/docs/default.md index 5d5aa76..f1a47d7 100644 --- a/docs/default.md +++ b/docs/default.md @@ -1,4 +1,4 @@ -# Default task execution order +# Default task execution of npmts 1. **Config:** Check config in ./npmextra.json (Check out [npmextra](https://www.npmjs.com/package/npmextra)) 1. **Clean:** Clean up from any previous builds (old js files) diff --git a/docs/examples.md b/docs/examples.md index d5a1e12..d9766de 100644 --- a/docs/examples.md +++ b/docs/examples.md @@ -1,4 +1,4 @@ -# Examples for NPMTS +# Examples for npmts ## Example Usage in modules: * [gulp-browser](https://www.npmjs.com/package/gulp-browser) diff --git a/docs/index.md b/docs/index.md index 4f68565..219c1e2 100644 --- a/docs/index.md +++ b/docs/index.md @@ -17,10 +17,17 @@ Write npm modules with TypeScript without hassle. TypeScript ready. Fully ES6. [![node](https://img.shields.io/badge/node->=%206.x.x-blue.svg)](https://nodejs.org/dist/latest-v6.x/docs/api/) ## Introduction -NPMTS is your friend when it comes to write, test, publish and document NPM modules written in TypeScript. -By default NPMTS will **bundle declaration files**. As a result npm module **code completion in editors like Visual Studio Code** works. +NPMTS is your friend when writing, testing, publishing and documenting npm modules written in TypeScript. -There is a docker image available that includes npmts to make CI a breeze: +npmts will + +1. check your dependencies and package.json +1. transpile your code with tsc, +1. document your code with typedoc, +1. test your code with mocha +1. create coverage with istanbul + +This works on your machine and in CI. There is a prebuild docker image available that includes npmts to make CI a breeze: [hosttoday/ht-docker-node:npmts on Dockerhub](https://hub.docker.com/r/hosttoday/ht-docker-node/) For further information read the docs. diff --git a/docs/install.md b/docs/install.md index 5d16a16..50c68eb 100644 --- a/docs/install.md +++ b/docs/install.md @@ -1,4 +1,4 @@ -# Install NPMTS +# Install npmts First install npmts globally, then install the npmts-g locally. > **npmts-g* checks if the global version of npmts suffices the modules requirements. diff --git a/ts/npmts.compile.ts b/ts/npmts.compile.ts index 0fa7337..ce221f0 100644 --- a/ts/npmts.compile.ts +++ b/ts/npmts.compile.ts @@ -22,7 +22,8 @@ let compileTs = (tsFileArrayArg:string[],tsOptionsArg = {}) => { let compilerOptions:plugins.tsn.CompilerOptions = { declaration: tsOptionsCombined.declaration, module: plugins.tsn.ModuleKind[tsOptionsCombined.module], - target: plugins.tsn.ScriptTarget[tsOptionsCombined.target] + target: plugins.tsn.ScriptTarget[tsOptionsCombined.target], + exclude: "node_modules/**/*" }; return compilerOptions; };