update docs
This commit is contained in:
parent
1681fc729d
commit
9c58be69bf
@ -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:
|
||||
|
||||
9
docs/00footer.md
Normal file
9
docs/00footer.md
Normal file
@ -0,0 +1,9 @@
|
||||
[Legal Info](https://lossless.gmbh)
|
||||
[Privacy Policy](https://lossless.gmbh/privacy.html)
|
||||
///
|
||||
[Git.Zone](https://git.zone)
|
||||
<span>tools for a seamless dev workflow</span>
|
||||
|
||||
[Lossless GmbH](https://push.rocks)
|
||||
<span>the company behind git.zone and npmts</span>
|
||||
///
|
||||
@ -1,4 +1,9 @@
|
||||
# Configuration of NPMTS
|
||||
---
|
||||
name: config
|
||||
---
|
||||
# Configuration
|
||||
## of npmts
|
||||
|
||||
npmts can be configured to your needs:
|
||||
|
||||
### npmextra.json
|
||||
|
||||
@ -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.
|
||||
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.
|
||||
@ -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.
|
||||
@ -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
|
||||
[](https://www.npmjs.com/package/npmts)
|
||||
[](https://gitlab.com/pushrocks/npmts)
|
||||
[](https://github.com/pushrocks/npmts)
|
||||
[](https://pushrocks.gitlab.io/npmts/)
|
||||
[](https://www.npmjs.com/package/npmts)
|
||||
[](https://GitLab.com/gitzone/npmts)
|
||||
[](https://github.com/gitzone/npmts)
|
||||
[](https://gitzone.gitlab.io/npmts/)
|
||||
|
||||
## Status for master
|
||||
[](https://gitlab.com/pushrocks/npmts/commits/master)
|
||||
[](https://gitlab.com/pushrocks/npmts/commits/master)
|
||||
[](https://GitLab.com/gitzone/npmts/commits/master)
|
||||
[](https://GitLab.com/gitzone/npmts/commits/master)
|
||||
[](https://www.npmjs.com/package/npmts)
|
||||
[](https://hub.docker.com/r/hosttoday/ht-docker-node/)
|
||||
[](https://david-dm.org/pushrocks/npmts)
|
||||
[](https://www.bithound.io/github/pushrocks/npmts/master/dependencies/npm)
|
||||
[](https://www.bithound.io/github/pushrocks/npmts)
|
||||
[](https://david-dm.org/gitzone/npmts)
|
||||
[](https://www.bithound.io/github/gitzone/npmts/master/dependencies/npm)
|
||||
[](https://www.bithound.io/github/gitzone/npmts)
|
||||
[](https://nodejs.org/dist/latest-v6.x/docs/api/)
|
||||
[](https://nodejs.org/dist/latest-v6.x/docs/api/)
|
||||
[](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)
|
||||
|
||||
[](https://push.rocks)
|
||||
[](https://push.rocks)
|
||||
|
||||
14
docs/info.md
14
docs/info.md
@ -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:
|
||||
[](https://lossless.com/)
|
||||
|
||||
[](https://paypal.me/lossless)
|
||||
|
||||
## Legal Info
|
||||
https://lossless.gmbh
|
||||
@ -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)
|
||||
Loading…
Reference in New Issue
Block a user