fix(core): update to latest gitzone standards

.gitlab-ci.yml

@@ -3,94 +3,123 @@ image: hosttoday/ht-docker-node:npmci
 
 cache:
   paths:
-  - .yarn/
+  - .npmci_cache/
   key: "$CI_BUILD_STAGE"
 
 stages:
-- mirror
 - security
 - test
 - release
-- trigger
+- metadata
-- pages
 
+# ====================
+# security stage
+# ====================
 mirror:
-  stage: mirror
+  stage: security
   script:
   - npmci git mirror
   tags:
   - docker
+  - notpriv
 
-security:
+snyk:
   stage: security
   script:
-    - npmci command yarn global add snyk
+    - npmci npm prepare
-    - npmci command yarn install --ignore-scripts
+    - npmci command npm install -g snyk
+    - npmci command npm install --ignore-scripts
     - npmci command snyk test
   tags:
   - docker
+  - notpriv
 
-testLEGACY:
+# ====================
-  stage: test
+# test stage
-  script:
+# ====================
-  - npmci node install legacy
-  - npmci npm install
-  - npmci npm test
-  coverage: /\d+.?\d+?\%\s*coverage/
-  tags:
-  - docker
-  allow_failure: true
 
 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:
   stage: test
   script:
+  - npmci npm prepare
   - npmci node install stable
   - npmci npm install
   - npmci npm test
   coverage: /\d+.?\d+?\%\s*coverage/
   tags:
   - docker
+  - notpriv
 
 release:
   stage: release
   script:
-  - npmci npm prepare
+  - npmci node install stable
   - npmci npm publish
   only:
   - tags
   tags:
   - docker
+  - notpriv
+
+# ====================
+# metadata stage
+# ====================
+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]
+  tags:
+  - docker
+  - priv
 
 trigger:
-  stage: trigger
+  stage: metadata
   script:
   - npmci trigger
   only:
   - tags
   tags:
   - docker
+  - notpriv
 
 pages:
   image: hosttoday/ht-docker-node:npmci
-  stage: pages
+  stage: metadata
   script:
-    - npmci command yarn global add npmpage
+    - npmci command npm install -g typedoc typescript
-    - npmci command npmpage
+    - npmci npm prepare
+    - npmci npm install
+    - npmci command typedoc --module "commonjs" --target "ES2016" --out public/ ts/
   tags:
     - docker
+    - notpriv
   only:
     - tags
   artifacts:
     expire_in: 1 week
     paths:
     - public
+  allow_failure: true

README.md

@@ -15,8 +15,6 @@ accepts a function call as parameter to execute in gulp pipeline
 [![coverage report](https://GitLab.com/pushrocks/gulp-function/badges/master/coverage.svg)](https://GitLab.com/pushrocks/gulp-function/commits/master)
 [![npm downloads per month](https://img.shields.io/npm/dm/gulp-function.svg)](https://www.npmjs.com/package/gulp-function)
 [![Dependency Status](https://david-dm.org/pushrocks/gulp-function.svg)](https://david-dm.org/pushrocks/gulp-function)
-[![bitHound Dependencies](https://www.bithound.io/github/pushrocks/gulp-function/badges/dependencies.svg)](https://www.bithound.io/github/pushrocks/gulp-function/master/dependencies/npm)
-[![bitHound Code](https://www.bithound.io/github/pushrocks/gulp-function/badges/code.svg)](https://www.bithound.io/github/pushrocks/gulp-function)
 [![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/)
@@ -25,34 +23,34 @@ accepts a function call as parameter to execute in gulp pipeline
 
 ```typescript
 import gulp = require('gulp');
-import gulpFunction from "gulp-function"; // default ES6 export
+import gulpFunction from 'gulp-function'; // default ES6 export
 // import {forFirst, forEach, atEnd} from 'gulp-function'
 
 let myAsyncFunction = async (file, enc) => {
   // await some async stuff
 };
 
-gulp.task("gulpTest", function() {
+gulp.task('gulpTest', function() {
   let stream = gulp
-    .src("./mydir/*.something")
+    .src('./mydir/*.something')
-    .pipe(gulpFunction(myAsyncFunction, "forEach")) //read the notes below
+    .pipe(gulpFunction(myAsyncFunction, 'forEach')) //read the notes below
     // .pipe(forEach(myAsyncFunction)) // if imported as >> import { forEach } from 'gulp-function' <<
-    .pipe(gulp.dest("./build/"));
+    .pipe(gulp.dest('./build/'));
   return stream; // by returning the stream gulp knows when our task has finished.
 });
 ```
 
 ### Notes
 
-* The first argument of gulpFunction can also be an **array of multiple functionnames**.
+- The first argument of gulpFunction can also be an **array of multiple functionnames**.
   Each function can return a promise. The pipe stop will finish when every promise is fullfilled.
   When providing an array of functions be careful with modifying the file object -> race condition
-* The second argument can be empty, it defaults to "forEach"
+- The second argument can be empty, it defaults to "forEach"
-* The following options are available:
+- The following options are available:
-  * "forFirst" - executes when first chunk/vinylfile of the stream reaches the pipestop.
+  - "forFirst" - executes when first chunk/vinylfile of the stream reaches the pipestop.
     file is pushed further down the line when function's returned promise is fullfilled.
-  * "forEach" - executes like "forFirst" but with every chunk/vinylfile in the stream;
+  - "forEach" - executes like "forFirst" but with every chunk/vinylfile in the stream;
-  * "atEnd" - executes after all chunks have passed and are processed in full.
+  - "atEnd" - executes after all chunks have passed and are processed in full.
     That means the stream's "finish" event fires **before "atLast" is executed**!!!
 
 For further information read the linked docs at the top of this README.

dist/index.d.ts

@@ -1,11 +0,0 @@
-/// <reference types="node" />
-import { Transform } from "stream";
-export declare type TExecutionMode = "forEach" | "forFirst" | "atEnd";
-export interface IPromiseFunction {
-    (file?: any, enc?: any): PromiseLike<any>;
-}
-declare let defaultExport: (functionsToExecuteArg: IPromiseFunction | IPromiseFunction[], executionModeArg?: TExecutionMode) => Transform;
-export declare let forEach: (funcArg: IPromiseFunction) => Transform;
-export declare let forFirst: (funcArg: IPromiseFunction) => Transform;
-export declare let atEnd: (funcArg: IPromiseFunction) => Transform;
-export default defaultExport;

dist/index.js

@@ -1,76 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const through2 = require("through2");
-let defaultExport = (functionsToExecuteArg, executionModeArg = "forEach") => {
-    let promiseArray = [];
-    let runFunction = function (functionArg, file, enc) {
-        let returnValue = functionArg(file, enc);
-        if (typeof returnValue !== "undefined" &&
-            typeof returnValue.then !== "undefined") {
-            promiseArray.push(returnValue);
-        }
-    };
-    let checkAndRunFunction = function (file, enc) {
-        if (typeof functionsToExecuteArg === "function") {
-            runFunction(functionsToExecuteArg, file, enc);
-        }
-        else if (Array.isArray(functionsToExecuteArg)) {
-            for (let anyFunction in functionsToExecuteArg) {
-                runFunction(functionsToExecuteArg[anyFunction], file, enc);
-            }
-        }
-        else {
-            throw new Error("gulp-callfunction: something is strange with the given arguments");
-        }
-        return Promise.all(promiseArray);
-    };
-    let hasExecutedOnce = false;
-    let forEach = function (file, enc, cb) {
-        // the forEach function is called for every chunk
-        switch (executionModeArg) {
-            case "forEach":
-                checkAndRunFunction(file, enc).then(function () {
-                    cb(null, file);
-                });
-                break;
-            case "forFirst":
-                if (hasExecutedOnce) {
-                    checkAndRunFunction(file, enc).then(function () {
-                        cb(null, file);
-                    });
-                }
-                else {
-                    cb(null, file);
-                }
-                hasExecutedOnce = true;
-                break;
-            case "atEnd":
-                cb();
-                break;
-            default:
-                break;
-        }
-    };
-    let atEnd = function (cb) {
-        if (executionModeArg === "atEnd") {
-            checkAndRunFunction(null, null).then(function () {
-                cb();
-            });
-        }
-        else {
-            cb();
-        }
-    };
-    return through2.obj(forEach, atEnd);
-};
-exports.forEach = (funcArg) => {
-    return defaultExport(funcArg, "forEach");
-};
-exports.forFirst = (funcArg) => {
-    return defaultExport(funcArg, "forFirst");
-};
-exports.atEnd = (funcArg) => {
-    return defaultExport(funcArg, "atEnd");
-};
-exports.default = defaultExport;
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi90cy9pbmRleC50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiOztBQUNBLHFDQUFxQztBQVNyQyxJQUFJLGFBQWEsR0FBRyxDQUNsQixxQkFBNEQsRUFDNUQsbUJBQW1DLFNBQVMsRUFDakMsRUFBRTtJQUNiLElBQUksWUFBWSxHQUFHLEVBQUUsQ0FBQztJQUN0QixJQUFJLFdBQVcsR0FBRyxVQUFTLFdBQVcsRUFBRSxJQUFJLEVBQUUsR0FBRztRQUMvQyxJQUFJLFdBQVcsR0FBRyxXQUFXLENBQUMsSUFBSSxFQUFFLEdBQUcsQ0FBQyxDQUFDO1FBQ3pDLEVBQUUsQ0FBQyxDQUNELE9BQU8sV0FBVyxLQUFLLFdBQVc7WUFDbEMsT0FBTyxXQUFXLENBQUMsSUFBSSxLQUFLLFdBQzlCLENBQUMsQ0FBQyxDQUFDO1lBQ0QsWUFBWSxDQUFDLElBQUksQ0FBQyxXQUFXLENBQUMsQ0FBQztRQUNqQyxDQUFDO0lBQ0gsQ0FBQyxDQUFDO0lBRUYsSUFBSSxtQkFBbUIsR0FBRyxVQUFTLElBQUksRUFBRSxHQUFHO1FBQzFDLEVBQUUsQ0FBQyxDQUFDLE9BQU8scUJBQXFCLEtBQUssVUFBVSxDQUFDLENBQUMsQ0FBQztZQUNoRCxXQUFXLENBQUMscUJBQXFCLEVBQUUsSUFBSSxFQUFFLEdBQUcsQ0FBQyxDQUFDO1FBQ2hELENBQUM7UUFBQyxJQUFJLENBQUMsRUFBRSxDQUFDLENBQUMsS0FBSyxDQUFDLE9BQU8sQ0FBQyxxQkFBcUIsQ0FBQyxDQUFDLENBQUMsQ0FBQztZQUNoRCxHQUFHLENBQUMsQ0FBQyxJQUFJLFdBQVcsSUFBSSxxQkFBcUIsQ0FBQyxDQUFDLENBQUM7Z0JBQzlDLFdBQVcsQ0FBQyxxQkFBcUIsQ0FBQyxXQUFXLENBQUMsRUFBRSxJQUFJLEVBQUUsR0FBRyxDQUFDLENBQUM7WUFDN0QsQ0FBQztRQUNILENBQUM7UUFBQyxJQUFJLENBQUMsQ0FBQztZQUNOLE1BQU0sSUFBSSxLQUFLLENBQ2Isa0VBQWtFLENBQ25FLENBQUM7UUFDSixDQUFDO1FBQ0QsTUFBTSxDQUFDLE9BQU8sQ0FBQyxHQUFHLENBQUMsWUFBWSxDQUFDLENBQUM7SUFDbkMsQ0FBQyxDQUFDO0lBRUYsSUFBSSxlQUFlLEdBQUcsS0FBSyxDQUFDO0lBQzVCLElBQUksT0FBTyxHQUFHLFVBQVMsSUFBSSxFQUFFLEdBQUcsRUFBRSxFQUFFO1FBQ2xDLGlEQUFpRDtRQUNqRCxNQUFNLENBQUMsQ0FBQyxnQkFBZ0IsQ0FBQyxDQUFDLENBQUM7WUFDekIsS0FBSyxTQUFTO2dCQUNaLG1CQUFtQixDQUFDLElBQUksRUFBRSxHQUFHLENBQUMsQ0FBQyxJQUFJLENBQUM7b0JBQ2xDLEVBQUUsQ0FBQyxJQUFJLEVBQUUsSUFBSSxDQUFDLENBQUM7Z0JBQ2pCLENBQUMsQ0FBQyxDQUFDO2dCQUNILEtBQUssQ0FBQztZQUNSLEtBQUssVUFBVTtnQkFDYixFQUFFLENBQUMsQ0FBQyxlQUFlLENBQUMsQ0FBQyxDQUFDO29CQUNwQixtQkFBbUIsQ0FBQyxJQUFJLEVBQUUsR0FBRyxDQUFDLENBQUMsSUFBSSxDQUFDO3dCQUNsQyxFQUFFLENBQUMsSUFBSSxFQUFFLElBQUksQ0FBQyxDQUFDO29CQUNqQixDQUFDLENBQUMsQ0FBQztnQkFDTCxDQUFDO2dCQUFDLElBQUksQ0FBQyxDQUFDO29CQUNOLEVBQUUsQ0FBQyxJQUFJLEVBQUUsSUFBSSxDQUFDLENBQUM7Z0JBQ2pCLENBQUM7Z0JBQ0QsZUFBZSxHQUFHLElBQUksQ0FBQztnQkFDdkIsS0FBSyxDQUFDO1lBQ1IsS0FBSyxPQUFPO2dCQUNWLEVBQUUsRUFBRSxDQUFDO2dCQUNMLEtBQUssQ0FBQztZQUNSO2dCQUNFLEtBQUssQ0FBQztRQUNWLENBQUM7SUFDSCxDQUFDLENBQUM7SUFFRixJQUFJLEtBQUssR0FBRyxVQUFTLEVBQUU7UUFDckIsRUFBRSxDQUFDLENBQUMsZ0JBQWdCLEtBQUssT0FBTyxDQUFDLENBQUMsQ0FBQztZQUNqQyxtQkFBbUIsQ0FBQyxJQUFJLEVBQUUsSUFBSSxDQUFDLENBQUMsSUFBSSxDQUFDO2dCQUNuQyxFQUFFLEVBQUUsQ0FBQztZQUNQLENBQUMsQ0FBQyxDQUFDO1FBQ0wsQ0FBQztRQUFDLElBQUksQ0FBQyxDQUFDO1lBQ04sRUFBRSxFQUFFLENBQUM7UUFDUCxDQUFDO0lBQ0gsQ0FBQyxDQUFDO0lBQ0YsTUFBTSxDQUFDLFFBQVEsQ0FBQyxHQUFHLENBQUMsT0FBTyxFQUFFLEtBQUssQ0FBQyxDQUFDO0FBQ3RDLENBQUMsQ0FBQztBQUVTLFFBQUEsT0FBTyxHQUFHLENBQUMsT0FBeUIsRUFBRSxFQUFFO0lBQ2pELE1BQU0sQ0FBQyxhQUFhLENBQUMsT0FBTyxFQUFFLFNBQVMsQ0FBQyxDQUFDO0FBQzNDLENBQUMsQ0FBQztBQUVTLFFBQUEsUUFBUSxHQUFHLENBQUMsT0FBeUIsRUFBRSxFQUFFO0lBQ2xELE1BQU0sQ0FBQyxhQUFhLENBQUMsT0FBTyxFQUFFLFVBQVUsQ0FBQyxDQUFDO0FBQzVDLENBQUMsQ0FBQztBQUVTLFFBQUEsS0FBSyxHQUFHLENBQUMsT0FBeUIsRUFBRSxFQUFFO0lBQy9DLE1BQU0sQ0FBQyxhQUFhLENBQUMsT0FBTyxFQUFFLE9BQU8sQ0FBQyxDQUFDO0FBQ3pDLENBQUMsQ0FBQztBQUVGLGtCQUFlLGFBQWEsQ0FBQyJ9

package.json

@@ -5,7 +5,8 @@
   "main": "dist/index.js",
   "typings": "dist/index.d.ts",
   "scripts": {
-    "test": "(npmts)"
+    "test": "(tstest test/)",
+    "build": "(tsbuild)"
   },
   "repository": {
     "type": "git",
@@ -24,13 +25,18 @@
   },
   "homepage": "https://gitlab.com/pushrocks/gulp-function",
   "dependencies": {
+    "@pushrocks/smartpromise": "^2.0.5",
     "@types/through2": "^2.0.32",
-    "smartq": "^1.1.6",
+    "through2": "^3.0.0"
-    "through2": "^2.0.3"
   },
   "devDependencies": {
+    "@gitzone/tsbuild": "^2.1.3",
+    "@gitzone/tstest": "^1.0.18",
+    "@pushrocks/smartgulp": "^2.0.1",
+    "@pushrocks/tapbundle": "^3.0.7",
     "gulp": "^3.9.1",
-    "smartgulp": "^1.0.1",
+    "tslint": "^5.11.0",
-    "tapbundle": "^1.0.10"
+    "tslint-config-prettier": "^1.17.0"
-  }
+  },
+  "private": true
 }

test/test.ts

@@ -1,33 +1,35 @@
-import { expect, tap } from 'tapbundle'
+import { expect, tap } from '@pushrocks/tapbundle';
 
-import * as smartgulp from 'smartgulp'
+import * as smartgulp from '@pushrocks/smartgulp';
-let gulp = require('gulp')
+let gulp = require('gulp');
-import * as gulpFunction from '../ts/index'
+import * as gulpFunction from '../ts/index';
 
-let smartq = require('smartq')
+import * as smartpromise from '@pushrocks/smartpromise';
 
-tap.test('should run through smoothly with ' + "'forEach'", async (tools) => {
+tap.test('should run through smoothly with ' + "'forEach'", async tools => {
-  let done = smartq.defer()
+  let done = smartpromise.defer();
-  let counter = 0
+  let counter = 0;
-  gulp.src('./test/testfiles/*.md')
+  gulp.src('./test/testfiles/*.md').pipe(
-    .pipe(gulpFunction.forEach(async () => {
+    gulpFunction.forEach(async () => {
-      counter++
+      counter++;
       if (counter === 2) {
-        done.resolve()
+        done.resolve();
       }
-    }))
-  await done.promise
     })
+  );
+  await done.promise;
+});
 
-tap.test('should run through smoothly with ' + "'forEach'", async (tools) => {
+tap.test('should run through smoothly with ' + "'forEach'", async tools => {
-  let done = smartq.defer()
+  let done = smartpromise.defer();
-  let counter = 0
+  let counter = 0;
-  smartgulp.src(['./test/testfiles/*.md'])
+  smartgulp.src(['./test/testfiles/*.md']).pipe(
-    .pipe(gulpFunction.atEnd(async () => {
+    gulpFunction.atEnd(async () => {
-      console.log('atEnd')
+      console.log('atEnd');
-      done.resolve()
+      done.resolve();
-    }))
-  await done.promise
     })
+  );
+  await done.promise;
+});
 
-tap.start()
+tap.start();

ts/index.ts

@@ -1,8 +1,8 @@
-import * as q from "smartq";
+import * as smartpromise from '@pushrocks/smartpromise';
-import * as through2 from "through2";
+import * as through2 from 'through2';
-import { Transform } from "stream";
+import { Transform } from 'stream';
 
-export type TExecutionMode = "forEach" | "forFirst" | "atEnd";
+export type TExecutionMode = 'forEach' | 'forFirst' | 'atEnd';
 
 export interface IPromiseFunction {
   (file?, enc?): PromiseLike<any>;
@@ -10,30 +10,25 @@ export interface IPromiseFunction {
 
 let defaultExport = (
   functionsToExecuteArg: IPromiseFunction | IPromiseFunction[],
-  executionModeArg: TExecutionMode = "forEach"
+  executionModeArg: TExecutionMode = 'forEach'
 ): Transform => {
   let promiseArray = [];
   let runFunction = function(functionArg, file, enc) {
     let returnValue = functionArg(file, enc);
-    if (
+    if (typeof returnValue !== 'undefined' && typeof returnValue.then !== 'undefined') {
-      typeof returnValue !== "undefined" &&
-      typeof returnValue.then !== "undefined"
-    ) {
       promiseArray.push(returnValue);
     }
   };
 
   let checkAndRunFunction = function(file, enc) {
-    if (typeof functionsToExecuteArg === "function") {
+    if (typeof functionsToExecuteArg === 'function') {
       runFunction(functionsToExecuteArg, file, enc);
     } else if (Array.isArray(functionsToExecuteArg)) {
       for (let anyFunction in functionsToExecuteArg) {
         runFunction(functionsToExecuteArg[anyFunction], file, enc);
       }
     } else {
-      throw new Error(
+      throw new Error('gulp-callfunction: something is strange with the given arguments');
-        "gulp-callfunction: something is strange with the given arguments"
-      );
     }
     return Promise.all(promiseArray);
   };
@@ -42,12 +37,12 @@ let defaultExport = (
   let forEach = function(file, enc, cb) {
     // the forEach function is called for every chunk
     switch (executionModeArg) {
-      case "forEach":
+      case 'forEach':
         checkAndRunFunction(file, enc).then(function() {
           cb(null, file);
         });
         break;
-      case "forFirst":
+      case 'forFirst':
         if (hasExecutedOnce) {
           checkAndRunFunction(file, enc).then(function() {
             cb(null, file);
@@ -57,7 +52,7 @@ let defaultExport = (
         }
         hasExecutedOnce = true;
         break;
-      case "atEnd":
+      case 'atEnd':
         cb();
         break;
       default:
@@ -66,7 +61,7 @@ let defaultExport = (
   };
 
   let atEnd = function(cb) {
-    if (executionModeArg === "atEnd") {
+    if (executionModeArg === 'atEnd') {
       checkAndRunFunction(null, null).then(function() {
         cb();
       });
@@ -78,15 +73,15 @@ let defaultExport = (
 };
 
 export let forEach = (funcArg: IPromiseFunction) => {
-  return defaultExport(funcArg, "forEach");
+  return defaultExport(funcArg, 'forEach');
 };
 
 export let forFirst = (funcArg: IPromiseFunction) => {
-  return defaultExport(funcArg, "forFirst");
+  return defaultExport(funcArg, 'forFirst');
 };
 
 export let atEnd = (funcArg: IPromiseFunction) => {
-  return defaultExport(funcArg, "atEnd");
+  return defaultExport(funcArg, 'atEnd');
 };
 
 export default defaultExport;

tslint.json

@@ -1,3 +1,17 @@
 {
-    "extends": "tslint-config-standard"
+  "extends": ["tslint:latest", "tslint-config-prettier"],
+  "rules": {
+    "semicolon": [true, "always"],
+    "no-console": false,
+    "ordered-imports": false,
+    "object-literal-sort-keys": false,
+    "member-ordering": {
+      "options":{
+        "order": [
+          "static-method"
+        ]
+      }
+    }
+  },
+  "defaultSeverity": "warning"
 }