From b21fe801098bff4c833d0c06911d8c657abf258e Mon Sep 17 00:00:00 2001 From: Phil Kunz Date: Wed, 20 Nov 2019 13:36:03 +0000 Subject: [PATCH] fix(structure): formatted, ci updates and new readme --- .gitlab-ci.yml | 85 +++++++++++++++++++----------------- README.md | 38 ---------------- package.json | 14 +++--- ts/docker.classes.network.ts | 7 +-- ts/interfaces/service.ts | 2 +- 5 files changed, 58 insertions(+), 88 deletions(-) delete mode 100644 README.md diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml index ac532d3..a95dfb6 100644 --- a/.gitlab-ci.yml +++ b/.gitlab-ci.yml @@ -3,14 +3,14 @@ image: registry.gitlab.com/hosttoday/ht-docker-node:npmci cache: paths: - - .npmci_cache/ - key: "$CI_BUILD_STAGE" + - .npmci_cache/ + key: '$CI_BUILD_STAGE' stages: -- security -- test -- release -- metadata + - security + - test + - release + - metadata # ==================== # security stage @@ -18,21 +18,23 @@ stages: mirror: stage: security script: - - npmci git mirror + - npmci git mirror tags: - - docker - - notpriv + - lossless + - 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 - - notpriv + - lossless + - docker + - notpriv # ==================== # test stage @@ -41,37 +43,40 @@ snyk: testStable: stage: test script: - - npmci npm prepare - - npmci node install stable - - npmci npm install - - npmci npm test + - npmci npm prepare + - npmci node install stable + - npmci npm install + - npmci npm test coverage: /\d+.?\d+?\%\s*coverage/ tags: - - docker - - priv + - lossless + - docker + - priv testBuild: stage: test script: - - npmci npm prepare - - npmci node install stable - - npmci npm install - - npmci command npm run build + - npmci npm prepare + - npmci node install stable + - npmci npm install + - npmci command npm run build coverage: /\d+.?\d+?\%\s*coverage/ tags: - - docker - - notpriv + - lossless + - docker + - notpriv release: stage: release script: - - npmci node install stable - - npmci npm publish + - npmci node install stable + - npmci npm publish only: - - tags + - tags tags: - - docker - - notpriv + - lossless + - 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 - - priv + - lossless + - docker + - priv trigger: stage: metadata script: - - npmci trigger + - npmci trigger only: - - tags + - tags tags: - - docker - - notpriv + - lossless + - 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 diff --git a/README.md b/README.md deleted file mode 100644 index 73e2092..0000000 --- a/README.md +++ /dev/null @@ -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) diff --git a/package.json b/package.json index 32ac8b0..fcde2d5 100644 --- a/package.json +++ b/package.json @@ -49,14 +49,14 @@ "tslint-config-prettier": "^1.18.0" }, "files": [ - "ts/*", - "ts_web/*", - "dist/*", - "dist_web/*", - "dist_ts_web/*", - "assets/*", + "ts/**/*", + "ts_web/**/*", + "dist/**/*", + "dist_web/**/*", + "dist_ts_web/**/*", + "assets/**/*", "cli.js", "npmextra.json", "readme.md" ] -} +} \ No newline at end of file diff --git a/ts/docker.classes.network.ts b/ts/docker.classes.network.ts index df5b4e9..83e4d0e 100644 --- a/ts/docker.classes.network.ts +++ b/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> { + }> + > { 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) { diff --git a/ts/interfaces/service.ts b/ts/interfaces/service.ts index 116a8a5..5363ffa 100644 --- a/ts/interfaces/service.ts +++ b/ts/interfaces/service.ts @@ -13,6 +13,6 @@ export interface IServiceCreationDescriptor { ports: string[]; accessHostDockerSock?: boolean; resources?: { - memorySizeMB: number + memorySizeMB: number; }; }