diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml index 1f48088..e49ab58 100644 --- a/.gitlab-ci.yml +++ b/.gitlab-ci.yml @@ -48,10 +48,11 @@ trigger: - docker pages: - image: hosttoday/ht-docker-node:npmpage + image: hosttoday/ht-docker-node:npmci stage: pages script: - - npmci command npmpage --publish gitlab + - npmci command yarn add npmpage + - npmci command npmpage only: - tags tags: diff --git a/docs/00footer.md b/docs/00footer.md new file mode 100644 index 0000000..bb6f384 --- /dev/null +++ b/docs/00footer.md @@ -0,0 +1,9 @@ +[Legal Info](https://lossless.gmbh) +[Privacy Policy](https://lossless.gmbh/privacy.html) +/// +[Git.Zone](https://git.zone) +tools for a seamless dev workflow + +[Lossless GmbH](https://push.rocks) +the company behind git.zone and npmts +/// diff --git a/docs/config.md b/docs/config.md index 4c66c59..0e8166c 100644 --- a/docs/config.md +++ b/docs/config.md @@ -1,4 +1,9 @@ -# Configuration of NPMTS +--- +name: config +--- +# Configuration +## of npmts + npmts can be configured to your needs: ### npmextra.json diff --git a/docs/default.md b/docs/default.md index f4e1efe..994e69e 100644 --- a/docs/default.md +++ b/docs/default.md @@ -1,7 +1,11 @@ -# Default task execution of npmts +--- +name: Default Behaviour +--- +# Default Behaviour +## of npmts 1. **Config:** Check config in ./npmextra.json (Check out [npmextra](https://www.npmjs.com/package/npmextra)) 1. **Clean:** Clean up from any previous builds (old js files) 1. **Check:** Check project for typings declaration in package.json, unused dependencies and missing dependencies 1. **Transpile:** Transpile TypeScript with **inline sourcemaps** and **declaration files** to ES target -1. **Test:** Babelify ES6 to ES5 on the fly, instrumentalize ES5 JavaScript with istanbul and run tests with Mocha. \ No newline at end of file +1. **Test:** transpile TypeScript of module to ES5 for tests (so it can be instrumentalized) and pipe it to tapbuffer. All this happens in memory. \ No newline at end of file diff --git a/docs/examples.md b/docs/examples.md index d9766de..a55f241 100644 --- a/docs/examples.md +++ b/docs/examples.md @@ -1,13 +1,19 @@ -# Examples for npmts +--- +name: Examples +--- +# Examples +## of modules that use npmts + +Module Name | Description +--- | --- +[gulp-browser](https://www.npmjs.com/package/gulp-browser) | browserify for gulp -## Example Usage in modules: -* [gulp-browser](https://www.npmjs.com/package/gulp-browser) > We will add more options over time. -## Tips and tricks: +### Tips and tricks: * Use [npmts-g](https://www.npmjs.com/package/npmts-g) to use globally installed npmts and install npmts locally if no global npmts is available. * Use [npmpage](https://www.npmjs.com/package/npmpage) to create a webpage from coverage reports and TypeDoc for the module -* Use [hosttoday/ht-docker-node:npmts](https://hub.docker.com/r/hosttoday/ht-docker-node/) for speedy CI builds +* Use [hosttoday/ht-docker-node:npmci](https://hub.docker.com/r/hosttoday/ht-docker-node/) for speedy CI builds * Use [npmdocker](https://www.npmjs.com/package/npmdocker) for running tests consistently with docker. \ No newline at end of file diff --git a/docs/index.md b/docs/index.md index 61e2006..3a73d11 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,44 +1,42 @@ +--- +name: Start +--- # npmts -Write npm modules with TypeScript without hassle. TypeScript ready. Fully ES6. +## Write npm modules with TypeScript without hassle. TypeScript ready. Fully ES6. ## Availabililty -[![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/) +[![npm](https://gitzone.gitlab.io/assets/repo-button-npm.svg)](https://www.npmjs.com/package/npmts) +[![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) +[![docs](https://gitzone.gitlab.io/assets/repo-button-docs.svg)](https://gitzone.gitlab.io/npmts/) ## Status for master -[![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) +[![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/npmts.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/) -[![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) +[![Dependency Status](https://david-dm.org/gitzone/npmts.svg)](https://david-dm.org/gitzone/npmts) +[![bitHound Dependencies](https://www.bithound.io/github/gitzone/npmts/badges/dependencies.svg)](https://www.bithound.io/github/gitzone/npmts/master/dependencies/npm) +[![bitHound Code](https://www.bithound.io/github/gitzone/npmts/badges/code.svg)](https://www.bithound.io/github/gitzone/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/) [![JavaScript Style Guide](https://img.shields.io/badge/code%20style-standard-brightgreen.svg)](http://standardjs.com/) -## Introduction +## 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 +1. check your dependencies and package.json (unused, missing, updates, security) 1. transpile your code with tsc, -1. document your code with typedoc, -1. test your code with mocha -1. create coverage with istanbul +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). 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/) -For further information read the docs: -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) +> MIT licensed | **©** [Lossless GmbH](https://lossless.gmbh) +| By using this npm module you agree to our [privacy policy](https://lossless.gmbH/privacy.html) -[![npm](https://push.rocks/assets/repo-header.svg)](https://push.rocks) +[![repo-footer](https://gitzone.gitlab.io/assets/repo-footer.svg)](https://push.rocks) diff --git a/docs/info.md b/docs/info.md deleted file mode 100644 index 0e64c7c..0000000 --- a/docs/info.md +++ /dev/null @@ -1,14 +0,0 @@ -# Info - -## Future Scope: -* automatically manage badges in README -* manage tslint to enforce code best practices -* tear down any differences between local and CI environments by using brand new npmdocker - -## About the authors: -[![Project Phase](https://mediaserve.lossless.digital/lossless.com/img/createdby_github.svg)](https://lossless.com/) - -[![PayPal](https://img.shields.io/badge/Support%20us-PayPal-blue.svg)](https://paypal.me/lossless) - -## Legal Info -https://lossless.gmbh \ No newline at end of file diff --git a/docs/summary.md b/docs/summary.md deleted file mode 100644 index 8a8ac54..0000000 --- a/docs/summary.md +++ /dev/null @@ -1,8 +0,0 @@ -# Summary - -* [1. Intro](index.md) -* [2. Install](install.md) -* [3. Default Behaviour](default.md) -* [4. Configuration](config.md) -* [5. Examples](examples.md) -* [6. Info](info.md) \ No newline at end of file