This commit is contained in:
Philipp Kunz 2016-09-03 18:50:09 +02:00
parent aedf9f3115
commit 8372c1437c
7 changed files with 27 additions and 11 deletions

View File

@ -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/) [![node](https://img.shields.io/badge/node->=%206.x.x-blue.svg)](https://nodejs.org/dist/latest-v6.x/docs/api/)
## Introduction ## Introduction
NPMTS is your friend when it comes to write, test, publish and document NPM modules written in TypeScript. NPMTS is your friend when writing, testing, publishing and documenting 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.
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/) [hosttoday/ht-docker-node:npmts on Dockerhub](https://hub.docker.com/r/hosttoday/ht-docker-node/)
For further information read the docs. For further information read the docs.

View File

@ -20,7 +20,8 @@ var compileTs = function (tsFileArrayArg, tsOptionsArg) {
var compilerOptions = { var compilerOptions = {
declaration: tsOptionsCombined.declaration, declaration: tsOptionsCombined.declaration,
module: plugins.tsn.ModuleKind[tsOptionsCombined.module], module: plugins.tsn.ModuleKind[tsOptionsCombined.module],
target: plugins.tsn.ScriptTarget[tsOptionsCombined.target] target: plugins.tsn.ScriptTarget[tsOptionsCombined.target],
exclude: "node_modules/**/*"
}; };
return compilerOptions; return compilerOptions;
}; };

View File

@ -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. **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) 1. **Clean:** Clean up from any previous builds (old js files)

View File

@ -1,4 +1,4 @@
# Examples for NPMTS # Examples for npmts
## Example Usage in modules: ## Example Usage in modules:
* [gulp-browser](https://www.npmjs.com/package/gulp-browser) * [gulp-browser](https://www.npmjs.com/package/gulp-browser)

View File

@ -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/) [![node](https://img.shields.io/badge/node->=%206.x.x-blue.svg)](https://nodejs.org/dist/latest-v6.x/docs/api/)
## Introduction ## Introduction
NPMTS is your friend when it comes to write, test, publish and document NPM modules written in TypeScript. NPMTS is your friend when writing, testing, publishing and documenting 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.
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/) [hosttoday/ht-docker-node:npmts on Dockerhub](https://hub.docker.com/r/hosttoday/ht-docker-node/)
For further information read the docs. For further information read the docs.

View File

@ -1,4 +1,4 @@
# Install NPMTS # Install npmts
First install npmts globally, then install the npmts-g locally. First install npmts globally, then install the npmts-g locally.
> **npmts-g* checks if the global version of npmts suffices the modules requirements. > **npmts-g* checks if the global version of npmts suffices the modules requirements.

View File

@ -22,7 +22,8 @@ let compileTs = (tsFileArrayArg:string[],tsOptionsArg = {}) => {
let compilerOptions:plugins.tsn.CompilerOptions = { let compilerOptions:plugins.tsn.CompilerOptions = {
declaration: tsOptionsCombined.declaration, declaration: tsOptionsCombined.declaration,
module: plugins.tsn.ModuleKind[tsOptionsCombined.module], module: plugins.tsn.ModuleKind[tsOptionsCombined.module],
target: plugins.tsn.ScriptTarget[tsOptionsCombined.target] target: plugins.tsn.ScriptTarget[tsOptionsCombined.target],
exclude: "node_modules/**/*"
}; };
return compilerOptions; return compilerOptions;
}; };