tscoverage/readme.md

56 lines
3.1 KiB
Markdown
Raw Normal View History

2016-01-16 13:09:33 +00:00
# npmts
2017-07-31 12:36:33 +00:00
best practice npm TypeScript modules
2016-01-16 13:09:33 +00:00
2016-08-31 11:48:20 +00:00
## Availabililty
[![npm](https://gitzone.gitlab.io/assets/repo-button-npm.svg)](https://www.npmjs.com/package/@gitzone/npmts)
2017-03-04 22:44:16 +00:00
[![git](https://gitzone.gitlab.io/assets/repo-button-git.svg)](https://GitLab.com/gitzone/npmts)
[![git](https://gitzone.gitlab.io/assets/repo-button-mirror.svg)](https://github.com/gitzone/npmts)
2017-02-05 09:15:26 +00:00
[![docs](https://gitzone.gitlab.io/assets/repo-button-docs.svg)](https://gitzone.gitlab.io/npmts/)
2016-08-31 11:48:20 +00:00
## Status for master
2017-03-04 22:44:16 +00:00
[![build status](https://GitLab.com/gitzone/npmts/badges/master/build.svg)](https://GitLab.com/gitzone/npmts/commits/master)
[![coverage report](https://GitLab.com/gitzone/npmts/badges/master/coverage.svg)](https://GitLab.com/gitzone/npmts/commits/master)
[![npm downloads per month](https://img.shields.io/npm/dm/@gitzone/npmts.svg)](https://www.npmjs.com/package/npmts)
2017-05-04 21:28:28 +00:00
[![bitHound Dependencies](https://www.bithound.io/github/gitzonetools/npmts/badges/dependencies.svg)](https://www.bithound.io/github/gitzonetools/npmts/master/dependencies/npm)
[![bitHound Code](https://www.bithound.io/github/gitzonetools/npmts/badges/code.svg)](https://www.bithound.io/github/gitzonetools/npmts)
[![Known Vulnerabilities](https://snyk.io/test/npm/@gitzone/npmts/badge.svg)]
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
## Quick Demo
[![asciicast](https://asciinema.org/a/9c3assmh21i49qhe5lmi48sze.png)](https://asciinema.org/a/9c3assmh21i49qhe5lmi48sze?speed=2&t=0)
2017-03-04 22:44:16 +00:00
## Usage
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
2017-05-04 21:28:28 +00:00
1. check your dependencies and package.json (unused, missing, updates, security)
1. transpile your code with tsc,
1. test your code with tap (supports the fancy stuff like Promises, Generators, async/await, sourcemaps, parallel test execution in child processes)
1. create coverage with istanbul (supports tracing of the originating TypeScript)
2016-09-03 16:50:09 +00:00
2017-03-26 09:41:47 +00:00
For more information on how tests are run check out the [tapbuffer module](https://www.npmjs.com/package/tapbuffer).
2017-07-27 23:21:37 +00:00
For more information about how to best write tap tests check out the [tapbundle module's linked docs](https://www.npmjs.com/package/tapbundle).
2017-07-23 13:06:43 +00:00
2016-09-03 16:50:09 +00:00
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/)
2017-07-30 20:39:42 +00:00
## Changelog
2017-07-30 20:39:42 +00:00
For breaking changes please see the [changelog](https://gitzone.gitlab.io/npmts/changelog.html).
2017-05-04 21:28:28 +00:00
For further information read the linked docs at the top of this README.
2017-03-04 22:44:16 +00:00
> MIT licensed | **©** [Lossless GmbH](https://lossless.gmbh)
> | By using this npm module you agree to our [privacy policy](https://lossless.gmbH/privacy.html)
2017-02-02 19:57:13 +00:00
2017-05-04 21:28:28 +00:00
[![repo-footer](https://gitzone.gitlab.io/assets/repo-footer.svg)](https://push.rocks)