138 lines
5.4 KiB
Markdown
138 lines
5.4 KiB
Markdown
# npmts
|
|
Write npm modules with TypeScript without hassle.
|
|
|
|
## Status
|
|
[](https://gitlab.com/pushrocks/npmts/commits/master)
|
|
[](https://ci.appveyor.com/project/philkunz/npmts/branch/master)
|
|
[](https://david-dm.org/pushrocks/npmts)
|
|
[](https://www.bithound.io/github/pushrocks/npmts/master/dependencies/npm)
|
|
[](https://www.bithound.io/github/pushrocks/npmts)
|
|
[](https://codecov.io/github/pushrocks/npmts?branch=master)
|
|
|
|
## 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](https://hub.docker.com/r/hosttoday/ht-docker-npmg/)
|
|
|
|
### 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 task execution order
|
|
|
|
1. Check config in ./npmts.json
|
|
1. Clean up from any previous builds (old js files)
|
|
1. Install typings
|
|
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
|
|
1. Upload Coverage reports to codecov.io (Tests must pass, codecov.io must be activated, by default only triggers on travis)
|
|
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.
|
|
|
|
```json
|
|
{
|
|
"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.
|
|
|
|
```json
|
|
"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](https://www.npmjs.com/package/gulp-typings)
|
|
* [gulp-browser](https://www.npmjs.com/package/gulp-typings)
|
|
|
|
> We will add more options over time.
|
|
|
|
## About the authors:
|
|
[](https://lossless.com/)
|
|
|
|
[](https://paypal.me/lossless)
|