Go to file
2018-05-03 18:05:37 +02:00
assets cli now sets environment variable 2017-04-17 23:23:48 +02:00
dist switch to seperate build/test commands to inrpove speed 2018-05-03 12:35:41 +02:00
docs change npmts package name to being @gitzone scoped 2018-04-09 01:03:39 +02:00
ts add codequality step 2018-05-03 18:05:37 +02:00
.gitignore update structure docs 2017-09-06 15:52:46 +02:00
.gitlab-ci.yml add codequality step 2018-05-03 18:05:37 +02:00
.npmignore add new npmpage 2016-12-18 21:35:23 +01:00
.snyk update snyk security policy 2018-05-03 12:45:22 +02:00
CONTRIBUTING.md Add contribution guide 2016-05-29 19:24:59 +00:00
LICENSE speed bump 2016-10-27 21:59:19 +02:00
npmextra.json fix npmextra.json 2018-04-09 01:26:14 +02:00
package.json 8.0.35 2018-05-03 13:30:05 +02:00
readme.md change npmts package name to being @gitzone scoped 2018-04-09 01:03:39 +02:00
tsconfig.json added --watch option 2016-09-22 23:23:16 +02:00
tslint.json now adhering to standard js code style 2016-09-06 17:21:25 +02:00
yarn.lock switch to seperate build/test commands to inrpove speed 2018-05-03 12:35:41 +02:00

npmts

best practice npm TypeScript modules

Availabililty

npm git git docs

Status for master

build status coverage report npm downloads per month bitHound Dependencies bitHound Code [Known Vulnerabilities] TypeScript node JavaScript Style Guide

Quick Demo

asciicast

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)
  2. transpile your code with tsc,
  3. test your code with tap (supports the fancy stuff like Promises, Generators, async/await, sourcemaps, parallel test execution in child processes)
  4. create coverage with istanbul (supports tracing of the originating TypeScript)

For more information on how tests are run check out the tapbuffer module.

For more information about how to best write tap tests check out the tapbundle module's linked docs.

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

Changelog

For breaking changes please see the changelog.

For further information read the linked docs at the top of this README.

MIT licensed | © Lossless GmbH | By using this npm module you agree to our privacy policy

repo-footer