From 2affa189a7d194216fb25344fd3a7d08f3ccd981 Mon Sep 17 00:00:00 2001 From: Phil Kunz Date: Fri, 6 Sep 2019 16:32:36 +0200 Subject: [PATCH] fix(core): update --- .gitignore | 24 ++++++++++++++-- .gitlab-ci.yml | 77 +++++++++++++++----------------------------------- npmextra.json | 10 +++++++ package.json | 15 ++++++++-- readme.md | 77 ++++++++++++++------------------------------------ 5 files changed, 88 insertions(+), 115 deletions(-) diff --git a/.gitignore b/.gitignore index d59245a..91c0db0 100644 --- a/.gitignore +++ b/.gitignore @@ -1,4 +1,22 @@ -coverage/ -node_modules -pages/ .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 d82c33c..1e3250b 100644 --- a/.gitlab-ci.yml +++ b/.gitlab-ci.yml @@ -1,5 +1,5 @@ # gitzone ci_default -image: hosttoday/ht-docker-node:npmci +image: registry.gitlab.com/hosttoday/ht-docker-node:npmci cache: paths: @@ -34,48 +34,11 @@ 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 # ==================== -testLTS: - stage: test - script: - - npmci npm prepare - - npmci node install lts - - npmci npm install - - npmci npm test - coverage: /\d+.?\d+?\%\s*coverage/ - tags: - - docker - - notpriv - -testSTABLE: +testStable: stage: test script: - npmci npm prepare @@ -85,12 +48,24 @@ testSTABLE: coverage: /\d+.?\d+?\%\s*coverage/ tags: - docker + - priv + +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 @@ -103,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 @@ -131,13 +98,15 @@ trigger: - notpriv pages: - image: hosttoday/ht-docker-node:npmci + image: hosttoday/ht-docker-dbase:npmci + services: + - docker:stable-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/npmextra.json b/npmextra.json index a771795..954f6b1 100644 --- a/npmextra.json +++ b/npmextra.json @@ -3,5 +3,15 @@ "npmGlobalTools": [], "npmAccessLevel": "public", "npmRegistryUrl": "registry.npmjs.org" + }, + "gitzone": { + "module": { + "githost": "gitlab.com", + "gitscope": "pushrocks", + "gitrepo": "taskbuffer", + "shortDescription": "flexible task management. TypeScript ready!", + "npmPackagename": "@pushrocks/taskbuffer", + "license": "MIT" + } } } \ No newline at end of file diff --git a/package.json b/package.json index 1e98d22..5e37bc1 100644 --- a/package.json +++ b/package.json @@ -42,5 +42,16 @@ "@types/node": "^12.7.4", "tslint": "^5.19.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/readme.md b/readme.md index 7954ba1..1875191 100644 --- a/readme.md +++ b/readme.md @@ -1,64 +1,22 @@ -# taskbuffer - +# @pushrocks/taskbuffer flexible task management. TypeScript ready! -## Availabililty - -[![npm](https://pushrocks.gitlab.io/assets/repo-button-npm.svg)](https://www.npmjs.com/package/taskbuffer) -[![git](https://pushrocks.gitlab.io/assets/repo-button-git.svg)](https://GitLab.com/pushrocks/taskbuffer) -[![git](https://pushrocks.gitlab.io/assets/repo-button-mirror.svg)](https://github.com/pushrocks/taskbuffer) -[![docs](https://pushrocks.gitlab.io/assets/repo-button-docs.svg)](https://pushrocks.gitlab.io/taskbuffer/) +## Availabililty and Links +* [npmjs.org (npm package)](https://www.npmjs.com/package/@pushrocks/taskbuffer) +* [gitlab.com (source)](https://gitlab.com/pushrocks/taskbuffer) +* [github.com (source mirror)](https://github.com/pushrocks/taskbuffer) +* [docs (typedoc)](https://pushrocks.gitlab.io/taskbuffer/) ## Status for master +[![build status](https://gitlab.com/pushrocks/taskbuffer/badges/master/build.svg)](https://gitlab.com/pushrocks/taskbuffer/commits/master) +[![coverage report](https://gitlab.com/pushrocks/taskbuffer/badges/master/coverage.svg)](https://gitlab.com/pushrocks/taskbuffer/commits/master) +[![npm downloads per month](https://img.shields.io/npm/dm/@pushrocks/taskbuffer.svg)](https://www.npmjs.com/package/@pushrocks/taskbuffer) +[![Known Vulnerabilities](https://snyk.io/test/npm/@pushrocks/taskbuffer/badge.svg)](https://snyk.io/test/npm/@pushrocks/taskbuffer) +[![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/) -[![build status](https://GitLab.com/pushrocks/taskbuffer/badges/master/build.svg)](https://GitLab.com/pushrocks/taskbuffer/commits/master) -[![coverage report](https://GitLab.com/pushrocks/taskbuffer/badges/master/coverage.svg)](https://GitLab.com/pushrocks/taskbuffer/commits/master) -[![npm downloads per month](https://img.shields.io/npm/dm/taskbuffer.svg)](https://www.npmjs.com/package/taskbuffer) -[![Dependency Status](https://david-dm.org/pushrocks/taskbuffer.svg)](https://david-dm.org/pushrocks/taskbuffer) -[![bitHound Dependencies](https://www.bithound.io/github/pushrocks/taskbuffer/badges/dependencies.svg)](https://www.bithound.io/github/pushrocks/taskbuffer/master/dependencies/npm) -[![bitHound Code](https://www.bithound.io/github/pushrocks/taskbuffer/badges/code.svg)](https://www.bithound.io/github/pushrocks/taskbuffer) -[![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/) - -## Install - -```sh -npm install taskbuffer --save -``` - -## Concepts - -### class `Task` - -- A Task in its most simple form is a function that is executed when the task runs. -- A Task can have a **preTask** and an **afterTask** - (those are run before or after the main function whenever the task is called) -- A Task can be buffered. - That means it can be called multiple times in a very short time. - However execution happens in line: - meaning execution of the task's main function is on halt until the previous task call has finished. - You can set bufferMax number, which is the max number of buffered task calls. - Any additional calls will then be truncated -- Task.trigger() and Task.triggerBuffered() always return a Promise - which is fullfilled once the related task call has completed. -- Task.triggered() is an Observable stream that emits events every time a task call is called and every time a call is completed. -- Task is compatible to gulp streams. - -### class `TaskChain` - -- TaskChain extends Task. -- Multiple Tasks can be combined in a bigger task using a TaskChain. -- While the tasks are async in themselve, TaskChain **runs Tasks serialized** (one after the other) -- that means that tasks can rely on each other and - -### class `TaskParallel` - -- TaskParallel extends Task. -- like TaskChain, however **tasks run in parallel** -- Tasks cannot rely on each other. - -### Usage +## Usage We highly recommend TypeScript as this module supports **TypeScript intellisense**. @@ -85,3 +43,10 @@ For further information read the linked docs at the top of this README. > MIT licensed | **©** [Lossless GmbH](https://lossless.gmbh) [![repo-footer](https://pushrocks.gitlab.io/assets/repo-footer.svg)](https://push.rocks) + +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)