2016-01-16 13:09:33 +00:00
|
|
|
# npmts
|
2016-07-18 22:25:31 +00:00
|
|
|
Write npm modules with TypeScript without hassle. TypeScript ready. Fully ES6.
|
2016-01-16 13:09:33 +00:00
|
|
|
|
2016-08-31 11:48:20 +00:00
|
|
|
## Availabililty
|
2016-09-01 10:12:03 +00:00
|
|
|
[![npm](https://push.rocks/assets/repo-button-npm.svg)](https://www.npmjs.com/package/npmts)
|
|
|
|
[![git](https://push.rocks/assets/repo-button-git.svg)](https://gitlab.com/pushrocks/npmts)
|
|
|
|
[![git](https://push.rocks/assets/repo-button-mirror.svg)](https://github.com/pushrocks/npmts)
|
2016-09-25 18:28:42 +00:00
|
|
|
[![docs](https://push.rocks/assets/repo-button-docs.svg)](https://pushrocks.gitlab.io/npmts/)
|
2016-08-31 11:48:20 +00:00
|
|
|
|
|
|
|
## Status for master
|
2016-05-27 12:44:15 +00:00
|
|
|
[![build status](https://gitlab.com/pushrocks/npmts/badges/master/build.svg)](https://gitlab.com/pushrocks/npmts/commits/master)
|
2016-08-20 03:03:32 +00:00
|
|
|
[![coverage report](https://gitlab.com/pushrocks/npmts/badges/master/coverage.svg)](https://gitlab.com/pushrocks/npmts/commits/master)
|
2016-11-22 17:51:51 +00:00
|
|
|
[![npm downloads per month](https://img.shields.io/npm/dm/localeval.svg)](https://www.npmjs.com/package/npmts)
|
|
|
|
[![docker pulls](https://img.shields.io/docker/pulls/hosttoday/ht-docker-node.svg)](https://hub.docker.com/r/hosttoday/ht-docker-node/)
|
2016-02-14 02:19:54 +00:00
|
|
|
[![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-08-20 03:03:32 +00:00
|
|
|
[![TypeScript](https://img.shields.io/badge/TypeScript-2.x-blue.svg)](https://nodejs.org/dist/latest-v6.x/docs/api/)
|
2016-07-28 02:10:32 +00:00
|
|
|
[![node](https://img.shields.io/badge/node->=%206.x.x-blue.svg)](https://nodejs.org/dist/latest-v6.x/docs/api/)
|
2016-09-06 15:22:26 +00:00
|
|
|
[![JavaScript Style Guide](https://img.shields.io/badge/code%20style-standard-brightgreen.svg)](http://standardjs.com/)
|
2016-02-09 16:19:27 +00:00
|
|
|
|
2016-08-31 14:10:01 +00:00
|
|
|
## Introduction
|
2016-09-03 16:50:09 +00:00
|
|
|
NPMTS is your friend when writing, testing, publishing and documenting npm modules written in TypeScript.
|
2016-01-16 13:09:33 +00:00
|
|
|
|
2016-09-03 16:50:09 +00:00
|
|
|
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:
|
2016-07-11 12:46:31 +00:00
|
|
|
[hosttoday/ht-docker-node:npmts on Dockerhub](https://hub.docker.com/r/hosttoday/ht-docker-node/)
|
2016-04-30 09:55:42 +00:00
|
|
|
|
2016-09-25 18:22:10 +00:00
|
|
|
For further information read the docs:
|
2016-09-29 14:25:16 +00:00
|
|
|
1. [Intro](https://pushrocks.gitlab.io/npmts/index.html)
|
|
|
|
2. [Install](https://pushrocks.gitlab.io/npmts/install.html)
|
|
|
|
3. [Default Behaviour](https://pushrocks.gitlab.io/npmts/default.html)
|
|
|
|
4. [Configuration](https://pushrocks.gitlab.io/npmts/config.html)
|
|
|
|
5. [Examples](https://pushrocks.gitlab.io/npmts/examples.html)
|
|
|
|
6. [Info](https://pushrocks.gitlab.io/npmts/info.html)
|
2016-09-01 13:49:57 +00:00
|
|
|
|
|
|
|
[![npm](https://push.rocks/assets/repo-header.svg)](https://push.rocks)
|