2.2.12

.gitlab-ci.yml

@@ -7,53 +7,68 @@ cache:
   key: "$CI_BUILD_STAGE"
 
 stages:
+- mirror
 - test
 - release
 - trigger
 - pages
 
+mirror:
+  stage: mirror
+  script:
+  - npmci git mirror
+  tags:
+  - docker
+
 testLEGACY:
   stage: test
   script:
-    - npmci test legacy
+  - npmci node install legacy
+  - npmci npm install
+  - npmci npm test
   coverage: /\d+.?\d+?\%\s*coverage/
   tags:
-    - docker
+  - docker
   allow_failure: true
 
 testLTS:
   stage: test
   script:
-    - npmci test lts
+  - npmci node install lts
+  - npmci npm install
+  - npmci npm test
   coverage: /\d+.?\d+?\%\s*coverage/
   tags:
-    - docker
+  - docker
     
 testSTABLE:
   stage: test
   script:
-    - npmci test stable
+  - npmci node install stable
+  - npmci npm install
+  - npmci npm test
   coverage: /\d+.?\d+?\%\s*coverage/
   tags:
-    - docker
+  - docker
 
 release:
   stage: release
   script:
-    - npmci publish
+  - npmci npm prepare
+  - npmci npm publish
   only:
-    - tags
+  - tags
   tags:
-    - docker
+  - docker
 
 trigger:
   stage: trigger
   script:
-    - npmci trigger
+  - npmci trigger
   only:
-    - tags
+  - tags
   tags:
-    - docker
+  - docker
 
 pages:
   image: hosttoday/ht-docker-node:npmci

README.md

@@ -1,13 +1,16 @@
 # gulp-function
+
 accepts a function call as parameter to execute in gulp pipeline
 
 ## Availabililty
+
 [![npm](https://pushrocks.gitlab.io/assets/repo-button-npm.svg)](https://www.npmjs.com/package/gulp-function)
 [![git](https://pushrocks.gitlab.io/assets/repo-button-git.svg)](https://GitLab.com/pushrocks/gulp-function)
 [![git](https://pushrocks.gitlab.io/assets/repo-button-mirror.svg)](https://github.com/pushrocks/gulp-function)
 [![docs](https://pushrocks.gitlab.io/assets/repo-button-docs.svg)](https://pushrocks.gitlab.io/gulp-function/)
 
 ## Status for master
+
 [![build status](https://GitLab.com/pushrocks/gulp-function/badges/master/build.svg)](https://GitLab.com/pushrocks/gulp-function/commits/master)
 [![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)
@@ -18,12 +21,43 @@ accepts a function call as parameter to execute in gulp pipeline
 [![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/)
 
-## Usage
+### Usage
-Use TypeScript for best in class instellisense.
+
+```typescript
+import * as gulp from "gulp";
+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() {
+  let stream = gulp
+    .src("./mydir/*.something")
+    .pipe(gulpFunction(myFunction, "forEach")) //read the notes below
+    // .pipe(forEach(myFunction)) // if imported as >> import { forEach } from 'gulp-function' <<
+    .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**.
+  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 following options are available:
+  * "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;
+  * "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.
 
 > MIT licensed | **&copy;** [Lossless GmbH](https://lossless.gmbh)
-| By using this npm module you agree to our [privacy policy](https://lossless.gmbH/privacy.html)
+> | By using this npm module you agree to our [privacy policy](https://lossless.gmbH/privacy.html)
 
 [![repo-footer](https://pushrocks.gitlab.io/assets/repo-footer.svg)](https://push.rocks)

dist/index.d.ts

@@ -1,7 +1,6 @@
 /// <reference types="node" />
-import 'typings-global';
+import { Transform } from "stream";
-import { Transform } from 'stream';
+export declare type TExecutionMode = "forEach" | "forFirst" | "atEnd";
-export declare type TExecutionMode = 'forEach' | 'forFirst' | 'atEnd';
 export interface IPromiseFunction {
     (file?: any, enc?: any): PromiseLike<any>;
 }

dist/index.js

@@ -1,17 +1,17 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-require("typings-global");
 const through2 = require("through2");
-let defaultExport = (functionsToExecuteArg, executionModeArg = 'forEach') => {
+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') {
+        if (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)) {
@@ -20,22 +20,22 @@ let defaultExport = (functionsToExecuteArg, executionModeArg = 'forEach') => {
             }
         }
         else {
-            throw new Error('gulp-callfunction: something is strange with the given arguments');
+            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':
+            case "forEach":
                 checkAndRunFunction(file, enc).then(function () {
                     cb(null, file);
                 });
                 break;
-            case 'forFirst':
+            case "forFirst":
                 if (hasExecutedOnce) {
-                    checkAndRunFunction(file, enc)
+                    checkAndRunFunction(file, enc).then(function () {
-                        .then(function () {
                         cb(null, file);
                     });
                 }
@@ -44,7 +44,7 @@ let defaultExport = (functionsToExecuteArg, executionModeArg = 'forEach') => {
                 }
                 hasExecutedOnce = true;
                 break;
-            case 'atEnd':
+            case "atEnd":
                 cb();
                 break;
             default:
@@ -52,7 +52,7 @@ let defaultExport = (functionsToExecuteArg, executionModeArg = 'forEach') => {
         }
     };
     let atEnd = function (cb) {
-        if (executionModeArg === 'atEnd') {
+        if (executionModeArg === "atEnd") {
             checkAndRunFunction(null, null).then(function () {
                 cb();
             });
@@ -64,13 +64,13 @@ let defaultExport = (functionsToExecuteArg, executionModeArg = 'forEach') => {
     return through2.obj(forEach, atEnd);
 };
 exports.forEach = (funcArg) => {
-    return defaultExport(funcArg, 'forEach');
+    return defaultExport(funcArg, "forEach");
 };
 exports.forFirst = (funcArg) => {
-    return defaultExport(funcArg, 'forFirst');
+    return defaultExport(funcArg, "forFirst");
 };
 exports.atEnd = (funcArg) => {
-    return defaultExport(funcArg, 'atEnd');
+    return defaultExport(funcArg, "atEnd");
 };
 exports.default = defaultExport;
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi90cy9pbmRleC50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiOztBQUFBLDBCQUF1QjtBQUV2QixxQ0FBb0M7QUFTcEMsSUFBSSxhQUFhLEdBQUcsQ0FDbEIscUJBQTRELEVBQzVELG1CQUFtQyxTQUFTO0lBRzVDLElBQUksWUFBWSxHQUFHLEVBQUUsQ0FBQTtJQUNyQixJQUFJLFdBQVcsR0FBRyxVQUFVLFdBQVcsRUFBRSxJQUFJLEVBQUUsR0FBRztRQUNoRCxJQUFJLFdBQVcsR0FBRyxXQUFXLENBQUMsSUFBSSxFQUFFLEdBQUcsQ0FBQyxDQUFBO1FBQ3hDLEVBQUUsQ0FBQyxDQUFDLE9BQU8sV0FBVyxLQUFLLFdBQVcsSUFBSSxPQUFPLFdBQVcsQ0FBQyxJQUFJLEtBQUssV0FBVyxDQUFDLENBQUMsQ0FBQztZQUNsRixZQUFZLENBQUMsSUFBSSxDQUFDLFdBQVcsQ0FBQyxDQUFBO1FBQ2hDLENBQUM7SUFDSCxDQUFDLENBQUE7SUFFRCxJQUFJLG1CQUFtQixHQUFHLFVBQVUsSUFBSSxFQUFFLEdBQUc7UUFDM0MsRUFBRSxDQUFDLENBQUMsT0FBTyxxQkFBcUIsS0FBSyxVQUFVLENBQUMsQ0FBQyxDQUFDO1lBQ2hELFdBQVcsQ0FBQyxxQkFBcUIsRUFBRSxJQUFJLEVBQUUsR0FBRyxDQUFDLENBQUE7UUFDL0MsQ0FBQztRQUFDLElBQUksQ0FBQyxFQUFFLENBQUMsQ0FBQyxLQUFLLENBQUMsT0FBTyxDQUFDLHFCQUFxQixDQUFDLENBQUMsQ0FBQyxDQUFDO1lBQ2hELEdBQUcsQ0FBQyxDQUFDLElBQUksV0FBVyxJQUFJLHFCQUFxQixDQUFDLENBQUMsQ0FBQztnQkFDOUMsV0FBVyxDQUFDLHFCQUFxQixDQUFFLFdBQVcsQ0FBRSxFQUFFLElBQUksRUFBRSxHQUFHLENBQUMsQ0FBQTtZQUM5RCxDQUFDO1FBQ0gsQ0FBQztRQUFDLElBQUksQ0FBQyxDQUFDO1lBQ04sTUFBTSxJQUFJLEtBQUssQ0FBQyxrRUFBa0UsQ0FBQyxDQUFBO1FBQ3JGLENBQUM7UUFDRCxNQUFNLENBQUMsT0FBTyxDQUFDLEdBQUcsQ0FBQyxZQUFZLENBQUMsQ0FBQTtJQUNsQyxDQUFDLENBQUE7SUFFRCxJQUFJLGVBQWUsR0FBRyxLQUFLLENBQUE7SUFDM0IsSUFBSSxPQUFPLEdBQUcsVUFBVSxJQUFJLEVBQUUsR0FBRyxFQUFFLEVBQUU7UUFDbkMsTUFBTSxDQUFDLENBQUMsZ0JBQWdCLENBQUMsQ0FBQyxDQUFDO1lBQ3pCLEtBQUssU0FBUztnQkFDWixtQkFBbUIsQ0FBQyxJQUFJLEVBQUUsR0FBRyxDQUFDLENBQUMsSUFBSSxDQUFDO29CQUNsQyxFQUFFLENBQUMsSUFBSSxFQUFFLElBQUksQ0FBQyxDQUFBO2dCQUNoQixDQUFDLENBQUMsQ0FBQTtnQkFDRixLQUFLLENBQUE7WUFDUCxLQUFLLFVBQVU7Z0JBQ2IsRUFBRSxDQUFDLENBQUMsZUFBZSxDQUFDLENBQUMsQ0FBQztvQkFDcEIsbUJBQW1CLENBQUMsSUFBSSxFQUFFLEdBQUcsQ0FBQzt5QkFDM0IsSUFBSSxDQUFDO3dCQUNKLEVBQUUsQ0FBQyxJQUFJLEVBQUUsSUFBSSxDQUFDLENBQUE7b0JBQ2hCLENBQUMsQ0FBQyxDQUFBO2dCQUNOLENBQUM7Z0JBQUMsSUFBSSxDQUFDLENBQUM7b0JBQ04sRUFBRSxDQUFDLElBQUksRUFBRSxJQUFJLENBQUMsQ0FBQTtnQkFDaEIsQ0FBQztnQkFDRCxlQUFlLEdBQUcsSUFBSSxDQUFBO2dCQUN0QixLQUFLLENBQUE7WUFDUCxLQUFLLE9BQU87Z0JBQ1YsRUFBRSxFQUFFLENBQUE7Z0JBQ0osS0FBSyxDQUFBO1lBQ1A7Z0JBQ0UsS0FBSyxDQUFBO1FBQ1QsQ0FBQztJQUNILENBQUMsQ0FBQTtJQUVELElBQUksS0FBSyxHQUFHLFVBQVUsRUFBRTtRQUN0QixFQUFFLENBQUMsQ0FBQyxnQkFBZ0IsS0FBSyxPQUFPLENBQUMsQ0FBQyxDQUFDO1lBQ2pDLG1CQUFtQixDQUFDLElBQUksRUFBRSxJQUFJLENBQUMsQ0FBQyxJQUFJLENBQUM7Z0JBQ25DLEVBQUUsRUFBRSxDQUFBO1lBQ04sQ0FBQyxDQUFDLENBQUE7UUFDSixDQUFDO1FBQUMsSUFBSSxDQUFDLENBQUM7WUFDTixFQUFFLEVBQUUsQ0FBQTtRQUNOLENBQUM7SUFDSCxDQUFDLENBQUE7SUFDRCxNQUFNLENBQUMsUUFBUSxDQUFDLEdBQUcsQ0FBQyxPQUFPLEVBQUUsS0FBSyxDQUFDLENBQUE7QUFDckMsQ0FBQyxDQUFBO0FBRVUsUUFBQSxPQUFPLEdBQUcsQ0FBQyxPQUF5QjtJQUM3QyxNQUFNLENBQUMsYUFBYSxDQUFDLE9BQU8sRUFBRSxTQUFTLENBQUMsQ0FBQTtBQUMxQyxDQUFDLENBQUE7QUFFVSxRQUFBLFFBQVEsR0FBRyxDQUFDLE9BQXlCO0lBQzlDLE1BQU0sQ0FBQyxhQUFhLENBQUMsT0FBTyxFQUFFLFVBQVUsQ0FBQyxDQUFBO0FBQzNDLENBQUMsQ0FBQTtBQUVVLFFBQUEsS0FBSyxHQUFHLENBQUMsT0FBeUI7SUFDM0MsTUFBTSxDQUFDLGFBQWEsQ0FBQyxPQUFPLEVBQUUsT0FBTyxDQUFDLENBQUE7QUFDeEMsQ0FBQyxDQUFBO0FBRUQsa0JBQWUsYUFBYSxDQUFBIn0=
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi90cy9pbmRleC50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiOztBQUNBLHFDQUFxQztBQVNyQyxJQUFJLGFBQWEsR0FBRyxDQUNsQixxQkFBNEQsRUFDNUQsbUJBQW1DLFNBQVMsRUFDakMsRUFBRTtJQUNiLElBQUksWUFBWSxHQUFHLEVBQUUsQ0FBQztJQUN0QixJQUFJLFdBQVcsR0FBRyxVQUFTLFdBQVcsRUFBRSxJQUFJLEVBQUUsR0FBRztRQUMvQyxJQUFJLFdBQVcsR0FBRyxXQUFXLENBQUMsSUFBSSxFQUFFLEdBQUcsQ0FBQyxDQUFDO1FBQ3pDLEVBQUUsQ0FBQyxDQUNELE9BQU8sV0FBVyxLQUFLLFdBQVc7WUFDbEMsT0FBTyxXQUFXLENBQUMsSUFBSSxLQUFLLFdBQzlCLENBQUMsQ0FBQyxDQUFDO1lBQ0QsWUFBWSxDQUFDLElBQUksQ0FBQyxXQUFXLENBQUMsQ0FBQztRQUNqQyxDQUFDO0lBQ0gsQ0FBQyxDQUFDO0lBRUYsSUFBSSxtQkFBbUIsR0FBRyxVQUFTLElBQUksRUFBRSxHQUFHO1FBQzFDLEVBQUUsQ0FBQyxDQUFDLE9BQU8scUJBQXFCLEtBQUssVUFBVSxDQUFDLENBQUMsQ0FBQztZQUNoRCxXQUFXLENBQUMscUJBQXFCLEVBQUUsSUFBSSxFQUFFLEdBQUcsQ0FBQyxDQUFDO1FBQ2hELENBQUM7UUFBQyxJQUFJLENBQUMsRUFBRSxDQUFDLENBQUMsS0FBSyxDQUFDLE9BQU8sQ0FBQyxxQkFBcUIsQ0FBQyxDQUFDLENBQUMsQ0FBQztZQUNoRCxHQUFHLENBQUMsQ0FBQyxJQUFJLFdBQVcsSUFBSSxxQkFBcUIsQ0FBQyxDQUFDLENBQUM7Z0JBQzlDLFdBQVcsQ0FBQyxxQkFBcUIsQ0FBQyxXQUFXLENBQUMsRUFBRSxJQUFJLEVBQUUsR0FBRyxDQUFDLENBQUM7WUFDN0QsQ0FBQztRQUNILENBQUM7UUFBQyxJQUFJLENBQUMsQ0FBQztZQUNOLE1BQU0sSUFBSSxLQUFLLENBQ2Isa0VBQWtFLENBQ25FLENBQUM7UUFDSixDQUFDO1FBQ0QsTUFBTSxDQUFDLE9BQU8sQ0FBQyxHQUFHLENBQUMsWUFBWSxDQUFDLENBQUM7SUFDbkMsQ0FBQyxDQUFDO0lBRUYsSUFBSSxlQUFlLEdBQUcsS0FBSyxDQUFDO0lBQzVCLElBQUksT0FBTyxHQUFHLFVBQVMsSUFBSSxFQUFFLEdBQUcsRUFBRSxFQUFFO1FBQ2xDLGlEQUFpRDtRQUNqRCxNQUFNLENBQUMsQ0FBQyxnQkFBZ0IsQ0FBQyxDQUFDLENBQUM7WUFDekIsS0FBSyxTQUFTO2dCQUNaLG1CQUFtQixDQUFDLElBQUksRUFBRSxHQUFHLENBQUMsQ0FBQyxJQUFJLENBQUM7b0JBQ2xDLEVBQUUsQ0FBQyxJQUFJLEVBQUUsSUFBSSxDQUFDLENBQUM7Z0JBQ2pCLENBQUMsQ0FBQyxDQUFDO2dCQUNILEtBQUssQ0FBQztZQUNSLEtBQUssVUFBVTtnQkFDYixFQUFFLENBQUMsQ0FBQyxlQUFlLENBQUMsQ0FBQyxDQUFDO29CQUNwQixtQkFBbUIsQ0FBQyxJQUFJLEVBQUUsR0FBRyxDQUFDLENBQUMsSUFBSSxDQUFDO3dCQUNsQyxFQUFFLENBQUMsSUFBSSxFQUFFLElBQUksQ0FBQyxDQUFDO29CQUNqQixDQUFDLENBQUMsQ0FBQztnQkFDTCxDQUFDO2dCQUFDLElBQUksQ0FBQyxDQUFDO29CQUNOLEVBQUUsQ0FBQyxJQUFJLEVBQUUsSUFBSSxDQUFDLENBQUM7Z0JBQ2pCLENBQUM7Z0JBQ0QsZUFBZSxHQUFHLElBQUksQ0FBQztnQkFDdkIsS0FBSyxDQUFDO1lBQ1IsS0FBSyxPQUFPO2dCQUNWLEVBQUUsRUFBRSxDQUFDO2dCQUNMLEtBQUssQ0FBQztZQUNSO2dCQUNFLEtBQUssQ0FBQztRQUNWLENBQUM7SUFDSCxDQUFDLENBQUM7SUFFRixJQUFJLEtBQUssR0FBRyxVQUFTLEVBQUU7UUFDckIsRUFBRSxDQUFDLENBQUMsZ0JBQWdCLEtBQUssT0FBTyxDQUFDLENBQUMsQ0FBQztZQUNqQyxtQkFBbUIsQ0FBQyxJQUFJLEVBQUUsSUFBSSxDQUFDLENBQUMsSUFBSSxDQUFDO2dCQUNuQyxFQUFFLEVBQUUsQ0FBQztZQUNQLENBQUMsQ0FBQyxDQUFDO1FBQ0wsQ0FBQztRQUFDLElBQUksQ0FBQyxDQUFDO1lBQ04sRUFBRSxFQUFFLENBQUM7UUFDUCxDQUFDO0lBQ0gsQ0FBQyxDQUFDO0lBQ0YsTUFBTSxDQUFDLFFBQVEsQ0FBQyxHQUFHLENBQUMsT0FBTyxFQUFFLEtBQUssQ0FBQyxDQUFDO0FBQ3RDLENBQUMsQ0FBQztBQUVTLFFBQUEsT0FBTyxHQUFHLENBQUMsT0FBeUIsRUFBRSxFQUFFO0lBQ2pELE1BQU0sQ0FBQyxhQUFhLENBQUMsT0FBTyxFQUFFLFNBQVMsQ0FBQyxDQUFDO0FBQzNDLENBQUMsQ0FBQztBQUVTLFFBQUEsUUFBUSxHQUFHLENBQUMsT0FBeUIsRUFBRSxFQUFFO0lBQ2xELE1BQU0sQ0FBQyxhQUFhLENBQUMsT0FBTyxFQUFFLFVBQVUsQ0FBQyxDQUFDO0FBQzVDLENBQUMsQ0FBQztBQUVTLFFBQUEsS0FBSyxHQUFHLENBQUMsT0FBeUIsRUFBRSxFQUFFO0lBQy9DLE1BQU0sQ0FBQyxhQUFhLENBQUMsT0FBTyxFQUFFLE9BQU8sQ0FBQyxDQUFDO0FBQ3pDLENBQUMsQ0FBQztBQUVGLGtCQUFlLGFBQWEsQ0FBQyJ9

docs/index.md

@@ -1,40 +0,0 @@
-### Usage
-```javascript
-import * as gulp from 'gulp';
-import gulpFunction from 'gulp-function' // default ES6 export
-// import {forFirst, forEach, atEnd} from 'gulp-function'
-let Q = require("q");
-
-let myFunction = function (file, enc) { // file and enc are optional in case you want to modify the file object
-    let done = Q.defer();
-    console.log("Hello World!")
-    
-    // NOTE:
-    // you can use done.resolve as callback function
-    // of any async tasks within this function
-    done.resolve();
-    
-    return done.promise;
-}
-
-gulp.task('gulpTest',function() {
-    let stream = gulp.src('./mydir/*.something')
-        .pipe(gulpFunction(myFunction,'forEach')) //read the notes below
-        // .pipe(forEach(myFunction)) // if imported as >> import { forEach } from 'gulp-function' <<
-        .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**.
-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 following options are available:
-    * "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;
-    *  "atEnd" - executes after all chunks have passed and are processed in full.
-       That means the stream's "finish" event fires **before "atLast" is executed**!!!

package.json

@@ -1,6 +1,6 @@
 {
   "name": "gulp-function",
-  "version": "2.2.9",
+  "version": "2.2.12",
   "description": "accepts a function call as parameter to execute in gulp pipeline",
   "main": "dist/index.js",
   "typings": "dist/index.d.ts",
@@ -14,7 +14,8 @@
   "keywords": [
     "gulpplugin",
     "gulp",
-    "function"
+    "function",
+    "pushrocks"
   ],
   "author": "Lossless GmbH <office@lossless.com> (https://lossless.com)",
   "license": "MIT",
@@ -24,9 +25,8 @@
   "homepage": "https://gitlab.com/pushrocks/gulp-function",
   "dependencies": {
     "@types/through2": "^2.0.32",
-    "smartq": "^1.1.1",
+    "smartq": "^1.1.6",
-    "through2": "^2.0.3",
+    "through2": "^2.0.3"
-    "typings-global": "^1.0.16"
   },
   "devDependencies": {
     "gulp": "^3.9.1",

test/test.ts

@@ -2,11 +2,10 @@ import { expect, tap } from 'tapbundle'
 
 import * as smartgulp from 'smartgulp'
 let gulp = require('gulp')
-import * as gulpFunction from '../dist/index'
+import * as gulpFunction from '../ts/index'
 
 let smartq = require('smartq')
 
-
 tap.test('should run through smoothly with ' + "'forEach'", async (tools) => {
   let done = smartq.defer()
   let counter = 0

ts/index.ts

@@ -1,89 +1,92 @@
-import 'typings-global'
+import * as q from "smartq";
-import * as q from 'smartq'
+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>
+  (file?, enc?): PromiseLike<any>;
 }
 
 let defaultExport = (
   functionsToExecuteArg: IPromiseFunction | IPromiseFunction[],
-  executionModeArg: TExecutionMode = 'forEach'
+  executionModeArg: TExecutionMode = "forEach"
 ): Transform => {
-
+  let promiseArray = [];
-  let promiseArray = []
+  let runFunction = function(functionArg, file, enc) {
-  let runFunction = function (functionArg, file, enc) {
+    let returnValue = functionArg(file, enc);
-    let returnValue = functionArg(file, enc)
+    if (
-    if (typeof returnValue !== 'undefined' && typeof returnValue.then !== 'undefined') {
+      typeof returnValue !== "undefined" &&
-      promiseArray.push(returnValue)
+      typeof returnValue.then !== "undefined"
+    ) {
+      promiseArray.push(returnValue);
     }
-  }
+  };
 
-  let checkAndRunFunction = function (file, enc) {
+  let checkAndRunFunction = function(file, enc) {
-    if (typeof functionsToExecuteArg === 'function') {
+    if (typeof functionsToExecuteArg === "function") {
-      runFunction(functionsToExecuteArg, file, enc)
+      runFunction(functionsToExecuteArg, file, enc);
     } else if (Array.isArray(functionsToExecuteArg)) {
       for (let anyFunction in functionsToExecuteArg) {
-        runFunction(functionsToExecuteArg[ anyFunction ], file, enc)
+        runFunction(functionsToExecuteArg[anyFunction], file, enc);
       }
     } else {
-      throw new Error('gulp-callfunction: something is strange with the given arguments')
+      throw new Error(
+        "gulp-callfunction: something is strange with the given arguments"
+      );
     }
-    return Promise.all(promiseArray)
+    return Promise.all(promiseArray);
-  }
+  };
 
-  let hasExecutedOnce = false
+  let hasExecutedOnce = false;
-  let forEach = function (file, enc, cb) { // the forEach function is called for every chunk
+  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 () {
+        checkAndRunFunction(file, enc).then(function() {
-          cb(null, file)
+          cb(null, file);
-        })
+        });
-        break
+        break;
-      case 'forFirst':
+      case "forFirst":
         if (hasExecutedOnce) {
-          checkAndRunFunction(file, enc)
+          checkAndRunFunction(file, enc).then(function() {
-            .then(function () {
+            cb(null, file);
-              cb(null, file)
+          });
-            })
         } else {
-          cb(null, file)
+          cb(null, file);
         }
-        hasExecutedOnce = true
+        hasExecutedOnce = true;
-        break
+        break;
-      case 'atEnd':
+      case "atEnd":
-        cb()
+        cb();
-        break
+        break;
       default:
-        break
+        break;
     }
-  }
+  };
 
-  let atEnd = function (cb) {
+  let atEnd = function(cb) {
-    if (executionModeArg === 'atEnd') {
+    if (executionModeArg === "atEnd") {
-      checkAndRunFunction(null, null).then(function () {
+      checkAndRunFunction(null, null).then(function() {
-        cb()
+        cb();
-      })
+      });
     } else {
-      cb()
+      cb();
     }
-  }
+  };
-  return through2.obj(forEach, atEnd)
+  return through2.obj(forEach, atEnd);
-}
+};
 
 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
+export default defaultExport;