2016-01-16 13:09:33 +00:00
|
|
|
# npmts
|
2016-01-16 13:20:14 +00:00
|
|
|
Write npm modules with TypeScript without hassle.
|
2016-01-16 13:09:33 +00:00
|
|
|
|
2016-02-09 16:19:27 +00:00
|
|
|
## Status
|
2016-02-14 02:19:54 +00:00
|
|
|
[![Build Status](https://travis-ci.org/pushrocks/npmts.svg?branch=master)](https://travis-ci.org/pushrocks/npmts)
|
|
|
|
[![Dependency Status](https://david-dm.org/pushrocks/npmts.svg)](https://david-dm.org/pushrocks/npmts)
|
|
|
|
[![bitHound Dependencies](https://www.bithound.io/github/pushrocks/npmts/badges/dependencies.svg)](https://www.bithound.io/github/pushrocks/npmts/master/dependencies/npm)
|
|
|
|
[![bitHound Code](https://www.bithound.io/github/pushrocks/npmts/badges/code.svg)](https://www.bithound.io/github/pushrocks/npmts)
|
2016-04-02 17:36:46 +00:00
|
|
|
[![codecov.io](https://codecov.io/github/pushrocks/npmts/coverage.svg?branch=master)](https://codecov.io/github/pushrocks/npmts?branch=master)
|
2016-02-09 16:19:27 +00:00
|
|
|
|
2016-03-27 10:32:55 +00:00
|
|
|
## What is NPMTS?
|
|
|
|
NPMTS is your friend when it comes to write, test, publish and document NPM modules written in TypeScript.
|
2016-01-16 13:09:33 +00:00
|
|
|
|
2016-04-30 09:55:42 +00:00
|
|
|
There is a docker image available that includes npmts to make CI a breeze:
|
|
|
|
[hosttoday/ht-docker-npmg on Dockerhub](https://hub.docker.com/r/hosttoday/ht-docker-npmg/)
|
|
|
|
|
2016-01-16 13:09:33 +00:00
|
|
|
### Install
|
|
|
|
First install npmts as dev dependency:
|
|
|
|
|
|
|
|
```sh
|
|
|
|
npm install npmts --save-dev
|
|
|
|
```
|
|
|
|
|
|
|
|
Then use it in package.json's script section to trigger a build:
|
|
|
|
|
|
|
|
```json
|
|
|
|
"scripts": {
|
|
|
|
"test": "npmts"
|
|
|
|
}
|
|
|
|
```
|
|
|
|
|
|
|
|
### Default behaviour
|
2016-02-14 02:12:02 +00:00
|
|
|
|
|
|
|
**Execution order of tasks**
|
|
|
|
|
2016-03-27 10:32:55 +00:00
|
|
|
1. Check config in ./npmts.json
|
|
|
|
1. Clean up from any previous builds (old js files)
|
2016-02-14 02:12:02 +00:00
|
|
|
1. Install typings
|
2016-03-27 10:32:55 +00:00
|
|
|
1. Transpile TypeScript with inline sourcemaps
|
|
|
|
1. Create Declaration Files
|
|
|
|
1. Create JsDoc Documentation
|
|
|
|
1. Instrumentalize created JavaScript files with istanbul
|
|
|
|
1. Run Tests
|
|
|
|
1. Create Coverage report
|
2016-04-02 17:09:11 +00:00
|
|
|
1. Upload Coverage reports to codecov.io (Tests must pass, codecov.io must be activated, by default only triggers on travis)
|
2016-03-27 10:32:55 +00:00
|
|
|
1. Upload JsDoc Documentation to gh-pages branch on GitHub. (Tests must pass, requires GitHub Token)
|
|
|
|
|
|
|
|
#### npmts.json
|
|
|
|
the npmts.json is the main config file. You can use it to customize the behaviour of NPMTS.
|
2016-02-14 02:12:02 +00:00
|
|
|
|
2016-04-30 03:49:53 +00:00
|
|
|
```json
|
|
|
|
{
|
|
|
|
"mode":"default",
|
|
|
|
"ts":{
|
|
|
|
"./customdir/*.ts":"./"
|
|
|
|
},
|
2016-04-30 10:34:32 +00:00
|
|
|
"tsOptions":{
|
|
|
|
"declaration":false,
|
|
|
|
"target":"ES6"
|
|
|
|
},
|
2016-04-30 03:49:53 +00:00
|
|
|
"typings":[
|
|
|
|
"./ts/typings.json",
|
|
|
|
"./subts1/typings.json",
|
|
|
|
"./subts2/typings.json",
|
|
|
|
"./customdir/typings.json"
|
|
|
|
],
|
2016-04-30 10:34:32 +00:00
|
|
|
"typingsInclude":"auto",
|
2016-04-30 03:49:53 +00:00
|
|
|
"codecov":true,
|
|
|
|
"docs": {
|
|
|
|
"publish":true
|
|
|
|
},
|
|
|
|
"cli":true
|
|
|
|
}
|
|
|
|
```
|
|
|
|
|
|
|
|
| key | description |
|
|
|
|
| --- | --- |
|
|
|
|
| codecov | if true, coverage data will be uploaded to codecov when running on travis |
|
2016-04-30 10:34:32 +00:00
|
|
|
| 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 |
|
2016-04-30 03:49:53 +00:00
|
|
|
| | |
|
|
|
|
|
2016-02-14 02:13:03 +00:00
|
|
|
#### Typings
|
2016-02-14 02:12:02 +00:00
|
|
|
**npmts** looks for `./ts/typings.json` by default and installs any defined typings to `.ts/typings/`.
|
2016-04-30 03:49:53 +00:00
|
|
|
|
|
|
|
> Note: You can reference the typings files in any of your TypeScript code with a
|
|
|
|
`/// <reference path="/some/path/main.d.ts">`
|
2016-04-30 10:34:32 +00:00
|
|
|
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
|
2016-02-14 02:12:02 +00:00
|
|
|
|
|
|
|
#### TypeScript
|
2016-02-17 04:45:42 +00:00
|
|
|
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.
|
2016-01-16 13:20:14 +00:00
|
|
|
|
2016-02-14 02:13:03 +00:00
|
|
|
#### Declaration files
|
2016-04-30 09:55:42 +00:00
|
|
|
**npmts** also creates an `./dist/index.d.ts` declaration file by default.
|
|
|
|
You can reference it in your package.json like this.
|
2016-01-18 14:20:23 +00:00
|
|
|
|
|
|
|
```json
|
2016-04-30 09:55:42 +00:00
|
|
|
"main": "dist/index.js",
|
|
|
|
"typings": ".dist/index.d.ts",
|
2016-01-18 14:20:23 +00:00
|
|
|
```
|
|
|
|
|
2016-04-30 09:55:42 +00:00
|
|
|
This is in line with the latest TypeScript best practices.
|
2016-03-27 10:32:55 +00:00
|
|
|
You can then import plugins via the TypeScript `import` Syntax
|
|
|
|
and tsc will pick up the declaration file automatically.
|
|
|
|
|
2016-04-30 10:34:32 +00:00
|
|
|
> Note: If you don't want declaration files, set tsOptions.declaration to false in npmts.json
|
|
|
|
|
2016-02-14 02:13:03 +00:00
|
|
|
#### Instrumentalize Code
|
2016-03-27 10:32:55 +00:00
|
|
|
npmts instrumentalizes (using istanbul) the created JavaScript code to create a coverage report.
|
2016-02-14 02:12:02 +00:00
|
|
|
|
2016-02-14 02:13:03 +00:00
|
|
|
#### Tests
|
2016-02-14 02:12:02 +00:00
|
|
|
When Typings have been installed, TypeScript + Declaration files have been transpiled and the resulting JS has been instrumentalized,
|
2016-03-27 10:32:55 +00:00
|
|
|
npmts looks for `.test/test.ts` which will be transpiled to test.js and run with mocha.
|
2016-01-18 14:20:23 +00:00
|
|
|
|
2016-03-27 10:32:55 +00:00
|
|
|
Any errors will be shown with reference to their originating source in TypeScript
|
|
|
|
thanks to autogenerated source maps.
|
2016-01-18 14:35:44 +00:00
|
|
|
|
2016-04-30 10:38:16 +00:00
|
|
|
## Example Usage in modules:
|
|
|
|
[gulp-typings](https://www.npmjs.com/package/gulp-typings)
|
|
|
|
[gulp-browser](https://www.npmjs.com/package/gulp-typings)
|
2016-01-16 13:42:30 +00:00
|
|
|
|
2016-04-01 23:25:01 +00:00
|
|
|
> We will add more options over time.
|
|
|
|
|
2016-04-30 10:38:16 +00:00
|
|
|
## About the authors:
|
2016-04-01 23:25:01 +00:00
|
|
|
[![Project Phase](https://mediaserve.lossless.digital/lossless.com/img/createdby_github.svg)](https://lossless.com/)
|
|
|
|
|
|
|
|
[![PayPal](https://img.shields.io/badge/Support%20us-PayPal-blue.svg)](https://paypal.me/lossless)
|