From ff5cecb07eb6f225b890ed9bf109dffe86b0bb47 Mon Sep 17 00:00:00 2001 From: Phil Kunz Date: Wed, 14 Aug 2019 20:56:57 +0200 Subject: [PATCH] fix(core): update --- .gitignore | 22 +++++++++- .gitlab-ci.yml | 76 ++++++++++++---------------------- README.md | 40 +++++++++--------- npmextra.json | 15 +++++-- package.json | 15 ++++++- ts/docker.classes.container.ts | 4 +- ts/docker.classes.image.ts | 23 +++++----- ts/docker.classes.network.ts | 4 +- ts/docker.classes.service.ts | 4 +- 9 files changed, 108 insertions(+), 95 deletions(-) diff --git a/.gitignore b/.gitignore index 67fa559..91c0db0 100644 --- a/.gitignore +++ b/.gitignore @@ -1,4 +1,22 @@ -.yarn/ -node_modules/ +.nogit/ + +# artifacts coverage/ public/ +pages/ + +# installs +node_modules/ + +# caches +.yarn/ +.cache/ +.rpt2_cache + +# builds +dist/ +dist_web/ +dist_serve/ +dist_ts_web/ + +# custom \ No newline at end of file diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml index d543acc..938529d 100644 --- a/.gitlab-ci.yml +++ b/.gitlab-ci.yml @@ -1,5 +1,5 @@ -# gitzone standard -image: hosttoday/ht-docker-node:npmci +# gitzone ci_default +image: registry.gitlab.com/hosttoday/ht-docker-node:npmci cache: paths: @@ -34,54 +34,38 @@ snyk: - docker - notpriv -sast: - stage: security - image: registry.gitlab.com/hosttoday/ht-docker-dbase:npmci - variables: - DOCKER_DRIVER: overlay2 - allow_failure: true - services: - - docker:stable-dind - script: - - npmci npm prepare - - npmci npm install - - npmci command npm run build - - export SP_VERSION=$(echo "$CI_SERVER_VERSION" | sed 's/^\([0-9]*\)\.\([0-9]*\).*/\1-\2-stable/') - - docker run - --env SAST_CONFIDENCE_LEVEL="${SAST_CONFIDENCE_LEVEL:-3}" - --volume "$PWD:/code" - --volume /var/run/docker.sock:/var/run/docker.sock - "registry.gitlab.com/gitlab-org/security-products/sast:$SP_VERSION" /app/bin/run /code - artifacts: - reports: - sast: gl-sast-report.json - tags: - - docker - - priv - # ==================== # test stage # ==================== - -testSTABLE: - image: hosttoday/ht-docker-dbase:npmci - services: - - docker:dind + +testLTS: stage: test script: - npmci npm prepare - - npmci node install stable + - npmci node install lts - npmci npm install - npmci npm test coverage: /\d+.?\d+?\%\s*coverage/ tags: - docker - - priv + - notpriv + +testBuild: + stage: test + script: + - npmci npm prepare + - npmci node install lts + - npmci npm install + - npmci command npm run build + coverage: /\d+.?\d+?\%\s*coverage/ + tags: + - docker + - notpriv release: stage: release script: - - npmci node install stable + - npmci node install lts - npmci npm publish only: - tags @@ -94,19 +78,11 @@ release: # ==================== codequality: stage: metadata - image: docker:stable allow_failure: true - services: - - docker:stable-dind script: - - export SP_VERSION=$(echo "$CI_SERVER_VERSION" | sed 's/^\([0-9]*\)\.\([0-9]*\).*/\1-\2-stable/') - - docker run - --env SOURCE_CODE="$PWD" - --volume "$PWD":/code - --volume /var/run/docker.sock:/var/run/docker.sock - "registry.gitlab.com/gitlab-org/security-products/codequality:$SP_VERSION" /code - artifacts: - paths: [codeclimate.json] + - npmci command npm install -g tslint typescript + - npmci npm install + - npmci command "tslint -c tslint.json ./ts/**/*.ts" tags: - docker - priv @@ -122,13 +98,15 @@ trigger: - notpriv pages: - image: hosttoday/ht-docker-node:npmci + image: hosttoday/ht-docker-dbase:npmci + services: + - docker:18-dind stage: metadata script: - - npmci command npm install -g typedoc typescript + - npmci command npm install -g @gitzone/tsdoc - npmci npm prepare - npmci npm install - - npmci command typedoc --module "commonjs" --target "ES2016" --out public/ ts/ + - npmci command tsdoc tags: - docker - notpriv diff --git a/README.md b/README.md index f3b2185..c2fb067 100644 --- a/README.md +++ b/README.md @@ -1,25 +1,20 @@ -# @mojoio/dockersock +# @mojoio/docker +unofficial docker engine api abstraction package written in TypeScript -easy communication with docker remote api from node, TypeScript ready - -## Availabililty - -[![npm](https://mojoio.gitlab.io/assets/repo-button-npm.svg)](https://www.npmjs.com/package/dockersock) -[![git](https://mojoio.gitlab.io/assets/repo-button-git.svg)](https://GitLab.com/mojoio/dockersock) -[![git](https://mojoio.gitlab.io/assets/repo-button-mirror.svg)](https://github.com/mojoio/dockersock) -[![docs](https://mojoio.gitlab.io/assets/repo-button-docs.svg)](https://mojoio.gitlab.io/dockersock/) +## 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/dockersock/badges/master/build.svg)](https://GitLab.com/mojoio/dockersock/commits/master) -[![coverage report](https://GitLab.com/mojoio/dockersock/badges/master/coverage.svg)](https://GitLab.com/mojoio/dockersock/commits/master) -[![npm downloads per month](https://img.shields.io/npm/dm/dockersock.svg)](https://www.npmjs.com/package/dockersock) -[![Dependency Status](https://david-dm.org/mojoio/dockersock.svg)](https://david-dm.org/mojoio/dockersock) -[![bitHound Dependencies](https://www.bithound.io/github/mojoio/dockersock/badges/dependencies.svg)](https://www.bithound.io/github/mojoio/dockersock/master/dependencies/npm) -[![bitHound Code](https://www.bithound.io/github/mojoio/dockersock/badges/code.svg)](https://www.bithound.io/github/mojoio/dockersock) -[![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/) +[![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 @@ -50,3 +45,10 @@ For further information read the linked docs at the top of this README. > | By using this npm module you agree to our [privacy policy](https://lossless.gmbH/privacy.html) [![repo-footer](https://mojoio.gitlab.io/assets/repo-footer.svg)](https://mojo.io) + +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/npmextra.json b/npmextra.json index bac050a..6e924b6 100644 --- a/npmextra.json +++ b/npmextra.json @@ -1,13 +1,22 @@ { "npmdocker": { "baseImage": "hosttoday/ht-docker-node:npmci", - "command": - "(ls -a && rm -r node_modules && yarn global add npmts && yarn install && npmts)", + "command": "(ls -a && rm -r node_modules && yarn global add npmts && yarn install && npmts)", "dockerSock": true }, "npmci": { "npmGlobalTools": [], "npmAccessLevel": "public", "npmRegistryUrl": "registry.npmjs.org" + }, + "gitzone": { + "module": { + "githost": "gitlab.com", + "gitscope": "mojoio", + "gitrepo": "docker", + "shortDescription": "unofficial docker engine api abstraction package written in TypeScript", + "npmPackagename": "@mojoio/docker", + "license": "MIT" + } } -} +} \ No newline at end of file diff --git a/package.json b/package.json index a6f0905..c2a8c6b 100644 --- a/package.json +++ b/package.json @@ -41,5 +41,16 @@ "@types/node": "^12.7.1", "tslint": "^5.18.0", "tslint-config-prettier": "^1.18.0" - } -} + }, + "files": [ + "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.container.ts b/ts/docker.classes.container.ts index 581c65d..2ab3852 100644 --- a/ts/docker.classes.container.ts +++ b/ts/docker.classes.container.ts @@ -31,9 +31,7 @@ export class DockerContainer { /** * create a container */ - public static async create(creationSpecifier: interfaces.IContainerCreationSpecifier) { - - } + public static async create(creationSpecifier: interfaces.IContainerCreationSpecifier) {} // ======== // INSTANCE diff --git a/ts/docker.classes.image.ts b/ts/docker.classes.image.ts index a83ad9a..fbc38e0 100644 --- a/ts/docker.classes.image.ts +++ b/ts/docker.classes.image.ts @@ -3,7 +3,10 @@ import { DockerHost } from './docker.classes.host'; export class DockerImage { // STATIC - public static async createFromRegistry(dockerHostArg: DockerHost, dockerImageTag): Promise { + public static async createFromRegistry( + dockerHostArg: DockerHost, + dockerImageTag + ): Promise { const resultingImage = new DockerImage(); return resultingImage; @@ -20,18 +23,16 @@ export class DockerImage { /** * returns a boolean wether the image has a upstream image */ - public isUpstreamImage (): boolean { + public isUpstreamImage(): boolean { // TODO: implement isUpastreamImage return true; - }; - - /** - * - */ - public async pullLatestImageFromRegistry() : Promise { - // TODO: implement pullLatestImageFromRegistry - return true; } - + /** + * + */ + public async pullLatestImageFromRegistry(): Promise { + // TODO: implement pullLatestImageFromRegistry + return true; + } } diff --git a/ts/docker.classes.network.ts b/ts/docker.classes.network.ts index 6c14f80..33457fd 100644 --- a/ts/docker.classes.network.ts +++ b/ts/docker.classes.network.ts @@ -3,6 +3,4 @@ import * as interfaces from './interfaces'; import { DockerHost } from './docker.classes.host'; -export class DockerNetwork { - -} \ No newline at end of file +export class DockerNetwork {} diff --git a/ts/docker.classes.service.ts b/ts/docker.classes.service.ts index dcfce34..6c5a4d6 100644 --- a/ts/docker.classes.service.ts +++ b/ts/docker.classes.service.ts @@ -3,6 +3,4 @@ import * as interfaces from './interfaces'; import { DockerHost } from './docker.classes.host'; -export class DockerService { - -} \ No newline at end of file +export class DockerService {}