tscoverage/README.md
2016-02-09 17:19:27 +01:00

1.6 KiB

npmts

Write npm modules with TypeScript without hassle.

Status

Coverage Status

How to use npmts

Install

First install npmts as dev dependency:

npm install npmts --save-dev

Then use it in package.json's script section to trigger a build:

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

Default behaviour

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

Declaration files

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

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

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.

{
  "mode":"custom",
  "ts":{
    "./customdir/custom.ts":"./customcompiled.js"
  },
  "typings":[
    "./customdir"
  ]
}
  • mode can be "default" or "custom"
  • 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 in the repo. This is only of interest for you when looking to contribute to, improve or build upon this package.