tscoverage/README.md

npmts

Write npm modules with TypeScript without hassle.

Status

What is NPMTS?

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.

There is a docker image available that includes npmts to make CI a breeze:
hosttoday/ht-docker-npmg on Dockerhub

Install

First install npmts globally, then install the npmts checker:

npm install npmts -g # installs npmts globally
npm install npmts-g --save-dev # installs npmts-g checking tool as devDependency

Then add it to your package.json's script section to trigger a build:

"scripts": {
    "test": "npmts"
}

Default task execution order

1. Check config in ./npmts.json
2. Clean up from any previous builds (old js files)
3. Install typings
4. Transpile TypeScript with inline sourcemaps
5. Create Declaration Files
6. Create JsDoc Documentation
7. Instrumentalize created JavaScript files with istanbul
8. Run Tests
9. Create Coverage report

npmts.json

the npmts.json is the main config file. You can use it to customize the behaviour of NPMTS.

{
  "mode":"default",
  "codecov":{
    "publish":true,
    "token":"sometoken"
  },
  "ts":{
    "./customdir/*.ts":"./"
  },
  "docs": {
    "publish":true,
    "destination":"github"
  },
  "tsOptions":{
    "declaration":false,
    "target":"ES6"
  },
  "typings":[
    "./ts/typings.json",
    "./subts1/typings.json",
    "./subts2/typings.json",
    "./customdir/typings.json"
  ],
  "typingsInclude":"auto",
  "cli":true
}

key	default value	description
"codecov"	true	if true, coverage data will be uploaded to codecov when running on travis
"docs"	{"publish":"false"}	{"publish":true, destination:"github"} lets you control what happens with your module documentation
"mode"	"default"	"default" will do some defualt stuff, "custom" only does what you specify
"tsOptions"	{"target":"ES5", "declaration":"true"}	specify options for tsc
"typings"	["./ts/typings.json"]	allows you to specify multiple locations for typings.json to install. This is needed for modules that do not yet bundle typings
"cli"	"false"	some modules are designed to be used from cli. If set to true NPMTS will create a cli.js that wires you dist files up for cli use.

Typings

npmts looks for ./ts/typings.json by default and installs any defined typings to .ts/typings/.

Note: You can reference the typings files in any of your TypeScript code with a
/// <reference path="/some/path/main.d.ts">
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

by default npmts looks for ./ts/*.ts and ./test/test.ts that will compile to ./dist/*.js and ./test/test.js

Use commonjs module system for wiring up files.

Declaration files

npmts also creates an ./dist/index.d.ts declaration file by default. You can reference it in your package.json like this.

"main": "dist/index.js",
"typings": ".dist/index.d.ts",

This is in line with the latest TypeScript best practices. You can then import plugins via the TypeScript import Syntax 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

npmts instrumentalizes (using istanbul) 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 looks for .test/test.ts which will be transpiled to test.js and run with mocha.

Any errors will be shown with reference to their originating source in TypeScript thanks to autogenerated source maps.

Example Usage in modules:

• gulp-typings
• gulp-browser

We will add more options over time.

Tips and tricks:

• Use npmts-g to use globally installed npmts and install npmts locally if no global npmts is available.
• Use npmpage to create a webpage from coverage reports and JsDocs for the module
• Use hosttoday/ht-docker-node:npmts for speedy CI builds

About the authors: