fix(structure): formatted, ci updates and new readme

.gitlab-ci.yml

@@ -3,14 +3,14 @@ image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
 
 cache:
   paths:
-  - .npmci_cache/
+    - .npmci_cache/
-  key: "$CI_BUILD_STAGE"
+  key: '$CI_BUILD_STAGE'
 
 stages:
-- security
+  - security
-- test
+  - test
-- release
+  - release
-- metadata
+  - metadata
 
 # ====================
 # security stage
@@ -18,21 +18,23 @@ stages:
 mirror:
   stage: security
   script:
-  - npmci git mirror
+    - npmci git mirror
   tags:
-  - docker
+    - lossless
-  - notpriv
+    - docker
+    - notpriv
 
 snyk:
+  image: registry.gitlab.com/hosttoday/ht-docker-node:snyk
   stage: security
   script:
     - npmci npm prepare
-    - npmci command npm install -g snyk
     - npmci command npm install --ignore-scripts
     - npmci command snyk test
   tags:
-  - docker
+    - lossless
-  - notpriv
+    - docker
+    - notpriv
 
 # ====================
 # test stage
@@ -41,37 +43,40 @@ snyk:
 testStable:
   stage: test
   script:
-  - npmci npm prepare
+    - npmci npm prepare
-  - npmci node install stable
+    - npmci node install stable
-  - npmci npm install
+    - npmci npm install
-  - npmci npm test
+    - npmci npm test
   coverage: /\d+.?\d+?\%\s*coverage/
   tags:
-  - docker
+    - lossless
-  - priv
+    - docker
+    - priv
 
 testBuild:
   stage: test
   script:
-  - npmci npm prepare
+    - npmci npm prepare
-  - npmci node install stable
+    - npmci node install stable
-  - npmci npm install
+    - npmci npm install
-  - npmci command npm run build
+    - npmci command npm run build
   coverage: /\d+.?\d+?\%\s*coverage/
   tags:
-  - docker
+    - lossless
-  - notpriv
+    - docker
+    - notpriv
 
 release:
   stage: release
   script:
-  - npmci node install stable
+    - npmci node install stable
-  - npmci npm publish
+    - npmci npm publish
   only:
-  - tags
+    - tags
   tags:
-  - docker
+    - lossless
-  - notpriv
+    - docker
+    - notpriv
 
 # ====================
 # metadata stage
@@ -81,33 +86,35 @@ codequality:
   allow_failure: true
   script:
     - npmci command npm install -g tslint typescript
+    - npmci npm prepare
     - npmci npm install
     - npmci command "tslint -c tslint.json ./ts/**/*.ts"
   tags:
-  - docker
+    - lossless
-  - priv
+    - docker
+    - priv
 
 trigger:
   stage: metadata
   script:
-  - npmci trigger
+    - npmci trigger
   only:
-  - tags
+    - tags
   tags:
-  - docker
+    - lossless
-  - notpriv
+    - docker
+    - notpriv
 
 pages:
-  image: hosttoday/ht-docker-dbase:npmci
-  services:
-   - docker:stable-dind
   stage: metadata
   script:
+    - npmci node install lts
     - npmci command npm install -g @gitzone/tsdoc
     - npmci npm prepare
     - npmci npm install
     - npmci command tsdoc
   tags:
+    - lossless
     - docker
     - notpriv
   only:
@@ -115,5 +122,5 @@ pages:
   artifacts:
     expire_in: 1 week
     paths:
-    - public
+      - public
   allow_failure: true

README.md

@@ -1,38 +0,0 @@
-# @mojoio/docker
-unofficial docker engine api abstraction package written in TypeScript
-
-## Availabililty and Links
-* [npmjs.org (npm package)](https://www.npmjs.com/package/@mojoio/docker)
-* [gitlab.com (source)](https://gitlab.com/mojoio/docker)
-* [github.com (source mirror)](https://github.com/mojoio/docker)
-* [docs (typedoc)](https://mojoio.gitlab.io/docker/)
-
-## Status for master
-[![build status](https://gitlab.com/mojoio/docker/badges/master/build.svg)](https://gitlab.com/mojoio/docker/commits/master)
-[![coverage report](https://gitlab.com/mojoio/docker/badges/master/coverage.svg)](https://gitlab.com/mojoio/docker/commits/master)
-[![npm downloads per month](https://img.shields.io/npm/dm/@mojoio/docker.svg)](https://www.npmjs.com/package/@mojoio/docker)
-[![Known Vulnerabilities](https://snyk.io/test/npm/@mojoio/docker/badge.svg)](https://snyk.io/test/npm/@mojoio/docker)
-[![TypeScript](https://img.shields.io/badge/TypeScript->=%203.x-blue.svg)](https://nodejs.org/dist/latest-v10.x/docs/api/)
-[![node](https://img.shields.io/badge/node->=%2010.x.x-blue.svg)](https://nodejs.org/dist/latest-v10.x/docs/api/)
-[![JavaScript Style Guide](https://img.shields.io/badge/code%20style-prettier-ff69b4.svg)](https://prettier.io/)
-
-## Usage
-
-Use TypeScript for best in class instellisense.
-
-```typescript
-import { DockerHost } from '@mojoio/docker'; // require Dockersock class
-
-const run = async () => {
-  const myDockerHost = new DockerHost(); // optional: you can pass a domain to the contructor, defaults to  /var/run/docker.sock
-
-  const containers = await myDockerHost.getContainers(); // promise, resolve with an array of DockerContainers
-};
-```
-
-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)
-
-[![repo-footer](https://lossless.gitlab.io/publicrelations/repofooter.svg)](https://maintainedby.lossless.com)

package.json

@@ -49,14 +49,14 @@
     "tslint-config-prettier": "^1.18.0"
   },
   "files": [
-    "ts/*",
+    "ts/**/*",
-    "ts_web/*",
+    "ts_web/**/*",
-    "dist/*",
+    "dist/**/*",
-    "dist_web/*",
+    "dist_web/**/*",
-    "dist_ts_web/*",
+    "dist_ts_web/**/*",
-    "assets/*",
+    "assets/**/*",
     "cli.js",
     "npmextra.json",
     "readme.md"
   ]
-}
+}

ts/docker.classes.network.ts

@@ -92,13 +92,15 @@ export class DockerNetwork {
     const response = await this.dockerHost.request('DELETE', `/networks/${this.Id}`);
   }
 
-  public async getContainersOnNetwork(): Promise<Array<{
+  public async getContainersOnNetwork(): Promise<
+    Array<{
       Name: string;
       EndpointID: string;
       MacAddress: string;
       IPv4Address: string;
       IPv6Address: string;
-    }>> {
+    }>
+  > {
     const returnArray = [];
     const response = await this.dockerHost.request('GET', `/networks/${this.Id}`);
     for (const key of Object.keys(response.body.Containers)) {
@@ -106,7 +108,6 @@ export class DockerNetwork {
     }
 
     return returnArray;
-
   }
 
   public async getContainersOnNetworkForService(serviceArg: DockerService) {

ts/interfaces/service.ts

@@ -13,6 +13,6 @@ export interface IServiceCreationDescriptor {
   ports: string[];
   accessHostDockerSock?: boolean;
   resources?: {
-    memorySizeMB: number
+    memorySizeMB: number;
   };
 }