git.zone/tscoverage
2
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

improve Readme

Browse Source
This commit is contained in:
LosslessBot 2016-04-30 12:34:32 +02:00
parent 6dad1c3d85
commit 88b39213a6
1 changed files with 12 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
README.md
View File

@ -54,13 +54,17 @@ the npmts.json is the main config file. You can use it to customize the behaviou
"ts":{ "ts":{
"./customdir/*.ts":"./" "./customdir/*.ts":"./"
}, },
"tsconfig":true, "tsOptions":{
"declaration":false,
"target":"ES6"
},
"typings":[ "typings":[
"./ts/typings.json", "./ts/typings.json",
"./subts1/typings.json", "./subts1/typings.json",
"./subts2/typings.json", "./subts2/typings.json",
"./customdir/typings.json" "./customdir/typings.json"
], ],
"typingsInclude":"auto",
"codecov":true, "codecov":true,
"docs": { "docs": {
"publish":true "publish":true
@ -71,10 +75,10 @@ the npmts.json is the main config file. You can use it to customize the behaviou
| key | description | | key | description |
| --- | --- | | --- | --- |
| mode | "default" will do some defualt stuff, "custom" only does what you specify |
| codecov | if true, coverage data will be uploaded to codecov when running on travis | | codecov | if true, coverage data will be uploaded to codecov when running on travis |
| docs | `{"publish":true}` lets you control what happens with your module documentation | | docs | `{"publish":true, destination:"github"}` lets you control what happens with your module documentation |
| | | | mode | "default" will do some defualt stuff, "custom" only does what you specify |
| tsOptions | specify options for tsc |
| | | | | |
#### Typings #### Typings
@ -82,7 +86,8 @@ the npmts.json is the main config file. You can use it to customize the behaviou
> Note: You can reference the typings files in any of your TypeScript code with a > Note: You can reference the typings files in any of your TypeScript code with a
`/// <reference path="/some/path/main.d.ts">` `/// <reference path="/some/path/main.d.ts">`
or use a tsconfig.json file. We are currently working on a "typingsInclude" option, that will autoload any typings during compilation.
tsconfig is NOT supported, since it would render this module useless
#### TypeScript #### TypeScript
by default npmts looks for `./ts/*.ts` and `./test/test.ts` that will compile to by default npmts looks for `./ts/*.ts` and `./test/test.ts` that will compile to
@ -103,6 +108,8 @@ This is in line with the latest TypeScript best practices.
You can then import plugins via the TypeScript `import` Syntax You can then import plugins via the TypeScript `import` Syntax
and tsc will pick up the declaration file automatically. and tsc will pick up the declaration file automatically.
> Note: If you don't want declaration files, set tsOptions.declaration to false in npmts.json
#### Instrumentalize Code #### Instrumentalize Code
npmts instrumentalizes (using istanbul) the created JavaScript code to create a coverage report. npmts instrumentalizes (using istanbul) the created JavaScript code to create a coverage report.