56 lines
3.1 KiB
Markdown
56 lines
3.1 KiB
Markdown
# npmts
|
|
|
|
best practice npm TypeScript modules
|
|
|
|
## Availabililty
|
|
|
|
[](https://www.npmjs.com/package/@gitzone/npmts)
|
|
[](https://GitLab.com/gitzone/npmts)
|
|
[](https://github.com/gitzone/npmts)
|
|
[](https://gitzone.gitlab.io/npmts/)
|
|
|
|
## Status for master
|
|
|
|
[](https://GitLab.com/gitzone/npmts/commits/master)
|
|
[](https://GitLab.com/gitzone/npmts/commits/master)
|
|
[](https://www.npmjs.com/package/npmts)
|
|
[](https://www.bithound.io/github/gitzonetools/npmts/master/dependencies/npm)
|
|
[](https://www.bithound.io/github/gitzonetools/npmts)
|
|
[]
|
|
[](https://nodejs.org/dist/latest-v6.x/docs/api/)
|
|
[](https://nodejs.org/dist/latest-v6.x/docs/api/)
|
|
[](http://standardjs.com/)
|
|
|
|
## Quick Demo
|
|
|
|
[](https://asciinema.org/a/9c3assmh21i49qhe5lmi48sze?speed=2&t=0)
|
|
|
|
## Usage
|
|
|
|
NPMTS is your friend when writing, testing, publishing and documenting npm modules written in TypeScript.
|
|
|
|
npmts will
|
|
|
|
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)
|
|
|
|
For more information on how tests are run check out the [tapbuffer module](https://www.npmjs.com/package/tapbuffer).
|
|
|
|
For more information about how to best write tap tests check out the [tapbundle module's linked docs](https://www.npmjs.com/package/tapbundle).
|
|
|
|
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/)
|
|
|
|
## Changelog
|
|
|
|
For breaking changes please see the [changelog](https://gitzone.gitlab.io/npmts/changelog.html).
|
|
|
|
For further information read the linked docs at the top of this README.
|
|
|
|
> MIT licensed | **©** [Lossless GmbH](https://lossless.gmbh)
|
|
> | By using this npm module you agree to our [privacy policy](https://lossless.gmbH/privacy.html)
|
|
|
|
[](https://push.rocks)
|