2.3.16

.gitignore

@@ -1,4 +1,4 @@
 node_modules/
 coverage/
-docs/
+pages/
 config.json

.gitlab-ci.yml

@@ -4,6 +4,7 @@ stages:
 - test
 - release
 - trigger
+- page
 
 
 before_script:
@@ -54,4 +55,17 @@ trigger:
   only:
     - tags
   tags:
-    - docker
+    - docker
+
+pages:
+  image: hosttoday/ht-docker-node:npmpage
+  stage: page
+  script:
+    - npmci command npmts
+    - npmci command npmpage --host gitlab
+  only:
+    - tags
+  artifacts:
+    expire_in: 1 week
+    paths:
+    - public

.npmignore

@@ -1,4 +1,4 @@
-docs/
+pages/
 coverage/
 test/
 node_modules/

README.md

@@ -1,8 +1,20 @@
 # NPMCI
 npmci is your friend when it comes to handling npm packages during CI builds. It is optimized for GitLab CI
 
-## Status
+## Availabililty
+[![npm](https://push.rocks/assets/repo-button-npm.svg)](https://www.npmjs.com/package/npmci)
+[![git](https://push.rocks/assets/repo-button-git.svg)](https://gitlab.com/pushrocks/npmci)
+[![git](https://push.rocks/assets/repo-button-mirror.svg)](https://github.com/pushrocks/npmci)
+[![docs](https://push.rocks/assets/repo-button-docs.svg)](https://pushrocks.gitlab.io/npmci/docs)
+
+## Status for master
 [![build status](https://gitlab.com/pushrocks/npmci/badges/master/build.svg)](https://gitlab.com/pushrocks/npmci/commits/master)
+[![coverage report](https://gitlab.com/pushrocks/npmci/badges/master/coverage.svg)](https://gitlab.com/pushrocks/npmci/commits/master)
+[![Dependency Status](https://david-dm.org/pushrocks/npmci.svg)](https://david-dm.org/pushrocks/npmci)
+[![bitHound Dependencies](https://www.bithound.io/github/pushrocks/npmci/badges/dependencies.svg)](https://www.bithound.io/github/pushrocks/npmci/master/dependencies/npm)
+[![bitHound Code](https://www.bithound.io/github/pushrocks/npmci/badges/code.svg)](https://www.bithound.io/github/pushrocks/npmci)
+[![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/)
 
 ## Usage
 npmci is designed to work in docker CI environments. The following docker images come with npmci presinstalled:

appveyor.yml

@@ -1,10 +0,0 @@
-environment:
-  nodejs_version: "4"
-install:
-  - ps: Install-Product node $env:nodejs_version
-  - npm install
-test_script:
-  - node --version
-  - npm --version
-  - npm test
-build: off

dist/npmci.bash.js

@@ -42,11 +42,11 @@ exports.bash = (commandArg, retryArg = 2, bareArg = false) => {
         }
     }
     else {
-        plugins.beautylog.log("ShellExec would be: " + commandArg.blue);
+        plugins.beautylog.log("ShellExec would be: " + commandArg);
     }
     return stdOut;
 };
 exports.bashBare = (commandArg, retryArg = 2) => {
     return exports.bash(commandArg, retryArg, true);
 };
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoibnBtY2kuYmFzaC5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uL3RzL25wbWNpLmJhc2gudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IjtBQUFBLFFBQU8sZ0JBQWdCLENBQUMsQ0FBQTtBQUN4QixNQUFZLE9BQU8sV0FBTSxpQkFBaUIsQ0FBQyxDQUFBO0FBRzNDLElBQUksZUFBZSxHQUFXLEVBQUUsQ0FBQztBQUN0QixvQkFBWSxHQUFZLEtBQUssQ0FBQztBQUN6QyxJQUFJLFFBQVEsR0FBRztJQUNYLEVBQUUsQ0FBQyxDQUFDLE9BQU8sQ0FBQyxPQUFPLENBQUMsSUFBSSxDQUFDLHdDQUF3QyxFQUFDLEVBQUMsTUFBTSxFQUFDLElBQUksRUFBQyxDQUFDLENBQUMsSUFBSSxLQUFLLENBQUMsQ0FBQyxDQUFDLENBQUM7UUFDMUYsZUFBZSxHQUFHLGtDQUFrQyxDQUFBO1FBQ3BELG9CQUFZLEdBQUcsSUFBSSxDQUFDO0lBQ3hCLENBQUM7SUFBQyxJQUFJLENBQUMsRUFBRSxDQUFDLENBQUMsT0FBTyxDQUFDLE9BQU8sQ0FBQyxJQUFJLENBQUMsZ0NBQWdDLEVBQUMsRUFBQyxNQUFNLEVBQUMsSUFBSSxFQUFDLENBQUMsQ0FBQyxJQUFJLEtBQUssQ0FBQyxDQUFDLENBQUMsQ0FBQztRQUN6RixlQUFlLEdBQUcsMEJBQTBCLENBQUE7UUFDNUMsb0JBQVksR0FBRyxJQUFJLENBQUM7SUFDeEIsQ0FBQztJQUFBLENBQUM7QUFDTixDQUFDLENBQUM7QUFDRixRQUFRLEVBQUUsQ0FBQztBQUVBLFlBQUksR0FBRyxDQUFDLFVBQWtCLEVBQUUsUUFBUSxHQUFHLENBQUMsRUFBRSxPQUFPLEdBQUcsS0FBSztJQUNoRSxJQUFJLFFBQWdCLENBQUM7SUFDckIsSUFBSSxNQUFjLENBQUM7SUFDbkIsSUFBSSxVQUFVLENBQUM7SUFDZixFQUFFLENBQUMsQ0FBQyxDQUFDLE9BQU8sQ0FBQyxHQUFHLENBQUMsVUFBVSxDQUFDLENBQUMsQ0FBQztRQUMxQixHQUFHLENBQUMsQ0FBQyxJQUFJLENBQUMsR0FBRyxDQUFDLEVBQUUsQ0FBQyxJQUFJLFFBQVEsRUFBRSxDQUFDLEVBQUUsRUFBRSxDQUFDO1lBQ2pDLEVBQUUsQ0FBQyxDQUFDLENBQUMsT0FBTyxDQUFDLENBQUMsQ0FBQztnQkFDWCxVQUFVLEdBQUcsT0FBTyxDQUFDLE9BQU8sQ0FBQyxJQUFJLENBQzdCLFlBQVksZUFBZSxJQUFJLFVBQVUsR0FBRyxDQUMvQyxDQUFDO1lBQ04sQ0FBQztZQUFDLElBQUksQ0FBQyxDQUFDO2dCQUNKLFVBQVUsR0FBRyxPQUFPLENBQUMsT0FBTyxDQUFDLElBQUksQ0FBQyxVQUFVLENBQUMsQ0FBQztZQUNsRCxDQUFDO1lBQ0QsUUFBUSxHQUFHLFVBQVUsQ0FBQyxJQUFJLENBQUM7WUFDM0IsTUFBTSxHQUFHLFVBQVUsQ0FBQyxNQUFNLENBQUM7WUFDM0IsRUFBRSxDQUFDLENBQUMsUUFBUSxLQUFLLENBQUMsSUFBSSxDQUFDLElBQUksUUFBUSxDQUFDLENBQUMsQ0FBQztnQkFDbEMsT0FBTyxDQUFDLElBQUksQ0FBQyxDQUFDLENBQUMsQ0FBQztZQUNwQixDQUFDO1lBQUMsSUFBSSxDQUFDLEVBQUUsQ0FBQyxDQUFDLFFBQVEsSUFBSSxDQUFDLENBQUMsQ0FBQyxDQUFDO2dCQUN2QixDQUFDLEdBQUcsUUFBUSxHQUFHLENBQUMsQ0FBQyxDQUFDLHFEQUFxRDtZQUMzRSxDQUFDO1lBQUMsSUFBSSxDQUFDLENBQUM7Z0JBQ0osT0FBTyxDQUFDLFNBQVMsQ0FBQyxJQUFJLENBQUMsbUNBQW1DLEdBQUcsUUFBUSxDQUFDLFFBQVEsRUFBRSxDQUFDLENBQUM7Z0JBQ2xGLE9BQU8sQ0FBQyxTQUFTLENBQUMsSUFBSSxDQUFDLFFBQVEsR0FBRyxDQUFDLENBQUMsR0FBRyxDQUFDLENBQUMsQ0FBQyxRQUFRLEVBQUUsR0FBRyxNQUFNLEdBQUcsUUFBUSxDQUFDLFFBQVEsRUFBRSxDQUFDLENBQUM7WUFDekYsQ0FBQztRQUNMLENBQUM7SUFDTCxDQUFDO0lBQUMsSUFBSSxDQUFDLENBQUM7UUFDSixPQUFPLENBQUMsU0FBUyxDQUFDLEdBQUcsQ0FBQyxzQkFBc0IsR0FBRyxVQUFVLENBQUMsSUFBSSxDQUFDLENBQUE7SUFDbkUsQ0FBQztJQUNELE1BQU0sQ0FBQyxNQUFNLENBQUM7QUFDbEIsQ0FBQyxDQUFBO0FBRVUsZ0JBQVEsR0FBRyxDQUFDLFVBQVUsRUFBRSxRQUFRLEdBQUcsQ0FBQztJQUMzQyxNQUFNLENBQUMsWUFBSSxDQUFDLFVBQVUsRUFBRSxRQUFRLEVBQUUsSUFBSSxDQUFDLENBQUM7QUFDNUMsQ0FBQyxDQUFBIn0=
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoibnBtY2kuYmFzaC5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uL3RzL25wbWNpLmJhc2gudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IjtBQUFBLFFBQU8sZ0JBQWdCLENBQUMsQ0FBQTtBQUN4QixNQUFZLE9BQU8sV0FBTSxpQkFBaUIsQ0FBQyxDQUFBO0FBRzNDLElBQUksZUFBZSxHQUFXLEVBQUUsQ0FBQztBQUN0QixvQkFBWSxHQUFZLEtBQUssQ0FBQztBQUN6QyxJQUFJLFFBQVEsR0FBRztJQUNYLEVBQUUsQ0FBQyxDQUFDLE9BQU8sQ0FBQyxPQUFPLENBQUMsSUFBSSxDQUFDLHdDQUF3QyxFQUFDLEVBQUMsTUFBTSxFQUFDLElBQUksRUFBQyxDQUFDLENBQUMsSUFBSSxLQUFLLENBQUMsQ0FBQyxDQUFDLENBQUM7UUFDMUYsZUFBZSxHQUFHLGtDQUFrQyxDQUFBO1FBQ3BELG9CQUFZLEdBQUcsSUFBSSxDQUFDO0lBQ3hCLENBQUM7SUFBQyxJQUFJLENBQUMsRUFBRSxDQUFDLENBQUMsT0FBTyxDQUFDLE9BQU8sQ0FBQyxJQUFJLENBQUMsZ0NBQWdDLEVBQUMsRUFBQyxNQUFNLEVBQUMsSUFBSSxFQUFDLENBQUMsQ0FBQyxJQUFJLEtBQUssQ0FBQyxDQUFDLENBQUMsQ0FBQztRQUN6RixlQUFlLEdBQUcsMEJBQTBCLENBQUE7UUFDNUMsb0JBQVksR0FBRyxJQUFJLENBQUM7SUFDeEIsQ0FBQztJQUFBLENBQUM7QUFDTixDQUFDLENBQUM7QUFDRixRQUFRLEVBQUUsQ0FBQztBQUVBLFlBQUksR0FBRyxDQUFDLFVBQWtCLEVBQUUsUUFBUSxHQUFHLENBQUMsRUFBRSxPQUFPLEdBQUcsS0FBSztJQUNoRSxJQUFJLFFBQWdCLENBQUM7SUFDckIsSUFBSSxNQUFjLENBQUM7SUFDbkIsSUFBSSxVQUFVLENBQUM7SUFDZixFQUFFLENBQUMsQ0FBQyxDQUFDLE9BQU8sQ0FBQyxHQUFHLENBQUMsVUFBVSxDQUFDLENBQUMsQ0FBQztRQUMxQixHQUFHLENBQUMsQ0FBQyxJQUFJLENBQUMsR0FBRyxDQUFDLEVBQUUsQ0FBQyxJQUFJLFFBQVEsRUFBRSxDQUFDLEVBQUUsRUFBRSxDQUFDO1lBQ2pDLEVBQUUsQ0FBQyxDQUFDLENBQUMsT0FBTyxDQUFDLENBQUMsQ0FBQztnQkFDWCxVQUFVLEdBQUcsT0FBTyxDQUFDLE9BQU8sQ0FBQyxJQUFJLENBQzdCLFlBQVksZUFBZSxJQUFJLFVBQVUsR0FBRyxDQUMvQyxDQUFDO1lBQ04sQ0FBQztZQUFDLElBQUksQ0FBQyxDQUFDO2dCQUNKLFVBQVUsR0FBRyxPQUFPLENBQUMsT0FBTyxDQUFDLElBQUksQ0FBQyxVQUFVLENBQUMsQ0FBQztZQUNsRCxDQUFDO1lBQ0QsUUFBUSxHQUFHLFVBQVUsQ0FBQyxJQUFJLENBQUM7WUFDM0IsTUFBTSxHQUFHLFVBQVUsQ0FBQyxNQUFNLENBQUM7WUFDM0IsRUFBRSxDQUFDLENBQUMsUUFBUSxLQUFLLENBQUMsSUFBSSxDQUFDLElBQUksUUFBUSxDQUFDLENBQUMsQ0FBQztnQkFDbEMsT0FBTyxDQUFDLElBQUksQ0FBQyxDQUFDLENBQUMsQ0FBQztZQUNwQixDQUFDO1lBQUMsSUFBSSxDQUFDLEVBQUUsQ0FBQyxDQUFDLFFBQVEsSUFBSSxDQUFDLENBQUMsQ0FBQyxDQUFDO2dCQUN2QixDQUFDLEdBQUcsUUFBUSxHQUFHLENBQUMsQ0FBQyxDQUFDLHFEQUFxRDtZQUMzRSxDQUFDO1lBQUMsSUFBSSxDQUFDLENBQUM7Z0JBQ0osT0FBTyxDQUFDLFNBQVMsQ0FBQyxJQUFJLENBQUMsbUNBQW1DLEdBQUcsUUFBUSxDQUFDLFFBQVEsRUFBRSxDQUFDLENBQUM7Z0JBQ2xGLE9BQU8sQ0FBQyxTQUFTLENBQUMsSUFBSSxDQUFDLFFBQVEsR0FBRyxDQUFDLENBQUMsR0FBRyxDQUFDLENBQUMsQ0FBQyxRQUFRLEVBQUUsR0FBRyxNQUFNLEdBQUcsUUFBUSxDQUFDLFFBQVEsRUFBRSxDQUFDLENBQUM7WUFDekYsQ0FBQztRQUNMLENBQUM7SUFDTCxDQUFDO0lBQUMsSUFBSSxDQUFDLENBQUM7UUFDSixPQUFPLENBQUMsU0FBUyxDQUFDLEdBQUcsQ0FBQyxzQkFBc0IsR0FBRyxVQUFVLENBQUMsQ0FBQTtJQUM5RCxDQUFDO0lBQ0QsTUFBTSxDQUFDLE1BQU0sQ0FBQztBQUNsQixDQUFDLENBQUE7QUFFVSxnQkFBUSxHQUFHLENBQUMsVUFBVSxFQUFFLFFBQVEsR0FBRyxDQUFDO0lBQzNDLE1BQU0sQ0FBQyxZQUFJLENBQUMsVUFBVSxFQUFFLFFBQVEsRUFBRSxJQUFJLENBQUMsQ0FBQztBQUM1QyxDQUFDLENBQUEifQ==

dist/npmci.build.d.ts

@@ -1,4 +1,11 @@
 /// <reference types="q" />
 import "typings-global";
 import * as plugins from "./npmci.plugins";
-export declare let build: (commandArg: any) => plugins.q.Promise<{}>;
+/**
+ * defines possible build services
+ */
+export declare type TBuildService = "docker";
+/**
+ * builds for a specific service
+ */
+export declare let build: (commandArg: any) => plugins.q.Promise<any>;

dist/npmci.build.docker.d.ts

@@ -1,14 +1,46 @@
 /// <reference types="q" />
 /// <reference types="node" />
 import * as plugins from "./npmci.plugins";
+/**
+ * builds a cwd of Dockerfiles by triggering a promisechain
+ */
 export declare let build: () => plugins.q.Promise<{}>;
-export declare let readDockerfiles: () => plugins.q.Promise<{}>;
-export declare let sortDockerfiles: (sortableArrayArg: Dockerfile[]) => plugins.q.Promise<{}>;
-export declare let mapDockerfiles: (sortedArray: Dockerfile[]) => plugins.q.Promise<{}>;
+/**
+ * creates instance of class Dockerfile for all Dockerfiles in cwd
+ * @returns Promise<Dockerfile[]>
+ */
+export declare let readDockerfiles: () => plugins.q.Promise<Dockerfile[]>;
+/**
+ * sorts Dockerfiles into a dependency chain
+ * @param sortableArrayArg an array of instances of class Dockerfile
+ * @returns Promise<Dockerfile[]>
+ */
+export declare let sortDockerfiles: (sortableArrayArg: Dockerfile[]) => plugins.q.Promise<Dockerfile[]>;
+/**
+ * maps local Dockerfiles dependencies to the correspoding Dockerfile class instances
+ */
+export declare let mapDockerfiles: (sortedArray: Dockerfile[]) => plugins.q.Promise<Dockerfile[]>;
+/**
+ * builds the correspoding real docker image for each Dockerfile class instance
+ */
 export declare let buildDockerfiles: (sortedArrayArg: Dockerfile[]) => plugins.q.Promise<{}>;
+/**
+ * pushes the real Dockerfile images to a Docker registry
+ */
 export declare let pushDockerfiles: (sortedArrayArg: Dockerfile[]) => plugins.q.Promise<{}>;
+/**
+ * pulls corresponding real Docker images for instances of Dockerfile from a registry.
+ * This is needed if building, testing, and publishing of Docker images is carried out in seperate CI stages.
+ */
 export declare let pullDockerfileImages: (sortableArrayArg: Dockerfile[], registryArg?: string) => plugins.q.Promise<{}>;
+/**
+ * tests all Dockerfiles in by calling class Dockerfile.test();
+ * @param sortedArrayArg Dockerfile[] that contains all Dockerfiles in cwd
+ */
 export declare let testDockerfiles: (sortedArrayArg: Dockerfile[]) => plugins.q.Promise<{}>;
+/**
+ * class Dockerfile represents a Dockerfile on disk in npmci
+ */
 export declare class Dockerfile {
     filePath: string;
     repo: string;
@@ -27,13 +59,40 @@ export declare class Dockerfile {
         fileContents?: string | Buffer;
         read?: boolean;
     });
+    /**
+     * builds the Dockerfile
+     */
     build(): plugins.q.Promise<{}>;
+    /**
+     * pushes the Dockerfile to a registry
+     */
     push(stageArg: any): plugins.q.Promise<{}>;
+    /**
+     * pulls the Dockerfile from a registry
+     */
     pull(registryArg: string): void;
+    /**
+     * tests the Dockerfile;
+     */
     test(): void;
+    /**
+     * gets the id of a Dockerfile
+     */
     getId(): string;
 }
+/**
+ *
+ */
 export declare let dockerFileVersion: (dockerfileNameArg: string) => string;
+/**
+ *
+ */
 export declare let dockerBaseImage: (dockerfileContentArg: string) => string;
+/**
+ *
+ */
 export declare let dockerTag: (registryArg: string, repoArg: string, versionArg: string, suffixArg?: string) => string;
+/**
+ *
+ */
 export declare let cleanTagsArrayFunction: (dockerfileArrayArg: Dockerfile[], trackingArrayArg: Dockerfile[]) => string[];

dist/npmci.build.js

@@ -2,6 +2,9 @@
 require("typings-global");
 const plugins = require("./npmci.plugins");
 const buildDocker = require("./npmci.build.docker");
+/**
+ * builds for a specific service
+ */
 exports.build = function (commandArg) {
     switch (commandArg) {
         case "docker":
@@ -9,5 +12,7 @@ exports.build = function (commandArg) {
         default:
             plugins.beautylog.log("build target " + commandArg + " not recognised!");
     }
+    ;
+    return;
 };
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoibnBtY2kuYnVpbGQuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi90cy9ucG1jaS5idWlsZC50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiO0FBQUEsUUFBTyxnQkFBZ0IsQ0FBQyxDQUFBO0FBQ3hCLE1BQVksT0FBTyxXQUFNLGlCQUFpQixDQUFDLENBQUE7QUFHM0MsTUFBWSxXQUFXLFdBQU0sc0JBRTdCLENBQUMsQ0FGa0Q7QUFFeEMsYUFBSyxHQUFHLFVBQVMsVUFBVTtJQUNsQyxNQUFNLENBQUEsQ0FBQyxVQUFVLENBQUMsQ0FBQSxDQUFDO1FBQ2YsS0FBSyxRQUFRO1lBQ1QsTUFBTSxDQUFDLFdBQVcsQ0FBQyxLQUFLLEVBQUUsQ0FBQztRQUMvQjtZQUNJLE9BQU8sQ0FBQyxTQUFTLENBQUMsR0FBRyxDQUFDLGVBQWUsR0FBRyxVQUFVLEdBQUcsa0JBQWtCLENBQUMsQ0FBQztJQUNqRixDQUFDO0FBQ0wsQ0FBQyxDQUFBIn0=
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoibnBtY2kuYnVpbGQuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi90cy9ucG1jaS5idWlsZC50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiO0FBQUEsUUFBTyxnQkFBZ0IsQ0FBQyxDQUFBO0FBQ3hCLE1BQVksT0FBTyxXQUFNLGlCQUFpQixDQUFDLENBQUE7QUFHM0MsTUFBWSxXQUFXLFdBQU0sc0JBSzdCLENBQUMsQ0FMa0Q7QUFPbkQ7O0dBRUc7QUFDUSxhQUFLLEdBQUcsVUFBUyxVQUFVO0lBQ2xDLE1BQU0sQ0FBQSxDQUFDLFVBQVUsQ0FBQyxDQUFBLENBQUM7UUFDZixLQUFLLFFBQVE7WUFDVCxNQUFNLENBQUMsV0FBVyxDQUFDLEtBQUssRUFBRSxDQUFDO1FBQy9CO1lBQ0ksT0FBTyxDQUFDLFNBQVMsQ0FBQyxHQUFHLENBQUMsZUFBZSxHQUFHLFVBQVUsR0FBRyxrQkFBa0IsQ0FBQyxDQUFDO0lBQ2pGLENBQUM7SUFBQSxDQUFDO0lBQ0YsTUFBTSxDQUFDO0FBQ1gsQ0FBQyxDQUFBIn0=

dist/npmci.install.js

@@ -5,7 +5,7 @@ const npmci_bash_1 = require("./npmci.bash");
 const npmci_bash_2 = require("./npmci.bash");
 exports.install = (versionArg) => {
     let done = plugins.q.defer();
-    plugins.beautylog.log("now installing " + "node ".green + ("version " + versionArg).yellow);
+    plugins.beautylog.log(`now installing node version ${versionArg}`);
     let version;
     if (versionArg == "stable") {
         version = "6.3.0";
@@ -33,4 +33,4 @@ exports.install = (versionArg) => {
     done.resolve();
     return done.promise;
 };
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoibnBtY2kuaW5zdGFsbC5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uL3RzL25wbWNpLmluc3RhbGwudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IjtBQUFBLFFBQU8sZ0JBQWdCLENBQUMsQ0FBQTtBQUN4QixNQUFZLE9BQU8sV0FBTSxpQkFBaUIsQ0FBQyxDQUFBO0FBQzNDLDZCQUFxQixjQUFjLENBQUMsQ0FBQTtBQUNwQyw2QkFBNkIsY0FFN0IsQ0FBQyxDQUYwQztBQUVoQyxlQUFPLEdBQUcsQ0FBQyxVQUFVO0lBQzVCLElBQUksSUFBSSxHQUFHLE9BQU8sQ0FBQyxDQUFDLENBQUMsS0FBSyxFQUFFLENBQUM7SUFDN0IsT0FBTyxDQUFDLFNBQVMsQ0FBQyxHQUFHLENBQUMsaUJBQWlCLEdBQUcsT0FBTyxDQUFDLEtBQUssR0FBRyxDQUFDLFVBQVUsR0FBRyxVQUFVLENBQUMsQ0FBQyxNQUFNLENBQUMsQ0FBQztJQUM1RixJQUFJLE9BQWUsQ0FBQztJQUNwQixFQUFFLENBQUMsQ0FBQyxVQUFVLElBQUksUUFBUSxDQUFDLENBQUMsQ0FBQztRQUN6QixPQUFPLEdBQUcsT0FBTyxDQUFDO0lBQ3RCLENBQUM7SUFBQyxJQUFJLENBQUMsRUFBRSxDQUFDLENBQUMsVUFBVSxJQUFJLEtBQUssQ0FBQyxDQUFDLENBQUM7UUFDN0IsT0FBTyxHQUFHLE9BQU8sQ0FBQztJQUN0QixDQUFDO0lBQUMsSUFBSSxDQUFDLEVBQUUsQ0FBQyxDQUFDLFVBQVUsSUFBSSxRQUFRLENBQUMsQ0FBQyxDQUFDO1FBQ2hDLE9BQU8sR0FBRyxPQUFPLENBQUE7SUFDckIsQ0FBQztJQUFDLElBQUksQ0FBQyxDQUFDO1FBQ0osT0FBTyxHQUFHLFVBQVUsQ0FBQztJQUN6QixDQUFDO0lBQUEsQ0FBQztJQUNGLEVBQUUsQ0FBQyxDQUFDLHlCQUFZLENBQUMsQ0FBQyxDQUFDO1FBQ2YsaUJBQUksQ0FBQyxlQUFlLE9BQU8seUJBQXlCLE9BQU8sRUFBRSxDQUFDLENBQUE7UUFDOUQsT0FBTyxDQUFDLFNBQVMsQ0FBQyxPQUFPLENBQUMsZ0JBQWdCLE9BQU8sMEJBQTBCLENBQUMsQ0FBQztJQUNqRixDQUFDO0lBQUMsSUFBSSxDQUFDLENBQUM7UUFDSixPQUFPLENBQUMsU0FBUyxDQUFDLElBQUksQ0FBQyx1REFBdUQsQ0FBQyxDQUFDO0lBQ3BGLENBQUM7SUFBQSxDQUFDO0lBQ0YsaUJBQUksQ0FBQyxTQUFTLENBQUMsQ0FBQztJQUNoQixpQkFBSSxDQUFDLFFBQVEsQ0FBQyxDQUFDO0lBQ2YsSUFBSSxDQUFDLE9BQU8sRUFBRSxDQUFDO0lBQ2YsTUFBTSxDQUFDLElBQUksQ0FBQyxPQUFPLENBQUM7QUFDeEIsQ0FBQyxDQUFBIn0=
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoibnBtY2kuaW5zdGFsbC5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uL3RzL25wbWNpLmluc3RhbGwudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IjtBQUFBLFFBQU8sZ0JBQWdCLENBQUMsQ0FBQTtBQUN4QixNQUFZLE9BQU8sV0FBTSxpQkFBaUIsQ0FBQyxDQUFBO0FBQzNDLDZCQUFxQixjQUFjLENBQUMsQ0FBQTtBQUNwQyw2QkFBNkIsY0FFN0IsQ0FBQyxDQUYwQztBQUVoQyxlQUFPLEdBQUcsQ0FBQyxVQUFVO0lBQzVCLElBQUksSUFBSSxHQUFHLE9BQU8sQ0FBQyxDQUFDLENBQUMsS0FBSyxFQUFFLENBQUM7SUFDN0IsT0FBTyxDQUFDLFNBQVMsQ0FBQyxHQUFHLENBQUMsK0JBQStCLFVBQVUsRUFBRSxDQUFDLENBQUM7SUFDbkUsSUFBSSxPQUFlLENBQUM7SUFDcEIsRUFBRSxDQUFDLENBQUMsVUFBVSxJQUFJLFFBQVEsQ0FBQyxDQUFDLENBQUM7UUFDekIsT0FBTyxHQUFHLE9BQU8sQ0FBQztJQUN0QixDQUFDO0lBQUMsSUFBSSxDQUFDLEVBQUUsQ0FBQyxDQUFDLFVBQVUsSUFBSSxLQUFLLENBQUMsQ0FBQyxDQUFDO1FBQzdCLE9BQU8sR0FBRyxPQUFPLENBQUM7SUFDdEIsQ0FBQztJQUFDLElBQUksQ0FBQyxFQUFFLENBQUMsQ0FBQyxVQUFVLElBQUksUUFBUSxDQUFDLENBQUMsQ0FBQztRQUNoQyxPQUFPLEdBQUcsT0FBTyxDQUFBO0lBQ3JCLENBQUM7SUFBQyxJQUFJLENBQUMsQ0FBQztRQUNKLE9BQU8sR0FBRyxVQUFVLENBQUM7SUFDekIsQ0FBQztJQUFBLENBQUM7SUFDRixFQUFFLENBQUMsQ0FBQyx5QkFBWSxDQUFDLENBQUMsQ0FBQztRQUNmLGlCQUFJLENBQUMsZUFBZSxPQUFPLHlCQUF5QixPQUFPLEVBQUUsQ0FBQyxDQUFBO1FBQzlELE9BQU8sQ0FBQyxTQUFTLENBQUMsT0FBTyxDQUFDLGdCQUFnQixPQUFPLDBCQUEwQixDQUFDLENBQUM7SUFDakYsQ0FBQztJQUFDLElBQUksQ0FBQyxDQUFDO1FBQ0osT0FBTyxDQUFDLFNBQVMsQ0FBQyxJQUFJLENBQUMsdURBQXVELENBQUMsQ0FBQztJQUNwRixDQUFDO0lBQUEsQ0FBQztJQUNGLGlCQUFJLENBQUMsU0FBUyxDQUFDLENBQUM7SUFDaEIsaUJBQUksQ0FBQyxRQUFRLENBQUMsQ0FBQztJQUNmLElBQUksQ0FBQyxPQUFPLEVBQUUsQ0FBQztJQUNmLE1BQU0sQ0FBQyxJQUFJLENBQUMsT0FBTyxDQUFDO0FBQ3hCLENBQUMsQ0FBQSJ9

dist/npmci.plugins.d.ts

@@ -11,6 +11,7 @@ export import shelljs = require("shelljs");
 export import smartcli = require("smartcli");
 export import smartfile = require("smartfile");
 export import smartparam = require("smartparam");
+export import smartsocket = require("smartsocket");
 export import smartssh = require("smartssh");
 export import smartstring = require("smartstring");
 export declare let through2: any;

dist/npmci.plugins.js

@@ -12,7 +12,8 @@ exports.shelljs = require("shelljs");
 exports.smartcli = require("smartcli");
 exports.smartfile = require("smartfile");
 exports.smartparam = require("smartparam");
+exports.smartsocket = require("smartsocket");
 exports.smartssh = require("smartssh");
 exports.smartstring = require("smartstring");
 exports.through2 = require("through2");
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoibnBtY2kucGx1Z2lucy5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uL3RzL25wbWNpLnBsdWdpbnMudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IjtBQUFBLFFBQU8sZ0JBQWdCLENBQUMsQ0FBQTtBQUNWLGlCQUFTLFdBQVcsV0FBVyxDQUFDLENBQUM7QUFDcEMsWUFBSSxHQUFHLE9BQU8sQ0FBQyxNQUFNLENBQUMsQ0FBQztBQUN2QixvQkFBWSxHQUFHLE9BQU8sQ0FBQyxlQUFlLENBQUMsQ0FBQztBQUN4QyxjQUFNLEdBQUcsT0FBTyxDQUFDLFFBQVEsQ0FBQyxDQUFDO0FBQ3hCLFlBQUksV0FBVyxNQUFNLENBQUMsQ0FBQztBQUN2QixtQkFBVyxXQUFXLGFBQWEsQ0FBQyxDQUFDO0FBQ3JDLFNBQUMsV0FBVyxHQUFHLENBQUMsQ0FBQztBQUNwQixlQUFPLEdBQUcsT0FBTyxDQUFDLFNBQVMsQ0FBQyxDQUFDO0FBQzFCLGVBQU8sV0FBVyxTQUFTLENBQUMsQ0FBQztBQUM3QixnQkFBUSxXQUFXLFVBQVUsQ0FBQyxDQUFDO0FBQy9CLGlCQUFTLFdBQVcsV0FBVyxDQUFDLENBQUM7QUFDakMsa0JBQVUsV0FBVyxZQUFZLENBQUMsQ0FBQztBQUNuQyxnQkFBUSxXQUFXLFVBQVUsQ0FBQyxDQUFDO0FBQy9CLG1CQUFXLFdBQVcsYUFBYSxDQUFDLENBQUM7QUFDeEMsZ0JBQVEsR0FBRyxPQUFPLENBQUMsVUFBVSxDQUFDLENBQUMifQ==
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoibnBtY2kucGx1Z2lucy5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uL3RzL25wbWNpLnBsdWdpbnMudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IjtBQUFBLFFBQU8sZ0JBQWdCLENBQUMsQ0FBQTtBQUNWLGlCQUFTLFdBQVcsV0FBVyxDQUFDLENBQUM7QUFDcEMsWUFBSSxHQUFHLE9BQU8sQ0FBQyxNQUFNLENBQUMsQ0FBQztBQUN2QixvQkFBWSxHQUFHLE9BQU8sQ0FBQyxlQUFlLENBQUMsQ0FBQztBQUN4QyxjQUFNLEdBQUcsT0FBTyxDQUFDLFFBQVEsQ0FBQyxDQUFDO0FBQ3hCLFlBQUksV0FBVyxNQUFNLENBQUMsQ0FBQztBQUN2QixtQkFBVyxXQUFXLGFBQWEsQ0FBQyxDQUFDO0FBQ3JDLFNBQUMsV0FBVyxHQUFHLENBQUMsQ0FBQztBQUNwQixlQUFPLEdBQUcsT0FBTyxDQUFDLFNBQVMsQ0FBQyxDQUFDO0FBQzFCLGVBQU8sV0FBVyxTQUFTLENBQUMsQ0FBQztBQUM3QixnQkFBUSxXQUFXLFVBQVUsQ0FBQyxDQUFDO0FBQy9CLGlCQUFTLFdBQVcsV0FBVyxDQUFDLENBQUM7QUFDakMsa0JBQVUsV0FBVyxZQUFZLENBQUMsQ0FBQztBQUNuQyxtQkFBVyxXQUFXLGFBQWEsQ0FBQyxDQUFDO0FBQ3JDLGdCQUFRLFdBQVcsVUFBVSxDQUFDLENBQUM7QUFDL0IsbUJBQVcsV0FBVyxhQUFhLENBQUMsQ0FBQztBQUN4QyxnQkFBUSxHQUFHLE9BQU8sQ0FBQyxVQUFVLENBQUMsQ0FBQyJ9

dist/npmci.prepare.d.ts

@@ -1,4 +1,12 @@
 /// <reference types="q" />
 import "typings-global";
 import * as plugins from "./npmci.plugins";
-export declare let prepare: (serviceArg: string) => plugins.q.Promise<{}>;
+/**
+ * defines possible prepare services
+ */
+export declare type TPrepService = "npm" | "docker" | "docker-gitlab" | "ssh";
+/**
+ * the main exported prepare function
+ * @param servieArg describes the service to prepare
+ */
+export declare let prepare: (serviceArg: TPrepService) => plugins.q.Promise<{}>;

dist/npmci.prepare.js

@@ -3,6 +3,9 @@ require("typings-global");
 const plugins = require("./npmci.plugins");
 const env = require("./npmci.env");
 const sshModule = require("./npmci.ssh");
+/**
+ * authenticates npm with token from env var
+ */
 let npm = function () {
     let done = plugins.q.defer();
     let npmrcPrefix = "//registry.npmjs.org/:_authToken=";
@@ -19,6 +22,9 @@ let npm = function () {
     done.resolve();
     return done.promise;
 };
+/**
+ * logs in docker
+ */
 let docker = function () {
     let done = plugins.q.defer();
     env.setDockerRegistry("docker.io");
@@ -35,6 +41,9 @@ let docker = function () {
     done.resolve();
     return done.promise;
 };
+/**
+ * prepare docker for gitlab registry
+ */
 let dockerGitlab = function () {
     let done = plugins.q.defer();
     env.setDockerRegistry("registry.gitlab.com");
@@ -42,12 +51,19 @@ let dockerGitlab = function () {
     done.resolve();
     return done.promise;
 };
+/**
+ * prepare ssh
+ */
 let ssh = function () {
     let done = plugins.q.defer();
     sshModule.ssh()
         .then(done.resolve);
     return done.promise;
 };
+/**
+ * the main exported prepare function
+ * @param servieArg describes the service to prepare
+ */
 exports.prepare = function (serviceArg) {
     switch (serviceArg) {
         case "npm":
@@ -62,4 +78,4 @@ exports.prepare = function (serviceArg) {
             break;
     }
 };
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoibnBtY2kucHJlcGFyZS5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uL3RzL25wbWNpLnByZXBhcmUudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IjtBQUFBLFFBQU8sZ0JBQWdCLENBQUMsQ0FBQTtBQUN4QixNQUFZLE9BQU8sV0FBTSxpQkFBaUIsQ0FBQyxDQUFBO0FBRTNDLE1BQVksR0FBRyxXQUFNLGFBQ3JCLENBQUMsQ0FEaUM7QUFDbEMsTUFBWSxTQUFTLFdBQU0sYUFFM0IsQ0FBQyxDQUZ1QztBQUV4QyxJQUFJLEdBQUcsR0FBRztJQUNOLElBQUksSUFBSSxHQUFHLE9BQU8sQ0FBQyxDQUFDLENBQUMsS0FBSyxFQUFFLENBQUM7SUFFN0IsSUFBSSxXQUFXLEdBQVUsbUNBQW1DLENBQUM7SUFDN0QsSUFBSSxRQUFRLEdBQVUsT0FBTyxDQUFDLEdBQUcsQ0FBQyxlQUFlLENBQUM7SUFDbEQsSUFBSSxlQUFlLEdBQUcsV0FBVyxHQUFHLFFBQVEsQ0FBQztJQUU3QyxFQUFFLENBQUEsQ0FBQyxRQUFRLENBQUMsQ0FBQSxDQUFDO1FBQ1QsT0FBTyxDQUFDLFNBQVMsQ0FBQyxJQUFJLENBQUMsb0JBQW9CLENBQUMsQ0FBQztJQUNqRCxDQUFDO0lBQUMsSUFBSSxDQUFDLENBQUM7UUFDSixPQUFPLENBQUMsU0FBUyxDQUFDLEtBQUssQ0FBQyxpQ0FBaUMsQ0FBQyxDQUFDO1FBQzNELE9BQU8sQ0FBQyxJQUFJLENBQUMsQ0FBQyxDQUFDLENBQUM7SUFDcEIsQ0FBQztJQUNELE9BQU8sQ0FBQyxTQUFTLENBQUMsTUFBTSxDQUFDLFFBQVEsQ0FBQyxlQUFlLEVBQUMsY0FBYyxDQUFDLENBQUM7SUFDbEUsSUFBSSxDQUFDLE9BQU8sRUFBRSxDQUFDO0lBQ2YsTUFBTSxDQUFDLElBQUksQ0FBQyxPQUFPLENBQUM7QUFDeEIsQ0FBQyxDQUFDO0FBRUYsSUFBSSxNQUFNLEdBQUc7SUFDVCxJQUFJLElBQUksR0FBRyxPQUFPLENBQUMsQ0FBQyxDQUFDLEtBQUssRUFBRSxDQUFDO0lBQzdCLEdBQUcsQ0FBQyxpQkFBaUIsQ0FBQyxXQUFXLENBQUMsQ0FBQztJQUNuQyxJQUFJLFdBQVcsR0FBRyxxQ0FBcUMsQ0FBQTtJQUN2RCxFQUFFLENBQUEsQ0FBQyxDQUFDLE9BQU8sQ0FBQyxHQUFHLENBQUMsa0JBQWtCLENBQUMsQ0FBQSxDQUFDO1FBQ2hDLE9BQU8sQ0FBQyxTQUFTLENBQUMsS0FBSyxDQUFDLHVEQUF1RCxDQUFDLENBQUM7UUFDakYsT0FBTyxDQUFDLElBQUksQ0FBQyxDQUFDLENBQUMsQ0FBQztJQUNwQixDQUFDO0lBQ0QsT0FBTyxDQUFDLE9BQU8sQ0FBQyxJQUFJLENBQUMscUNBQXFDLEdBQUcsT0FBTyxDQUFDLEdBQUcsQ0FBQyxjQUFjLEdBQUcsR0FBRyxHQUFHLHFCQUFxQixDQUFDLENBQUMsQ0FBQyx1Q0FBdUM7SUFDL0osSUFBSSxzQkFBc0IsR0FBRyxXQUFXLENBQUMsSUFBSSxDQUFDLE9BQU8sQ0FBQyxHQUFHLENBQUMsa0JBQWtCLENBQUMsQ0FBQztJQUM5RSxJQUFJLFFBQVEsR0FBRyxzQkFBc0IsQ0FBQyxDQUFDLENBQUMsQ0FBQztJQUN6QyxJQUFJLFFBQVEsR0FBRyxzQkFBc0IsQ0FBQyxDQUFDLENBQUMsQ0FBQztJQUN6QyxPQUFPLENBQUMsT0FBTyxDQUFDLElBQUksQ0FBQyxrQkFBa0IsR0FBRyxRQUFRLEdBQUcsTUFBTSxHQUFHLFFBQVEsQ0FBQyxDQUFDO0lBQ3hFLElBQUksQ0FBQyxPQUFPLEVBQUUsQ0FBQztJQUNmLE1BQU0sQ0FBQyxJQUFJLENBQUMsT0FBTyxDQUFDO0FBQ3hCLENBQUMsQ0FBQTtBQUVELElBQUksWUFBWSxHQUFHO0lBQ2YsSUFBSSxJQUFJLEdBQUcsT0FBTyxDQUFDLENBQUMsQ0FBQyxLQUFLLEVBQUUsQ0FBQztJQUM3QixHQUFHLENBQUMsaUJBQWlCLENBQUMscUJBQXFCLENBQUMsQ0FBQztJQUM3QyxPQUFPLENBQUMsT0FBTyxDQUFDLElBQUksQ0FBQyxxQ0FBcUMsR0FBRyxPQUFPLENBQUMsR0FBRyxDQUFDLGNBQWMsR0FBRyxHQUFHLEdBQUcscUJBQXFCLENBQUMsQ0FBQztJQUN2SCxJQUFJLENBQUMsT0FBTyxFQUFFLENBQUM7SUFDZixNQUFNLENBQUMsSUFBSSxDQUFDLE9BQU8sQ0FBQztBQUN4QixDQUFDLENBQUE7QUFFRCxJQUFJLEdBQUcsR0FBRztJQUNOLElBQUksSUFBSSxHQUFHLE9BQU8sQ0FBQyxDQUFDLENBQUMsS0FBSyxFQUFFLENBQUM7SUFDN0IsU0FBUyxDQUFDLEdBQUcsRUFBRTtTQUNWLElBQUksQ0FBQyxJQUFJLENBQUMsT0FBTyxDQUFDLENBQUM7SUFDeEIsTUFBTSxDQUFDLElBQUksQ0FBQyxPQUFPLENBQUM7QUFDeEIsQ0FBQyxDQUFBO0FBRVUsZUFBTyxHQUFHLFVBQVMsVUFBaUI7SUFDM0MsTUFBTSxDQUFDLENBQUMsVUFBVSxDQUFDLENBQUMsQ0FBQztRQUNqQixLQUFLLEtBQUs7WUFDTixNQUFNLENBQUMsR0FBRyxFQUFFLENBQUM7UUFDakIsS0FBSyxRQUFRO1lBQ1QsTUFBTSxDQUFDLE1BQU0sRUFBRSxDQUFDO1FBQ3BCLEtBQUssZUFBZTtZQUNoQixNQUFNLENBQUMsWUFBWSxFQUFFLENBQUM7UUFDMUIsS0FBSyxLQUFLO1lBQ04sTUFBTSxDQUFDLEdBQUcsRUFBRSxDQUFDO1FBQ2pCO1lBQ0ksS0FBSyxDQUFDO0lBQ2QsQ0FBQztBQUNMLENBQUMsQ0FBQSJ9
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoibnBtY2kucHJlcGFyZS5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uL3RzL25wbWNpLnByZXBhcmUudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IjtBQUFBLFFBQU8sZ0JBQWdCLENBQUMsQ0FBQTtBQUN4QixNQUFZLE9BQU8sV0FBTSxpQkFBaUIsQ0FBQyxDQUFBO0FBRTNDLE1BQVksR0FBRyxXQUFNLGFBQ3JCLENBQUMsQ0FEaUM7QUFDbEMsTUFBWSxTQUFTLFdBQU0sYUFRM0IsQ0FBQyxDQVJ1QztBQVV4Qzs7R0FFRztBQUNILElBQUksR0FBRyxHQUFHO0lBQ04sSUFBSSxJQUFJLEdBQUcsT0FBTyxDQUFDLENBQUMsQ0FBQyxLQUFLLEVBQUUsQ0FBQztJQUU3QixJQUFJLFdBQVcsR0FBVSxtQ0FBbUMsQ0FBQztJQUM3RCxJQUFJLFFBQVEsR0FBVSxPQUFPLENBQUMsR0FBRyxDQUFDLGVBQWUsQ0FBQztJQUNsRCxJQUFJLGVBQWUsR0FBRyxXQUFXLEdBQUcsUUFBUSxDQUFDO0lBRTdDLEVBQUUsQ0FBQSxDQUFDLFFBQVEsQ0FBQyxDQUFBLENBQUM7UUFDVCxPQUFPLENBQUMsU0FBUyxDQUFDLElBQUksQ0FBQyxvQkFBb0IsQ0FBQyxDQUFDO0lBQ2pELENBQUM7SUFBQyxJQUFJLENBQUMsQ0FBQztRQUNKLE9BQU8sQ0FBQyxTQUFTLENBQUMsS0FBSyxDQUFDLGlDQUFpQyxDQUFDLENBQUM7UUFDM0QsT0FBTyxDQUFDLElBQUksQ0FBQyxDQUFDLENBQUMsQ0FBQztJQUNwQixDQUFDO0lBQ0QsT0FBTyxDQUFDLFNBQVMsQ0FBQyxNQUFNLENBQUMsUUFBUSxDQUFDLGVBQWUsRUFBQyxjQUFjLENBQUMsQ0FBQztJQUNsRSxJQUFJLENBQUMsT0FBTyxFQUFFLENBQUM7SUFDZixNQUFNLENBQUMsSUFBSSxDQUFDLE9BQU8sQ0FBQztBQUN4QixDQUFDLENBQUM7QUFFRjs7R0FFRztBQUNILElBQUksTUFBTSxHQUFHO0lBQ1QsSUFBSSxJQUFJLEdBQUcsT0FBTyxDQUFDLENBQUMsQ0FBQyxLQUFLLEVBQUUsQ0FBQztJQUM3QixHQUFHLENBQUMsaUJBQWlCLENBQUMsV0FBVyxDQUFDLENBQUM7SUFDbkMsSUFBSSxXQUFXLEdBQUcscUNBQXFDLENBQUE7SUFDdkQsRUFBRSxDQUFBLENBQUMsQ0FBQyxPQUFPLENBQUMsR0FBRyxDQUFDLGtCQUFrQixDQUFDLENBQUEsQ0FBQztRQUNoQyxPQUFPLENBQUMsU0FBUyxDQUFDLEtBQUssQ0FBQyx1REFBdUQsQ0FBQyxDQUFDO1FBQ2pGLE9BQU8sQ0FBQyxJQUFJLENBQUMsQ0FBQyxDQUFDLENBQUM7SUFDcEIsQ0FBQztJQUNELE9BQU8sQ0FBQyxPQUFPLENBQUMsSUFBSSxDQUFDLHFDQUFxQyxHQUFHLE9BQU8sQ0FBQyxHQUFHLENBQUMsY0FBYyxHQUFHLEdBQUcsR0FBRyxxQkFBcUIsQ0FBQyxDQUFDLENBQUMsdUNBQXVDO0lBQy9KLElBQUksc0JBQXNCLEdBQUcsV0FBVyxDQUFDLElBQUksQ0FBQyxPQUFPLENBQUMsR0FBRyxDQUFDLGtCQUFrQixDQUFDLENBQUM7SUFDOUUsSUFBSSxRQUFRLEdBQUcsc0JBQXNCLENBQUMsQ0FBQyxDQUFDLENBQUM7SUFDekMsSUFBSSxRQUFRLEdBQUcsc0JBQXNCLENBQUMsQ0FBQyxDQUFDLENBQUM7SUFDekMsT0FBTyxDQUFDLE9BQU8sQ0FBQyxJQUFJLENBQUMsa0JBQWtCLEdBQUcsUUFBUSxHQUFHLE1BQU0sR0FBRyxRQUFRLENBQUMsQ0FBQztJQUN4RSxJQUFJLENBQUMsT0FBTyxFQUFFLENBQUM7SUFDZixNQUFNLENBQUMsSUFBSSxDQUFDLE9BQU8sQ0FBQztBQUN4QixDQUFDLENBQUE7QUFFRDs7R0FFRztBQUNILElBQUksWUFBWSxHQUFHO0lBQ2YsSUFBSSxJQUFJLEdBQUcsT0FBTyxDQUFDLENBQUMsQ0FBQyxLQUFLLEVBQUUsQ0FBQztJQUM3QixHQUFHLENBQUMsaUJBQWlCLENBQUMscUJBQXFCLENBQUMsQ0FBQztJQUM3QyxPQUFPLENBQUMsT0FBTyxDQUFDLElBQUksQ0FBQyxxQ0FBcUMsR0FBRyxPQUFPLENBQUMsR0FBRyxDQUFDLGNBQWMsR0FBRyxHQUFHLEdBQUcscUJBQXFCLENBQUMsQ0FBQztJQUN2SCxJQUFJLENBQUMsT0FBTyxFQUFFLENBQUM7SUFDZixNQUFNLENBQUMsSUFBSSxDQUFDLE9BQU8sQ0FBQztBQUN4QixDQUFDLENBQUE7QUFFRDs7R0FFRztBQUNILElBQUksR0FBRyxHQUFHO0lBQ04sSUFBSSxJQUFJLEdBQUcsT0FBTyxDQUFDLENBQUMsQ0FBQyxLQUFLLEVBQUUsQ0FBQztJQUM3QixTQUFTLENBQUMsR0FBRyxFQUFFO1NBQ1YsSUFBSSxDQUFDLElBQUksQ0FBQyxPQUFPLENBQUMsQ0FBQztJQUN4QixNQUFNLENBQUMsSUFBSSxDQUFDLE9BQU8sQ0FBQztBQUN4QixDQUFDLENBQUM7QUFFRjs7O0dBR0c7QUFDUSxlQUFPLEdBQUcsVUFBUyxVQUF1QjtJQUNqRCxNQUFNLENBQUMsQ0FBQyxVQUFVLENBQUMsQ0FBQyxDQUFDO1FBQ2pCLEtBQUssS0FBSztZQUNOLE1BQU0sQ0FBQyxHQUFHLEVBQUUsQ0FBQztRQUNqQixLQUFLLFFBQVE7WUFDVCxNQUFNLENBQUMsTUFBTSxFQUFFLENBQUM7UUFDcEIsS0FBSyxlQUFlO1lBQ2hCLE1BQU0sQ0FBQyxZQUFZLEVBQUUsQ0FBQztRQUMxQixLQUFLLEtBQUs7WUFDTixNQUFNLENBQUMsR0FBRyxFQUFFLENBQUM7UUFDakI7WUFDSSxLQUFLLENBQUM7SUFDZCxDQUFDO0FBQ0wsQ0FBQyxDQUFBIn0=

dist/npmci.publish.d.ts

@@ -1,4 +1,12 @@
 /// <reference types="q" />
 import "typings-global";
 import * as plugins from "./npmci.plugins";
-export declare let publish: (serviceArg?: string) => plugins.q.Promise<{}>;
+/**
+ * type of supported services
+ */
+export declare type TPubService = "npm" | "docker";
+/**
+ * the main exported publish function.
+ * @param pubServiceArg references targeted service to publish to
+ */
+export declare let publish: (pubServiceArg?: TPubService) => plugins.q.Promise<{}>;

dist/npmci.publish.js

@@ -4,14 +4,21 @@ const plugins = require("./npmci.plugins");
 const npmci_prepare_1 = require("./npmci.prepare");
 const npmci_bash_1 = require("./npmci.bash");
 const NpmciBuildDocker = require("./npmci.build.docker");
-exports.publish = (serviceArg = "npm") => {
-    switch (serviceArg) {
+/**
+ * the main exported publish function.
+ * @param pubServiceArg references targeted service to publish to
+ */
+exports.publish = (pubServiceArg = "npm") => {
+    switch (pubServiceArg) {
         case "npm":
             return publishNpm();
         case "docker":
             return publishDocker();
     }
 };
+/**
+ * tries to publish current cwd to NPM registry
+ */
 let publishNpm = function () {
     let done = plugins.q.defer();
     npmci_prepare_1.prepare("npm")
@@ -22,6 +29,9 @@ let publishNpm = function () {
     });
     return done.promise;
 };
+/**
+ * tries to pubish current cwd to Docker registry
+ */
 let publishDocker = function () {
     let done = plugins.q.defer();
     NpmciBuildDocker.readDockerfiles()
@@ -30,4 +40,4 @@ let publishDocker = function () {
         .then(done.resolve);
     return done.promise;
 };
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoibnBtY2kucHVibGlzaC5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uL3RzL25wbWNpLnB1Ymxpc2gudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IjtBQUFBLFFBQU8sZ0JBQWdCLENBQUMsQ0FBQTtBQUN4QixNQUFZLE9BQU8sV0FBTSxpQkFBaUIsQ0FBQyxDQUFBO0FBQzNDLGdDQUFzQixpQkFBaUIsQ0FBQyxDQUFBO0FBQ3hDLDZCQUFtQixjQUFjLENBQUMsQ0FBQTtBQUVsQyxNQUFZLGdCQUFnQixXQUFNLHNCQUVsQyxDQUFDLENBRnVEO0FBRTdDLGVBQU8sR0FBRyxDQUFDLFVBQVUsR0FBVSxLQUFLO0lBQzNDLE1BQU0sQ0FBQyxDQUFDLFVBQVUsQ0FBQyxDQUFBLENBQUM7UUFDaEIsS0FBSyxLQUFLO1lBQ04sTUFBTSxDQUFDLFVBQVUsRUFBRSxDQUFDO1FBQ3hCLEtBQUssUUFBUTtZQUNULE1BQU0sQ0FBQyxhQUFhLEVBQUUsQ0FBQztJQUMvQixDQUFDO0FBQ0wsQ0FBQyxDQUFDO0FBRUYsSUFBSSxVQUFVLEdBQUk7SUFDZCxJQUFJLElBQUksR0FBRyxPQUFPLENBQUMsQ0FBQyxDQUFDLEtBQUssRUFBRSxDQUFDO0lBQzdCLHVCQUFPLENBQUMsS0FBSyxDQUFDO1NBQ1QsSUFBSSxDQUFDO1FBQ0YsaUJBQUksQ0FBQyxhQUFhLENBQUMsQ0FBQztRQUNwQixPQUFPLENBQUMsU0FBUyxDQUFDLEVBQUUsQ0FBQyxPQUFPLENBQUMsQ0FBRTtRQUMvQixJQUFJLENBQUMsT0FBTyxFQUFFLENBQUM7SUFDbkIsQ0FBQyxDQUFDLENBQUM7SUFDUixNQUFNLENBQUMsSUFBSSxDQUFDLE9BQU8sQ0FBQztBQUN2QixDQUFDLENBQUE7QUFFRCxJQUFJLGFBQWEsR0FBRztJQUNoQixJQUFJLElBQUksR0FBRyxPQUFPLENBQUMsQ0FBQyxDQUFDLEtBQUssRUFBRSxDQUFDO0lBQ3pCLGdCQUFnQixDQUFDLGVBQWUsRUFBRTtTQUNqQyxJQUFJLENBQUMsZ0JBQWdCLENBQUMsb0JBQW9CLENBQUM7U0FDM0MsSUFBSSxDQUFDLGdCQUFnQixDQUFDLGVBQWUsQ0FBQztTQUN0QyxJQUFJLENBQUMsSUFBSSxDQUFDLE9BQU8sQ0FBQyxDQUFDO0lBQ3hCLE1BQU0sQ0FBQyxJQUFJLENBQUMsT0FBTyxDQUFDO0FBQ3hCLENBQUMsQ0FBQyJ9
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoibnBtY2kucHVibGlzaC5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uL3RzL25wbWNpLnB1Ymxpc2gudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IjtBQUFBLFFBQU8sZ0JBQWdCLENBQUMsQ0FBQTtBQUN4QixNQUFZLE9BQU8sV0FBTSxpQkFBaUIsQ0FBQyxDQUFBO0FBQzNDLGdDQUFzQixpQkFBaUIsQ0FBQyxDQUFBO0FBQ3hDLDZCQUFtQixjQUFjLENBQUMsQ0FBQTtBQUVsQyxNQUFZLGdCQUFnQixXQUFNLHNCQUtsQyxDQUFDLENBTHVEO0FBT3hEOzs7R0FHRztBQUNRLGVBQU8sR0FBRyxDQUFDLGFBQWEsR0FBZSxLQUFLO0lBQ25ELE1BQU0sQ0FBQyxDQUFDLGFBQWEsQ0FBQyxDQUFBLENBQUM7UUFDbkIsS0FBSyxLQUFLO1lBQ04sTUFBTSxDQUFDLFVBQVUsRUFBRSxDQUFDO1FBQ3hCLEtBQUssUUFBUTtZQUNULE1BQU0sQ0FBQyxhQUFhLEVBQUUsQ0FBQztJQUMvQixDQUFDO0FBQ0wsQ0FBQyxDQUFDO0FBRUY7O0dBRUc7QUFDSCxJQUFJLFVBQVUsR0FBSTtJQUNkLElBQUksSUFBSSxHQUFHLE9BQU8sQ0FBQyxDQUFDLENBQUMsS0FBSyxFQUFFLENBQUM7SUFDN0IsdUJBQU8sQ0FBQyxLQUFLLENBQUM7U0FDVCxJQUFJLENBQUM7UUFDRixpQkFBSSxDQUFDLGFBQWEsQ0FBQyxDQUFDO1FBQ3BCLE9BQU8sQ0FBQyxTQUFTLENBQUMsRUFBRSxDQUFDLE9BQU8sQ0FBQyxDQUFFO1FBQy9CLElBQUksQ0FBQyxPQUFPLEVBQUUsQ0FBQztJQUNuQixDQUFDLENBQUMsQ0FBQztJQUNSLE1BQU0sQ0FBQyxJQUFJLENBQUMsT0FBTyxDQUFDO0FBQ3ZCLENBQUMsQ0FBQTtBQUVEOztHQUVHO0FBQ0gsSUFBSSxhQUFhLEdBQUc7SUFDaEIsSUFBSSxJQUFJLEdBQUcsT0FBTyxDQUFDLENBQUMsQ0FBQyxLQUFLLEVBQUUsQ0FBQztJQUN6QixnQkFBZ0IsQ0FBQyxlQUFlLEVBQUU7U0FDakMsSUFBSSxDQUFDLGdCQUFnQixDQUFDLG9CQUFvQixDQUFDO1NBQzNDLElBQUksQ0FBQyxnQkFBZ0IsQ0FBQyxlQUFlLENBQUM7U0FDdEMsSUFBSSxDQUFDLElBQUksQ0FBQyxPQUFPLENBQUMsQ0FBQztJQUN4QixNQUFNLENBQUMsSUFBSSxDQUFDLE9BQU8sQ0FBQztBQUN4QixDQUFDLENBQUMifQ==

dist/npmci.servezone.d.ts

@@ -0,0 +1,4 @@
+/**
+ * the main run function to submit a service to a servezone
+ */
+export declare let run: (configArg: any) => void;

dist/npmci.servezone.js

@@ -0,0 +1,28 @@
+"use strict";
+const plugins = require("./npmci.plugins");
+/**
+ * servezoneRegex is the regex that parses the servezone connection data
+ * parses strings in the form of "servezone.example.com|3000|somepassword"
+ */
+let servezoneRegex = /^(.*)\|(.*)\|(.*)/;
+/**
+ * holds the results of the parsed servezone env string
+ */
+let servezoneRegexResultArray = servezoneRegex.exec(process.env.NPMCI_SERVEZONE);
+/**
+ * the data object that is used for the smartsocket client object
+ */
+let smartsocketClientConstructorOptions = {
+    alias: "npmci",
+    password: servezoneRegexResultArray[3],
+    port: parseInt(servezoneRegexResultArray[2]),
+    role: "ci",
+    url: servezoneRegexResultArray[1]
+};
+/**
+ * the main run function to submit a service to a servezone
+ */
+exports.run = (configArg) => {
+    new plugins.smartsocket.SmartsocketClient(smartsocketClientConstructorOptions);
+};
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoibnBtY2kuc2VydmV6b25lLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vdHMvbnBtY2kuc2VydmV6b25lLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiI7QUFBQSxNQUFZLE9BQU8sV0FBTSxpQkFBaUIsQ0FBQyxDQUFBO0FBRTNDOzs7R0FHRztBQUNILElBQUksY0FBYyxHQUFHLG1CQUFtQixDQUFDO0FBRXpDOztHQUVHO0FBQ0gsSUFBSSx5QkFBeUIsR0FBRyxjQUFjLENBQUMsSUFBSSxDQUFDLE9BQU8sQ0FBQyxHQUFHLENBQUMsZUFBZSxDQUFDLENBQUM7QUFFakY7O0dBRUc7QUFDSCxJQUFJLG1DQUFtQyxHQUFHO0lBQ3RDLEtBQUssRUFBRSxPQUFPO0lBQ2QsUUFBUSxFQUFFLHlCQUF5QixDQUFDLENBQUMsQ0FBQztJQUN0QyxJQUFJLEVBQUUsUUFBUSxDQUFDLHlCQUF5QixDQUFDLENBQUMsQ0FBQyxDQUFDO0lBQzVDLElBQUksRUFBRSxJQUFJO0lBQ1YsR0FBRyxFQUFFLHlCQUF5QixDQUFDLENBQUMsQ0FBQztDQUNwQyxDQUFDO0FBRUY7O0dBRUc7QUFDUSxXQUFHLEdBQUcsQ0FBQyxTQUFTO0lBQ3ZCLElBQUksT0FBTyxDQUFDLFdBQVcsQ0FBQyxpQkFBaUIsQ0FDckMsbUNBQW1DLENBQ3RDLENBQUM7QUFDTixDQUFDLENBQUMifQ==

dist/npmci.ssh.d.ts

@@ -1,4 +1,7 @@
 /// <reference types="q" />
 import "typings-global";
 import * as plugins from "./npmci.plugins";
+/**
+ * checks for ENV vars in form of NPMCI_SSHKEY_* and deploys any found ones
+ */
 export declare let ssh: () => plugins.q.Promise<{}>;

dist/npmci.ssh.js

@@ -3,9 +3,12 @@ require("typings-global");
 const plugins = require("./npmci.plugins");
 let sshRegex = /^(.*)\|(.*)\|(.*)/;
 let sshInstance;
+/**
+ * checks for ENV vars in form of NPMCI_SSHKEY_* and deploys any found ones
+ */
 exports.ssh = () => {
     let done = plugins.q.defer();
-    sshInstance = new plugins.smartssh.SshInstance();
+    sshInstance = new plugins.smartssh.SshInstance(); // init ssh instance
     plugins.smartparam.forEachMinimatch(process.env, "NPMCI_SSHKEY_*", evaluateSshEnv);
     if (!process.env.NPMTS_TEST) {
         sshInstance.writeToDisk();
@@ -17,6 +20,9 @@ exports.ssh = () => {
     done.resolve();
     return done.promise;
 };
+/**
+ * gets called for each found SSH ENV Var and deploys it
+ */
 let evaluateSshEnv = (sshkeyEnvVarArg) => {
     let resultArray = sshRegex.exec(sshkeyEnvVarArg);
     let sshKey = new plugins.smartssh.SshKey();
@@ -37,7 +43,10 @@ let evaluateSshEnv = (sshkeyEnvVarArg) => {
     ;
     sshInstance.addKey(sshKey);
 };
+/**
+ * checks if not undefined
+ */
 let notUndefined = (stringArg) => {
     return (stringArg && stringArg != "undefined" && stringArg != "##");
 };
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoibnBtY2kuc3NoLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vdHMvbnBtY2kuc3NoLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiI7QUFBQSxRQUFPLGdCQUFnQixDQUFDLENBQUE7QUFDeEIsTUFBWSxPQUFPLFdBQU0saUJBQWlCLENBQUMsQ0FBQTtBQUUzQyxJQUFJLFFBQVEsR0FBRyxtQkFBbUIsQ0FBQTtBQUNsQyxJQUFJLFdBQXdDLENBQUM7QUFFbEMsV0FBRyxHQUFHO0lBQ2IsSUFBSSxJQUFJLEdBQUcsT0FBTyxDQUFDLENBQUMsQ0FBQyxLQUFLLEVBQUUsQ0FBQztJQUM3QixXQUFXLEdBQUcsSUFBSSxPQUFPLENBQUMsUUFBUSxDQUFDLFdBQVcsRUFBRSxDQUFDO0lBQ2pELE9BQU8sQ0FBQyxVQUFVLENBQUMsZ0JBQWdCLENBQUMsT0FBTyxDQUFDLEdBQUcsRUFBQyxnQkFBZ0IsRUFBQyxjQUFjLENBQUMsQ0FBQztJQUNqRixFQUFFLENBQUEsQ0FBQyxDQUFDLE9BQU8sQ0FBQyxHQUFHLENBQUMsVUFBVSxDQUFDLENBQUEsQ0FBQztRQUN4QixXQUFXLENBQUMsV0FBVyxFQUFFLENBQUE7SUFDN0IsQ0FBQztJQUFDLElBQUksQ0FBQyxDQUFDO1FBQ0osT0FBTyxDQUFDLFNBQVMsQ0FBQyxHQUFHLENBQUMsZ0RBQWdELENBQUMsQ0FBQztJQUM1RSxDQUFDO0lBQUEsQ0FBQztJQUNGLElBQUksQ0FBQyxPQUFPLEVBQUUsQ0FBQztJQUNmLE1BQU0sQ0FBQyxJQUFJLENBQUMsT0FBTyxDQUFDO0FBQ3hCLENBQUMsQ0FBQztBQUVGLElBQUksY0FBYyxHQUFHLENBQUMsZUFBZTtJQUNqQyxJQUFJLFdBQVcsR0FBRyxRQUFRLENBQUMsSUFBSSxDQUFDLGVBQWUsQ0FBQyxDQUFDO0lBQ2pELElBQUksTUFBTSxHQUFHLElBQUksT0FBTyxDQUFDLFFBQVEsQ0FBQyxNQUFNLEVBQUUsQ0FBQztJQUMzQyxPQUFPLENBQUMsU0FBUyxDQUFDLElBQUksQ0FBQyx5QkFBeUIsR0FBRyxXQUFXLENBQUMsQ0FBQyxDQUFDLENBQUMsQ0FBQztJQUNuRSxFQUFFLENBQUEsQ0FBQyxZQUFZLENBQUMsV0FBVyxDQUFDLENBQUMsQ0FBQyxDQUFDLENBQUMsQ0FBQSxDQUFDO1FBQzdCLE9BQU8sQ0FBQyxTQUFTLENBQUMsR0FBRyxDQUFDLG9CQUFvQixDQUFDLENBQUE7UUFDM0MsTUFBTSxDQUFDLElBQUksR0FBRyxXQUFXLENBQUMsQ0FBQyxDQUFDLENBQUM7SUFDakMsQ0FBQztJQUNELEVBQUUsQ0FBQSxDQUFDLFlBQVksQ0FBQyxXQUFXLENBQUMsQ0FBQyxDQUFDLENBQUMsQ0FBQyxDQUFBLENBQUM7UUFDN0IsT0FBTyxDQUFDLFNBQVMsQ0FBQyxHQUFHLENBQUMsdUJBQXVCLENBQUMsQ0FBQTtRQUM5QyxNQUFNLENBQUMsYUFBYSxHQUFHLFdBQVcsQ0FBQyxDQUFDLENBQUMsQ0FBQztJQUMxQyxDQUFDO0lBQUEsQ0FBQztJQUNGLEVBQUUsQ0FBQSxDQUFDLFlBQVksQ0FBQyxXQUFXLENBQUMsQ0FBQyxDQUFDLENBQUMsQ0FBQyxDQUFBLENBQUM7UUFDN0Isc0JBQXNCLENBQUE7UUFDdEIsTUFBTSxDQUFDLFlBQVksR0FBRyxXQUFXLENBQUMsQ0FBQyxDQUFDLENBQUM7SUFDekMsQ0FBQztJQUFBLENBQUM7SUFFRixXQUFXLENBQUMsTUFBTSxDQUFDLE1BQU0sQ0FBQyxDQUFDO0FBQy9CLENBQUMsQ0FBQztBQUVGLElBQUksWUFBWSxHQUFHLENBQUMsU0FBZ0I7SUFDaEMsTUFBTSxDQUFDLENBQUMsU0FBUyxJQUFJLFNBQVMsSUFBSSxXQUFXLElBQUksU0FBUyxJQUFJLElBQUksQ0FBQyxDQUFDO0FBQ3hFLENBQUMsQ0FBQSJ9
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoibnBtY2kuc3NoLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vdHMvbnBtY2kuc3NoLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiI7QUFBQSxRQUFPLGdCQUFnQixDQUFDLENBQUE7QUFDeEIsTUFBWSxPQUFPLFdBQU0saUJBQWlCLENBQUMsQ0FBQTtBQUUzQyxJQUFJLFFBQVEsR0FBRyxtQkFBbUIsQ0FBQTtBQUNsQyxJQUFJLFdBQXdDLENBQUM7QUFFN0M7O0dBRUc7QUFDUSxXQUFHLEdBQUc7SUFDYixJQUFJLElBQUksR0FBRyxPQUFPLENBQUMsQ0FBQyxDQUFDLEtBQUssRUFBRSxDQUFDO0lBQzdCLFdBQVcsR0FBRyxJQUFJLE9BQU8sQ0FBQyxRQUFRLENBQUMsV0FBVyxFQUFFLENBQUMsQ0FBQyxvQkFBb0I7SUFDdEUsT0FBTyxDQUFDLFVBQVUsQ0FBQyxnQkFBZ0IsQ0FBQyxPQUFPLENBQUMsR0FBRyxFQUFDLGdCQUFnQixFQUFDLGNBQWMsQ0FBQyxDQUFDO0lBQ2pGLEVBQUUsQ0FBQSxDQUFDLENBQUMsT0FBTyxDQUFDLEdBQUcsQ0FBQyxVQUFVLENBQUMsQ0FBQSxDQUFDO1FBQ3hCLFdBQVcsQ0FBQyxXQUFXLEVBQUUsQ0FBQztJQUM5QixDQUFDO0lBQUMsSUFBSSxDQUFDLENBQUM7UUFDSixPQUFPLENBQUMsU0FBUyxDQUFDLEdBQUcsQ0FBQyxnREFBZ0QsQ0FBQyxDQUFDO0lBQzVFLENBQUM7SUFBQSxDQUFDO0lBQ0YsSUFBSSxDQUFDLE9BQU8sRUFBRSxDQUFDO0lBQ2YsTUFBTSxDQUFDLElBQUksQ0FBQyxPQUFPLENBQUM7QUFDeEIsQ0FBQyxDQUFDO0FBRUY7O0dBRUc7QUFDSCxJQUFJLGNBQWMsR0FBRyxDQUFDLGVBQWU7SUFDakMsSUFBSSxXQUFXLEdBQUcsUUFBUSxDQUFDLElBQUksQ0FBQyxlQUFlLENBQUMsQ0FBQztJQUNqRCxJQUFJLE1BQU0sR0FBRyxJQUFJLE9BQU8sQ0FBQyxRQUFRLENBQUMsTUFBTSxFQUFFLENBQUM7SUFDM0MsT0FBTyxDQUFDLFNBQVMsQ0FBQyxJQUFJLENBQUMseUJBQXlCLEdBQUcsV0FBVyxDQUFDLENBQUMsQ0FBQyxDQUFDLENBQUM7SUFDbkUsRUFBRSxDQUFBLENBQUMsWUFBWSxDQUFDLFdBQVcsQ0FBQyxDQUFDLENBQUMsQ0FBQyxDQUFDLENBQUEsQ0FBQztRQUM3QixPQUFPLENBQUMsU0FBUyxDQUFDLEdBQUcsQ0FBQyxvQkFBb0IsQ0FBQyxDQUFBO1FBQzNDLE1BQU0sQ0FBQyxJQUFJLEdBQUcsV0FBVyxDQUFDLENBQUMsQ0FBQyxDQUFDO0lBQ2pDLENBQUM7SUFDRCxFQUFFLENBQUEsQ0FBQyxZQUFZLENBQUMsV0FBVyxDQUFDLENBQUMsQ0FBQyxDQUFDLENBQUMsQ0FBQSxDQUFDO1FBQzdCLE9BQU8sQ0FBQyxTQUFTLENBQUMsR0FBRyxDQUFDLHVCQUF1QixDQUFDLENBQUE7UUFDOUMsTUFBTSxDQUFDLGFBQWEsR0FBRyxXQUFXLENBQUMsQ0FBQyxDQUFDLENBQUM7SUFDMUMsQ0FBQztJQUFBLENBQUM7SUFDRixFQUFFLENBQUEsQ0FBQyxZQUFZLENBQUMsV0FBVyxDQUFDLENBQUMsQ0FBQyxDQUFDLENBQUMsQ0FBQSxDQUFDO1FBQzdCLHNCQUFzQixDQUFBO1FBQ3RCLE1BQU0sQ0FBQyxZQUFZLEdBQUcsV0FBVyxDQUFDLENBQUMsQ0FBQyxDQUFDO0lBQ3pDLENBQUM7SUFBQSxDQUFDO0lBRUYsV0FBVyxDQUFDLE1BQU0sQ0FBQyxNQUFNLENBQUMsQ0FBQztBQUMvQixDQUFDLENBQUM7QUFFRjs7R0FFRztBQUNILElBQUksWUFBWSxHQUFHLENBQUMsU0FBZ0I7SUFDaEMsTUFBTSxDQUFDLENBQUMsU0FBUyxJQUFJLFNBQVMsSUFBSSxXQUFXLElBQUksU0FBUyxJQUFJLElBQUksQ0FBQyxDQUFDO0FBQ3hFLENBQUMsQ0FBQSJ9

docs/book.json

@@ -0,0 +1,15 @@
+{
+    "structure": {
+        "readme": "index.md"
+    },
+    "plugins": [
+        "tonic",
+        "edit-link"
+    ],
+    "pluginsConfig": {
+        "edit-link": {
+            "base": "https://gitlab.com/pushrocks/npmts/edit/master/docs/",
+            "label": "Edit on GitLab"
+        }
+    }
+}

docs/index.md

@@ -0,0 +1,66 @@
+# NPMCI
+npmci is your friend when it comes to handling npm packages during CI builds. It is optimized for GitLab CI
+
+## Availabililty
+[![npm](https://push.rocks/assets/repo-button-npm.svg)](https://www.npmjs.com/package/npmci)
+[![git](https://push.rocks/assets/repo-button-git.svg)](https://gitlab.com/pushrocks/npmci)
+[![git](https://push.rocks/assets/repo-button-mirror.svg)](https://github.com/pushrocks/npmci)
+[![docs](https://push.rocks/assets/repo-button-docs.svg)](https://pushrocks.gitlab.io/npmci/docs)
+[![docs](https://push.rocks/assets/repo-button-api.svg)](https://pushrocks.gitlab.io/npmci/api)
+
+## Status for master
+[![build status](https://gitlab.com/pushrocks/npmci/badges/master/build.svg)](https://gitlab.com/pushrocks/npmci/commits/master)
+[![coverage report](https://gitlab.com/pushrocks/npmci/badges/master/coverage.svg)](https://gitlab.com/pushrocks/npmci/commits/master)
+[![Dependency Status](https://david-dm.org/pushrocks/npmci.svg)](https://david-dm.org/pushrocks/npmci)
+[![bitHound Dependencies](https://www.bithound.io/github/pushrocks/npmci/badges/dependencies.svg)](https://www.bithound.io/github/pushrocks/npmci/master/dependencies/npm)
+[![bitHound Code](https://www.bithound.io/github/pushrocks/npmci/badges/code.svg)](https://www.bithound.io/github/pushrocks/npmci)
+[![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/)
+
+## Usage
+npmci is designed to work in docker CI environments. The following docker images come with npmci presinstalled:
+
+Docker Hub:
+
+* [hosttoday/ht-docker-node:npmci](https://hub.docker.com/r/hosttoday/ht-docker-node/)  
+has LTS node version and npmci preinstalled.
+* [hosttoday/ht-docker-dbase](https://hub.docker.com/r/hosttoday/ht-docker-dbase/)  
+based on docker:git, can be used to build docker images in conjunction with docker:dind
+
+npmci can be called from commandline:
+```shell
+# Install any node version:
+npmci install lts # will install latest LTS node version and update PATH for node and npm versions
+npmci install stable # will install latest stable node version and update PATH for node and npm
+npmci install legacy # will install latest legacy node version and update PATH for node and npm
+npmci install x.x.x #  will install any specific node version.
+
+# Install any node version, install dependencies and run test in cwd:
+npmci test lts # will install latest lts node version and run "npm install" and "npm test".
+npmci test stable # will install latest stable node version and run "npm install" and "npm test".
+npmci test legacy # will install latest legacy node version and run "npm install" and "npm test".
+npmci test x.x.x # will install any specific node version and run "npm install" and "npm test".
+npmci test docker # will test any build image with tests defined in ./npmci/dockertest_1.sh to ./npmci/dockertest_100.sh
+## npmci test docker will look at all Dockerfiles and look for according tags on GitLab container registry
+
+
+# prepare tools
+npmci prepare npm # will look for $NPMCI_TOKEN_NPM env var and create .npmrc, so npm is authenticated
+npmci prepare docker # will look for $NPMCI_LOGIN_DOCKER in form username|password and authenticate docker
+npmci prepare docker-gitlab # will authenticate docker for gitlab container registry
+
+# build containers
+npmci build docker # will build containers
+## all Dockerfiles named DOckerfile* are picked up.
+## specify tags lake this Dockerfile_[tag]
+## uploads all built images as [username]/[reponame]:[tag]_test to GitLab
+## then test in next step with "npmci test docker"
+
+# publish npm module
+npmci publish npm # will look vor $NPMCI_TOKEN_NPM env var and push any module in cwd to npm
+npmci publish docker
+
+# trigger webhooks
+npmci trigger # will look for NPMCI_TRIGGER_1 to NPMCI_TRIGGER_100 in form domain|id|token|ref|name  
+```
+

package.json

@@ -1,6 +1,6 @@
 {
   "name": "npmci",
-  "version": "2.3.14",
+  "version": "2.3.16",
   "description": "",
   "main": "dist/index.js",
   "typings": "dist/index.d.ts",
@@ -23,28 +23,29 @@
   "homepage": "https://gitlab.com/pushrocks/npmci#README",
   "devDependencies": {
     "npmts-g": "^5.2.8",
-    "should": "^10.0.0",
-    "typings-test": "^1.0.1"
+    "should": "^11.1.0",
+    "typings-test": "^1.0.2"
   },
   "dependencies": {
-    "@types/lodash": "^0.0.28",
-    "@types/q": "^0.0.27",
-    "@types/request": "^0.0.27",
-    "@types/shelljs": "^0.3.27",
-    "beautylog": "^5.0.18",
+    "@types/lodash": "^4.14.34",
+    "@types/q": "0.x.x",
+    "@types/request": "0.x.x",
+    "@types/shelljs": "^0.3.30",
+    "beautylog": "^5.0.23",
     "gulp": "^3.9.1",
     "gulp-function": "^1.3.6",
-    "lodash": "^4.14.1",
+    "lodash": "^4.15.0",
     "projectinfo": "^1.0.3",
     "q": "^1.4.1",
     "request": "^2.74.0",
-    "shelljs": "^0.7.3",
-    "smartcli": "^1.0.4",
-    "smartfile": "^4.0.12",
+    "shelljs": "^0.7.4",
+    "smartcli": "^1.0.9",
+    "smartfile": "^4.0.15",
     "smartparam": "^0.1.1",
+    "smartsocket": "^1.1.4",
     "smartssh": "^1.1.5",
-    "smartstring": "^2.0.15",
+    "smartstring": "^2.0.17",
     "through2": "^2.0.1",
-    "typings-global": "^1.0.6"
+    "typings-global": "^1.0.14"
   }
 }

ts/npmci.bash.ts

@@ -40,7 +40,7 @@ export let bash = (commandArg: string, retryArg = 2, bareArg = false) => {
             }
         }
     } else {
-        plugins.beautylog.log("ShellExec would be: " + commandArg.blue)
+        plugins.beautylog.log("ShellExec would be: " + commandArg)
     }
     return stdOut;
 }

ts/npmci.build.docker.ts

@@ -3,6 +3,9 @@ import * as paths from "./npmci.paths";
 import * as NpmciEnv from "./npmci.env";
 import {bashBare} from "./npmci.bash";
 
+/**
+ * builds a cwd of Dockerfiles by triggering a promisechain
+ */
 export let build = function(){
     let done = plugins.q.defer();
     readDockerfiles()
@@ -16,8 +19,12 @@ export let build = function(){
     return done.promise;
 }
 
-export let readDockerfiles = function(){
-    let done = plugins.q.defer();
+/**
+ * creates instance of class Dockerfile for all Dockerfiles in cwd
+ * @returns Promise<Dockerfile[]>
+ */
+export let readDockerfiles = function():plugins.q.Promise<Dockerfile[]>{
+    let done = plugins.q.defer<Dockerfile[]>();
     let readDockerfilesArray:Dockerfile[] = []
     plugins.gulp.src("./Dockerfile*")
         .pipe(plugins.through2.obj(function(file,enc,cb){
@@ -33,8 +40,13 @@ export let readDockerfiles = function(){
     return done.promise;
 }
 
-export let sortDockerfiles = function(sortableArrayArg:Dockerfile[]){
-    let done = plugins.q.defer();
+/**
+ * sorts Dockerfiles into a dependency chain
+ * @param sortableArrayArg an array of instances of class Dockerfile
+ * @returns Promise<Dockerfile[]>
+ */
+export let sortDockerfiles = function(sortableArrayArg:Dockerfile[]):plugins.q.Promise<Dockerfile[]>{
+    let done = plugins.q.defer<Dockerfile[]>();
     let sortedArray:Dockerfile[] = [];
     let cleanTagsOriginal = cleanTagsArrayFunction(sortableArrayArg,sortedArray);
     let sorterFunctionCounter:number = 0;
@@ -59,8 +71,11 @@ export let sortDockerfiles = function(sortableArrayArg:Dockerfile[]){
     return done.promise;
 };
 
-export let mapDockerfiles = function(sortedArray:Dockerfile[]){
-    let done = plugins.q.defer();
+/**
+ * maps local Dockerfiles dependencies to the correspoding Dockerfile class instances
+ */
+export let mapDockerfiles = function(sortedArray:Dockerfile[]):plugins.q.Promise<Dockerfile[]>{
+    let done = plugins.q.defer<Dockerfile[]>();
     sortedArray.forEach((dockerfileArg) => {
         if(dockerfileArg.localBaseImageDependent){
             sortedArray.forEach((dockfile2:Dockerfile) => {
@@ -74,6 +89,9 @@ export let mapDockerfiles = function(sortedArray:Dockerfile[]){
     return done.promise;
 }
 
+/**
+ * builds the correspoding real docker image for each Dockerfile class instance
+ */
 export let buildDockerfiles = (sortedArrayArg:Dockerfile[]) => {
     let done = plugins.q.defer();
     sortedArrayArg.forEach(function(dockerfileArg){
@@ -83,6 +101,9 @@ export let buildDockerfiles = (sortedArrayArg:Dockerfile[]) => {
     return done.promise;
 }
 
+/**
+ * pushes the real Dockerfile images to a Docker registry
+ */
 export let pushDockerfiles = function(sortedArrayArg:Dockerfile[]){
     let done = plugins.q.defer();
     sortedArrayArg.forEach(function(dockerfileArg){
@@ -92,6 +113,10 @@ export let pushDockerfiles = function(sortedArrayArg:Dockerfile[]){
     return done.promise;
 }
 
+/**
+ * pulls corresponding real Docker images for instances of Dockerfile from a registry.
+ * This is needed if building, testing, and publishing of Docker images is carried out in seperate CI stages.
+ */
 export let pullDockerfileImages = (sortableArrayArg:Dockerfile[],registryArg = "registry.gitlab.com") => {
     let done = plugins.q.defer();
     sortableArrayArg.forEach((dockerfileArg) => {
@@ -101,6 +126,10 @@ export let pullDockerfileImages = (sortableArrayArg:Dockerfile[],registryArg = "
     return done.promise;
 }
 
+/**
+ * tests all Dockerfiles in by calling class Dockerfile.test();
+ * @param sortedArrayArg Dockerfile[] that contains all Dockerfiles in cwd
+ */
 export let testDockerfiles = (sortedArrayArg:Dockerfile[]) => {
     let done = plugins.q.defer();
     sortedArrayArg.forEach(function(dockerfileArg){
@@ -110,6 +139,9 @@ export let testDockerfiles = (sortedArrayArg:Dockerfile[]) => {
     return done.promise;
 };
 
+/**
+ * class Dockerfile represents a Dockerfile on disk in npmci
+ */
 export class Dockerfile {
     filePath:string;
     repo:string;
@@ -138,6 +170,10 @@ export class Dockerfile {
         this.baseImage = dockerBaseImage(this.content);
         this.localBaseImageDependent = false;
     };
+
+    /**
+     * builds the Dockerfile
+     */
     build(){
         let done = plugins.q.defer();
         plugins.beautylog.info("now building Dockerfile for " + this.cleanTag);
@@ -146,6 +182,10 @@ export class Dockerfile {
         done.resolve();
         return done.promise;
     };
+
+    /**
+     * pushes the Dockerfile to a registry
+     */
     push(stageArg){
         let done = plugins.q.defer();
         let pushTag;
@@ -162,12 +202,20 @@ export class Dockerfile {
         bashBare("docker push " + pushTag);
         done.resolve();
         return done.promise;
-    }
+    };
+
+    /**
+     * pulls the Dockerfile from a registry
+     */
     pull(registryArg:string){
         let pullTag = this.testTag;
         bashBare("docker pull " + pullTag);
         bashBare("docker tag " + pullTag + " " + this.buildTag);
     };
+
+    /**
+     * tests the Dockerfile;
+     */
     test(){
         let testFile:string = plugins.path.join(paths.NpmciTestDir,"test_" + this.version + ".sh");
         let testFileExists:boolean = plugins.smartfile.fs.fileExistsSync(testFile);
@@ -182,12 +230,19 @@ export class Dockerfile {
             plugins.beautylog.warn("skipping tests for " + this.cleanTag + " because no testfile was found!");
         }
     };
+
+    /**
+     * gets the id of a Dockerfile
+     */
     getId(){
         let containerId = bashBare("docker inspect --type=image --format=\"{{.Id}}\" " + this.buildTag);
         return containerId;
     };
 }
 
+/**
+ * 
+ */
 export let dockerFileVersion = function(dockerfileNameArg:string):string{
     let versionString:string;
     let versionRegex = /Dockerfile_([a-zA-Z0-9\.]*)$/;
@@ -200,12 +255,18 @@ export let dockerFileVersion = function(dockerfileNameArg:string):string{
     return versionString;
 }
 
+/**
+ * 
+ */
 export let dockerBaseImage = function(dockerfileContentArg:string){
     let baseImageRegex = /FROM\s([a-zA-z0-9\/\-\:]*)\n?/
     let regexResultArray = baseImageRegex.exec(dockerfileContentArg)
     return regexResultArray[1];
 }
 
+/**
+ * 
+ */
 export let dockerTag = function(registryArg:string,repoArg:string,versionArg:string,suffixArg?:string):string{
     let tagString:string;
     let registry = registryArg;
@@ -218,6 +279,9 @@ export let dockerTag = function(registryArg:string,repoArg:string,versionArg:str
     return tagString;
 };
 
+/**
+ * 
+ */
 export let cleanTagsArrayFunction = function(dockerfileArrayArg:Dockerfile[],trackingArrayArg:Dockerfile[]):string[]{
     let cleanTagsArray:string[] = [];
     dockerfileArrayArg.forEach(function(dockerfileArg){

ts/npmci.build.ts

@@ -4,13 +4,22 @@ import {bash} from "./npmci.bash";
 import * as env from "./npmci.env";
 import * as buildDocker from "./npmci.build.docker"
 
-export let build = function(commandArg){
+/**
+ * defines possible build services
+ */
+export type TBuildService = "docker";
+
+/**
+ * builds for a specific service
+ */
+export let build = function(commandArg):plugins.q.Promise<any> {
     switch(commandArg){
         case "docker":
             return buildDocker.build();   
         default:
             plugins.beautylog.log("build target " + commandArg + " not recognised!");
-    }
+    };
+    return;
 }
 
 

ts/npmci.install.ts

@@ -5,7 +5,7 @@ import { nvmAvailable } from "./npmci.bash"
 
 export let install = (versionArg) => {
     let done = plugins.q.defer();
-    plugins.beautylog.log("now installing " + "node ".green + ("version " + versionArg).yellow);
+    plugins.beautylog.log(`now installing node version ${versionArg}`);
     let version: string;
     if (versionArg == "stable") {
         version = "6.3.0";

ts/npmci.plugins.ts

@@ -11,6 +11,7 @@ export import shelljs = require("shelljs");
 export import smartcli = require("smartcli");
 export import smartfile = require("smartfile");
 export import smartparam = require("smartparam");
+export import smartsocket = require("smartsocket");
 export import smartssh = require("smartssh");
 export import smartstring = require("smartstring");
 export let through2 = require("through2");

ts/npmci.prepare.ts

@@ -4,6 +4,17 @@ import {bash} from "./npmci.bash";
 import * as env from "./npmci.env"
 import * as sshModule from "./npmci.ssh"
 
+
+//types
+
+/**
+ * defines possible prepare services
+ */
+export type TPrepService = "npm" | "docker" | "docker-gitlab" | "ssh";
+
+/**
+ * authenticates npm with token from env var
+ */
 let npm = function(){
     let done = plugins.q.defer();
     
@@ -22,6 +33,9 @@ let npm = function(){
     return done.promise;
 };
 
+/**
+ * logs in docker
+ */
 let docker = function(){
     let done = plugins.q.defer();
     env.setDockerRegistry("docker.io");
@@ -39,6 +53,9 @@ let docker = function(){
     return done.promise;
 }
 
+/**
+ * prepare docker for gitlab registry
+ */
 let dockerGitlab = function(){
     let done = plugins.q.defer();
     env.setDockerRegistry("registry.gitlab.com");
@@ -47,14 +64,21 @@ let dockerGitlab = function(){
     return done.promise;
 }
 
+/**
+ * prepare ssh
+ */
 let ssh = function(){
     let done = plugins.q.defer();
     sshModule.ssh()
         .then(done.resolve);
     return done.promise;
-}
+};
 
-export let prepare = function(serviceArg:string){
+/**
+ * the main exported prepare function
+ * @param servieArg describes the service to prepare
+ */
+export let prepare = function(serviceArg:TPrepService){
     switch (serviceArg) {
         case "npm":
             return npm();

ts/npmci.publish.ts

@@ -5,8 +5,17 @@ import {bash} from "./npmci.bash";
 import * as NpmciEnv from "./npmci.env";
 import * as NpmciBuildDocker from "./npmci.build.docker"
 
-export let publish = (serviceArg:string = "npm") => {
-    switch (serviceArg){
+/**
+ * type of supported services
+ */
+export type TPubService = "npm" | "docker";
+
+/**
+ * the main exported publish function.
+ * @param pubServiceArg references targeted service to publish to 
+ */
+export let publish = (pubServiceArg:TPubService = "npm") => {
+    switch (pubServiceArg){
         case "npm": 
             return publishNpm();
         case "docker":
@@ -14,6 +23,9 @@ export let publish = (serviceArg:string = "npm") => {
     }
 };
 
+/**
+ * tries to publish current cwd to NPM registry
+ */
 let publishNpm  = function(){
     let done = plugins.q.defer();
     prepare("npm")
@@ -25,6 +37,9 @@ let publishNpm  = function(){
    return done.promise;
 }
 
+/**
+ * tries to pubish current cwd to Docker registry
+ */
 let publishDocker = function(){
     let done = plugins.q.defer();
         NpmciBuildDocker.readDockerfiles()

ts/npmci.servezone.ts

@@ -0,0 +1,32 @@
+import * as plugins from "./npmci.plugins";
+
+/**
+ * servezoneRegex is the regex that parses the servezone connection data
+ * parses strings in the form of "servezone.example.com|3000|somepassword"
+ */
+let servezoneRegex = /^(.*)\|(.*)\|(.*)/;
+
+/**
+ * holds the results of the parsed servezone env string
+ */
+let servezoneRegexResultArray = servezoneRegex.exec(process.env.NPMCI_SERVEZONE);
+
+/**
+ * the data object that is used for the smartsocket client object
+ */
+let smartsocketClientConstructorOptions = {
+    alias: "npmci",
+    password: servezoneRegexResultArray[3],
+    port: parseInt(servezoneRegexResultArray[2]),
+    role: "ci",
+    url: servezoneRegexResultArray[1]
+};
+
+/**
+ * the main run function to submit a service to a servezone
+ */
+export let run = (configArg) => {
+    new plugins.smartsocket.SmartsocketClient(
+        smartsocketClientConstructorOptions
+    );
+};

ts/npmci.ssh.ts

@@ -4,12 +4,15 @@ import * as plugins from "./npmci.plugins";
 let sshRegex = /^(.*)\|(.*)\|(.*)/
 let sshInstance:plugins.smartssh.SshInstance;
 
+/**
+ * checks for ENV vars in form of NPMCI_SSHKEY_* and deploys any found ones
+ */
 export let ssh = () => {
     let done = plugins.q.defer();
-    sshInstance = new plugins.smartssh.SshInstance();
+    sshInstance = new plugins.smartssh.SshInstance(); // init ssh instance
     plugins.smartparam.forEachMinimatch(process.env,"NPMCI_SSHKEY_*",evaluateSshEnv);
     if(!process.env.NPMTS_TEST){
-        sshInstance.writeToDisk()
+        sshInstance.writeToDisk();
     } else {
         plugins.beautylog.log("In test mode, so not storing SSH keys to disk!");
     };
@@ -17,6 +20,9 @@ export let ssh = () => {
     return done.promise;
 };
 
+/**
+ * gets called for each found SSH ENV Var and deploys it 
+ */
 let evaluateSshEnv = (sshkeyEnvVarArg) => {
     let resultArray = sshRegex.exec(sshkeyEnvVarArg);
     let sshKey = new plugins.smartssh.SshKey();
@@ -37,6 +43,9 @@ let evaluateSshEnv = (sshkeyEnvVarArg) => {
     sshInstance.addKey(sshKey);
 };
 
+/**
+ * checks if not undefined
+ */
 let notUndefined = (stringArg:string) => {
     return (stringArg && stringArg != "undefined" && stringArg != "##");
 }