43 lines
2.6 KiB
Markdown
43 lines
2.6 KiB
Markdown
|
# npmts
|
||
|
|
Write npm modules with TypeScript without hassle. TypeScript ready. Fully ES6.
|
||
|
|
|
||
|
|
## Availabililty
|
||
|
|
[](https://www.npmjs.com/package/npmts)
|
||
|
|
[](https://gitlab.com/pushrocks/npmts)
|
||
|
|
[](https://github.com/pushrocks/npmts)
|
||
|
|
[](https://pushrocks.gitlab.io/npmts/gitbook)
|
||
|
|
|
||
|
|
## Status for master
|
||
|
|
[](https://gitlab.com/pushrocks/npmts/commits/master)
|
||
|
|
[](https://gitlab.com/pushrocks/npmts/commits/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://nodejs.org/dist/latest-v6.x/docs/api/)
|
||
|
|
[](https://nodejs.org/dist/latest-v6.x/docs/api/)
|
||
|
|
[](http://standardjs.com/)
|
||
|
|
|
||
|
|
## Introduction
|
||
|
|
NPMTS is your friend when writing, testing, publishing and documenting npm modules written in TypeScript.
|
||
|
|
|
||
|
|
npmts will
|
||
|
|
|
||
|
|
1. check your dependencies and package.json
|
||
|
|
1. transpile your code with tsc,
|
||
|
|
1. document your code with typedoc,
|
||
|
|
1. test your code with mocha
|
||
|
|
1. create coverage with istanbul
|
||
|
|
|
||
|
|
This works on your machine and in CI. There is a prebuild docker image available that includes npmts to make CI a breeze:
|
||
|
|
[hosttoday/ht-docker-node:npmts on Dockerhub](https://hub.docker.com/r/hosttoday/ht-docker-node/)
|
||
|
|
|
||
|
|
For further information read the docs:
|
||
|
|
* [1. Intro](https://pushrocks.gitlab.io/npmts/gitbook/index.md)
|
||
|
|
* [2. Install](https://pushrocks.gitlab.io/npmts/gitbook/install.md)
|
||
|
|
* [3. Default Behaviour](https://pushrocks.gitlab.io/npmts/gitbook/default.md)
|
||
|
|
* [4. Configuration](https://pushrocks.gitlab.io/npmts/gitbook/config.md)
|
||
|
|
* [5. Examples](https://pushrocks.gitlab.io/npmts/gitbook/examples.md)
|
||
|
|
* [6. Info](https://pushrocks.gitlab.io/npmts/gitbook/info.md)
|
||
|
|
|
||
|
|
[](https://push.rocks)
|