tscoverage/gitbook/index.md

37 lines
2.1 KiB
Markdown
Raw Normal View History

2016-08-31 10:04:14 +00:00
# npmts
Write npm modules with TypeScript without hassle. TypeScript ready. Fully ES6.
2016-08-31 11:55:42 +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)
[![docs](https://push.rocks/assets/repo-button-docs.svg)](https://pushrocks.gitlab.io/npmts/docs)
2016-08-31 11:55:42 +00:00
## Status for master
2016-08-31 10:04:14 +00:00
[![build status](https://gitlab.com/pushrocks/npmts/badges/master/build.svg)](https://gitlab.com/pushrocks/npmts/commits/master)
[![coverage report](https://gitlab.com/pushrocks/npmts/badges/master/coverage.svg)](https://gitlab.com/pushrocks/npmts/commits/master)
[![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)
[![TypeScript](https://img.shields.io/badge/TypeScript-2.x-blue.svg)](https://nodejs.org/dist/latest-v6.x/docs/api/)
[![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:21:25 +00:00
[![JavaScript Style Guide](https://img.shields.io/badge/code%20style-standard-brightgreen.svg)](http://standardjs.com/)
2016-08-31 10:04:14 +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-08-31 10:04:14 +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-08-31 10:04:14 +00:00
[hosttoday/ht-docker-node:npmts on Dockerhub](https://hub.docker.com/r/hosttoday/ht-docker-node/)
2016-08-31 14:10:01 +00:00
For further information read the docs.
2016-09-01 13:46:31 +00:00
[![npm](https://push.rocks/assets/repo-header.svg)](https://push.rocks)