2.2.5

.gitignore

@@ -2,6 +2,9 @@ node_modules/
 .settings/
 .idea/
 coverage/
+docs/
+public/
+pages/
 
 ts/*.js
 ts/*.js.map

.gitlab-ci.yml

@@ -0,0 +1,71 @@
+# gitzone standard
+image: hosttoday/ht-docker-node:npmci
+
+cache:
+  paths:
+  - .yarn/
+  key: "$CI_BUILD_STAGE"
+
+stages:
+- test
+- release
+- trigger
+- pages
+
+testLEGACY:
+  stage: test
+  script:
+    - npmci test legacy
+  coverage: /\d+.?\d+?\%\s*coverage/
+  tags:
+    - docker
+  allow_failure: true
+
+testLTS:
+  stage: test
+  script:
+    - npmci test lts
+  coverage: /\d+.?\d+?\%\s*coverage/
+  tags:
+    - docker
+    
+testSTABLE:
+  stage: test
+  script:
+    - npmci test stable
+  coverage: /\d+.?\d+?\%\s*coverage/
+  tags:
+    - docker
+
+release:
+  stage: release
+  script:
+    - npmci publish
+  only:
+    - tags
+  tags:
+    - docker
+
+trigger:
+  stage: trigger
+  script:
+    - npmci trigger
+  only:
+    - tags
+  tags:
+    - docker
+
+pages:
+  image: hosttoday/ht-docker-node:npmci
+  stage: pages
+  script:
+    - npmci command yarn global add npmpage
+    - npmci command npmpage
+  tags:
+    - docker
+  only:
+    - tags
+  artifacts:
+    expire_in: 1 week
+    paths:
+    - public

.npmignore

@@ -1,3 +1,5 @@
 ts/
 test/
+docs/
+coverage/
 node_modules/

.travis.yml

@@ -1,14 +0,0 @@
-language: node_js
-node_js:
-- 4.2.4
-deploy:
-  provider: npm
-  email: npm@lossless.digital
-  api_key:
-    secure: TWN/oiICeNbAhGTbwf75FnKhXnIvyA66FhNF7C0jpjn2SChSgTANai87r0f9oU9ZP3307XdGHB+fTTCJnk3upNiBoWZnkV8skkAlseOY4mVzF9mS0ZEkxVR32FjJDWfqzv6hC+Y9qNDsGs2+Avsm6fQUOispLXYAk6VzSQC1HgIfyOJtIWT5LqEyXyT6oJIZ7xwt1CYcIeEpHUiAaPYsMEpwF5OBDFByVmNV38VdRGIBsoQd3lixso7/zOOgYvjR4b/onz5WzeWYlhzAuyzOnRGr1r/9eXAzzkYydvgFx3ix5OlrreKVFB6OtMpz4jmHdu9YDGT5bcvL2bSU2SGVQM5Bx8zZXkAxACQR8ZvWmPaWYAWCu9wrW5oovjqFUV0iR26z/sTABJqz4GaXf/vFcll2EdTfUT6xj2kCodfxljaudjPUF27FSt1UJBC7jQky08wHb6+onrE8WoQXteIE2oxtHWEGOlV/GAz0+q4ih0bdOSKfThmux0iEFmeF16sWH9UdL2jBBKuus+fBPdhA3V6uwYQtsCAurhquQLISkf7kT3KujdLS302bEbkut+D1Kd22IYA1J0wYd87th88TZHx7wgQyC+8lVHG+B1R20xGLxyHVEOfyZtChfBRdn53EcUiA2XriJbfiIym4dAMUtOg2iRJamHAL7jebQEUu7oA=
-  on:
-    tags: true
-    repo: pushrocks/gulp-function
-notifications:
-  slack:
-    secure: Bb8P3fboL52CugSsp0RhOkGCeWVbgjb+QDpnMHdSOa0Nequj8V4kvrzBLZOBOjaSB0/gMvdoB4Slv2bls1dAxXW1IX1DdRb3RLMKj/Owje7eTd4IoUuSs49y6/yEkVK+E1wicdwjlMmvsk8fQE/owDRMRXYoXxhN2ZOVSQvAQ3iBO0eokFvWO7yj/VSxKoITymCXA3LfyzXXUuhvxuQd3BPZCe25xa6GWuHtaa5fbJg17pp8jJX6VZYLSRcSYyJxMU8SLdkrOsQZKj0+/Yfpu7XTmPbqxjNapuE7Zm70mi+aB26IQCnmwkdcEQNJVxQOKoP2+/ZnDfcTLQROwH1PJVzol0hneH6DdOlWt9bvBJcUvFRwaDgIb5xXQV8bGsRe5ayE/4MgCgfvdBTvevu6n12fmPx74prIv4pOPMwlALjjP8XavGL4A6amOuV7fJiSyGAku8aUe1rlUXyfoHJswMyOfkIsvnGDE3eEfq1WUIjn8tW1ZozJyoCTAIh6IHPI3Nsg3LkTRvDHPYq25/xCKWxGb2OaJc3JeqVREqm0auDqj6HoVAi/mW/uyvwX9jEVX8fNoQ69ac5VUMFfn2Mx3sU6aHKgZe/tdrtql6NYtIA+g5/ZDnHE1mnbl6MfrYiKwRbrICH5v/u1xK+4+yh09BUqazi3PzOhyTRfba/gRUg=

README.md

@@ -1,21 +1,31 @@
 # gulp-function
 accepts call to execute in gulp pipeline.
 
-### Status
-[![Build Status](https://travis-ci.org/pushrocks/gulp-function.svg?branch=v0.0.2)](https://travis-ci.org/pushrocks/gulp-function)
+## Availabililty
+[![npm](https://push.rocks/assets/repo-button-npm.svg)](https://www.npmjs.com/package/gulp-function)
+[![git](https://push.rocks/assets/repo-button-git.svg)](https://gitlab.com/pushrocks/gulp-function)
+[![git](https://push.rocks/assets/repo-button-mirror.svg)](https://github.com/pushrocks/gulp-function)
+[![docs](https://push.rocks/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)
 [![Dependency Status](https://david-dm.org/pushrocks/gulp-function.svg)](https://david-dm.org/pushrocks/gulp-function)
-[![devDependency Status](https://david-dm.org/pushrocks/gulp-function/dev-status.svg)](https://david-dm.org/pushrocks/gulp-function#info=devDependencies)
+[![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)
-[![Coverage Status](https://coveralls.io/repos/github/pushrocks/gulp-function/badge.svg?branch=master)](https://coveralls.io/github/pushrocks/gulp-function?branch=master)
+[![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/)
 
 ### Usage
 ```javascript
-var gulp = require("gulp");
-var gulpFunction = require("gulp-function");
-var Q = require("q");
+import * as gulp from 'gulp';
+import gulpFunction from 'gulp-function' // default ES6 export
+// import {forFirst, forEach, atEnd} from 'gulp-function'
+let Q = require("q");
 
-var myFunction = function () {
-    var done = Q.defer();
+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:
@@ -27,12 +37,25 @@ var myFunction = function () {
 }
 
 gulp.task('gulpTest',function() {
-    gulp.src('./mydir/*.something')
+    let stream = gulp.src('./mydir/*.something')
         .pipe(gulpFunction(myFunction,'forEach')) //read the notes below
-        .pipe(gulp.dest("./build/"))
+        // .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.
 });
 ```
 
-> Note: 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.  
-> Note: the second argument can be empty (defaults to 'forEach') or 'atEnd'
+### 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**!!!
+
+[![npm](https://push.rocks/assets/repo-header.svg)](https://push.rocks)

dist/index.d.ts

@@ -0,0 +1,12 @@
+/// <reference types="node" />
+import 'typings-global';
+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

@@ -0,0 +1,76 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+require("typings-global");
+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) {
+        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(null, file);
+                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,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi90cy9pbmRleC50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiOztBQUFBLDBCQUF1QjtBQUV2QixxQ0FBb0M7QUFTcEMsSUFBSSxhQUFhLEdBQUcsQ0FDbEIscUJBQTRELEVBQzVELG1CQUFtQyxTQUFTO0lBRzVDLElBQUksWUFBWSxHQUFHLEVBQUUsQ0FBQTtJQUNyQixJQUFJLFdBQVcsR0FBRyxVQUFVLFdBQVcsRUFBRSxJQUFJLEVBQUUsR0FBRztRQUNoRCxJQUFJLFdBQVcsR0FBRyxXQUFXLENBQUMsSUFBSSxFQUFFLEdBQUcsQ0FBQyxDQUFBO1FBQ3hDLEVBQUUsQ0FBQyxDQUFDLE9BQU8sV0FBVyxLQUFLLFdBQVcsSUFBSSxPQUFPLFdBQVcsQ0FBQyxJQUFJLEtBQUssV0FBVyxDQUFDLENBQUMsQ0FBQztZQUNsRixZQUFZLENBQUMsSUFBSSxDQUFDLFdBQVcsQ0FBQyxDQUFBO1FBQ2hDLENBQUM7SUFDSCxDQUFDLENBQUE7SUFFRCxJQUFJLG1CQUFtQixHQUFHLFVBQVUsSUFBSSxFQUFFLEdBQUc7UUFDM0MsRUFBRSxDQUFDLENBQUMsT0FBTyxxQkFBcUIsS0FBSyxVQUFVLENBQUMsQ0FBQyxDQUFDO1lBQ2hELFdBQVcsQ0FBQyxxQkFBcUIsRUFBRSxJQUFJLEVBQUUsR0FBRyxDQUFDLENBQUE7UUFDL0MsQ0FBQztRQUFDLElBQUksQ0FBQyxFQUFFLENBQUMsQ0FBQyxLQUFLLENBQUMsT0FBTyxDQUFDLHFCQUFxQixDQUFDLENBQUMsQ0FBQyxDQUFDO1lBQ2hELEdBQUcsQ0FBQyxDQUFDLElBQUksV0FBVyxJQUFJLHFCQUFxQixDQUFDLENBQUMsQ0FBQztnQkFDOUMsV0FBVyxDQUFDLHFCQUFxQixDQUFFLFdBQVcsQ0FBRSxFQUFFLElBQUksRUFBRSxHQUFHLENBQUMsQ0FBQTtZQUM5RCxDQUFDO1FBQ0gsQ0FBQztRQUFDLElBQUksQ0FBQyxDQUFDO1lBQ04sTUFBTSxJQUFJLEtBQUssQ0FBQyxrRUFBa0UsQ0FBQyxDQUFBO1FBQ3JGLENBQUM7UUFDRCxNQUFNLENBQUMsT0FBTyxDQUFDLEdBQUcsQ0FBQyxZQUFZLENBQUMsQ0FBQTtJQUNsQyxDQUFDLENBQUE7SUFFRCxJQUFJLGVBQWUsR0FBRyxLQUFLLENBQUE7SUFDM0IsSUFBSSxPQUFPLEdBQUcsVUFBVSxJQUFJLEVBQUUsR0FBRyxFQUFFLEVBQUU7UUFDbkMsTUFBTSxDQUFDLENBQUMsZ0JBQWdCLENBQUMsQ0FBQyxDQUFDO1lBQ3pCLEtBQUssU0FBUztnQkFDWixtQkFBbUIsQ0FBQyxJQUFJLEVBQUUsR0FBRyxDQUFDLENBQUMsSUFBSSxDQUFDO29CQUNsQyxFQUFFLENBQUMsSUFBSSxFQUFFLElBQUksQ0FBQyxDQUFBO2dCQUNoQixDQUFDLENBQUMsQ0FBQTtnQkFDRixLQUFLLENBQUE7WUFDUCxLQUFLLFVBQVU7Z0JBQ2IsRUFBRSxDQUFDLENBQUMsZUFBZSxDQUFDLENBQUMsQ0FBQztvQkFDcEIsbUJBQW1CLENBQUMsSUFBSSxFQUFFLEdBQUcsQ0FBQzt5QkFDM0IsSUFBSSxDQUFDO3dCQUNKLEVBQUUsQ0FBQyxJQUFJLEVBQUUsSUFBSSxDQUFDLENBQUE7b0JBQ2hCLENBQUMsQ0FBQyxDQUFBO2dCQUNOLENBQUM7Z0JBQUMsSUFBSSxDQUFDLENBQUM7b0JBQ04sRUFBRSxDQUFDLElBQUksRUFBRSxJQUFJLENBQUMsQ0FBQTtnQkFDaEIsQ0FBQztnQkFDRCxlQUFlLEdBQUcsSUFBSSxDQUFBO2dCQUN0QixLQUFLLENBQUE7WUFDUCxLQUFLLE9BQU87Z0JBQ1YsRUFBRSxDQUFDLElBQUksRUFBRSxJQUFJLENBQUMsQ0FBQTtnQkFDZCxLQUFLLENBQUE7WUFDUDtnQkFDRSxLQUFLLENBQUE7UUFDVCxDQUFDO0lBQ0gsQ0FBQyxDQUFBO0lBRUQsSUFBSSxLQUFLLEdBQUcsVUFBVSxFQUFFO1FBQ3RCLEVBQUUsQ0FBQyxDQUFDLGdCQUFnQixLQUFLLE9BQU8sQ0FBQyxDQUFDLENBQUM7WUFDakMsbUJBQW1CLENBQUMsSUFBSSxFQUFFLElBQUksQ0FBQyxDQUFDLElBQUksQ0FBQztnQkFDbkMsRUFBRSxFQUFFLENBQUE7WUFDTixDQUFDLENBQUMsQ0FBQTtRQUNKLENBQUM7UUFBQyxJQUFJLENBQUMsQ0FBQztZQUNOLEVBQUUsRUFBRSxDQUFBO1FBQ04sQ0FBQztJQUNILENBQUMsQ0FBQTtJQUNELE1BQU0sQ0FBQyxRQUFRLENBQUMsR0FBRyxDQUFDLE9BQU8sRUFBRSxLQUFLLENBQUMsQ0FBQTtBQUNyQyxDQUFDLENBQUE7QUFFVSxRQUFBLE9BQU8sR0FBRyxDQUFDLE9BQXlCO0lBQzdDLE1BQU0sQ0FBQyxhQUFhLENBQUMsT0FBTyxFQUFFLFNBQVMsQ0FBQyxDQUFBO0FBQzFDLENBQUMsQ0FBQTtBQUVVLFFBQUEsUUFBUSxHQUFHLENBQUMsT0FBeUI7SUFDOUMsTUFBTSxDQUFDLGFBQWEsQ0FBQyxPQUFPLEVBQUUsVUFBVSxDQUFDLENBQUE7QUFDM0MsQ0FBQyxDQUFBO0FBRVUsUUFBQSxLQUFLLEdBQUcsQ0FBQyxPQUF5QjtJQUMzQyxNQUFNLENBQUMsYUFBYSxDQUFDLE9BQU8sRUFBRSxPQUFPLENBQUMsQ0FBQTtBQUN4QyxDQUFDLENBQUE7QUFFRCxrQkFBZSxhQUFhLENBQUEifQ==

index.d.ts

@@ -1,6 +0,0 @@
-/// <reference path="ts/typings/main.d.ts" />
-declare var plugins: {
-    beautylog: any;
-    Q: any;
-    through: any;
-};

index.js

@@ -1,57 +0,0 @@
-#!/usr/bin/env node
-
-/// <reference path="typings/main.d.ts" />
-var plugins = {
-    beautylog: require("beautylog"),
-    Q: require("q"),
-    through: require("through2")
-};
-module.exports = function (functionsToExecuteArg, executionModeArg) {
-    if (executionModeArg === void 0) { executionModeArg = 'forEach'; }
-    //important vars
-    var executionMode = executionModeArg; //can be forEach or atEnd
-    var functionsToExecute = functionsToExecuteArg;
-    var promiseArray = [];
-    var runFunction = function (functionArg) {
-        var returnValue = functionArg();
-        if (typeof returnValue !== "undefined" && typeof returnValue.then !== "undefined") {
-            promiseArray.push(returnValue);
-        }
-    };
-    var checkAndRunFunction = function () {
-        if (typeof functionsToExecute === "function") {
-            runFunction(functionsToExecute);
-        }
-        else if (Array.isArray(functionsToExecute)) {
-            for (var anyFunction in functionsToExecute) {
-                runFunction(functionsToExecute[anyFunction]);
-            }
-        }
-        else {
-            plugins.beautylog.error('gulp-callfunction: something is strange with the given arguments');
-        }
-        return plugins.Q.all(promiseArray);
-    };
-    var forEach = function (file, enc, cb) {
-        if (executionMode === 'forEach') {
-            checkAndRunFunction().then(function () {
-                cb(null, file);
-            });
-        }
-        else {
-            cb(null, file);
-        }
-        //tell gulp that we are complete
-    };
-    var atEnd = function (cb) {
-        if (executionMode === "atEnd") {
-            checkAndRunFunction().then(function () {
-                cb();
-            });
-        }
-        else {
-            cb();
-        }
-    };
-    return plugins.through.obj(forEach, atEnd);
-};

npmextra.json

@@ -0,0 +1,10 @@
+{
+  "npmts": {
+    "mode": "default"
+  },
+  "npmci": {
+    "globalNpmTools": [
+      "npmts"
+    ]
+  }
+}

npmts.json

@@ -1,4 +0,0 @@
-{
-  "mode":"default",
-  "coveralls":true
-}

package.json

@@ -1,8 +1,9 @@
 {
   "name": "gulp-function",
-  "version": "1.1.0",
+  "version": "2.2.5",
   "description": "accepts a function call as parameter to execute in gulp pipeline",
-  "main": "index.js",
+  "main": "dist/index.js",
+  "typings": "dist/index.d.ts",
   "scripts": {
     "test": "(npmts)",
     "reinstall": "(rm -r node_modules && npm install)",
@@ -11,26 +12,28 @@
   },
   "repository": {
     "type": "git",
-    "url": "https://github.com/pushrocks/gulp-function.git"
+    "url": "https://gitlab.com/pushrocks/gulp-function.git"
   },
   "keywords": [
     "gulpplugin",
     "gulp",
     "function"
   ],
-  "author": "Smart Coordination GmbH <office@push.rocks> (https://push.rocks)",
+  "author": "Lossless GmbH <office@lossless.com> (https://lossless.com)",
   "license": "MIT",
   "bugs": {
-    "url": "https://github.com/pushrocks/gulp-function/issues"
+    "url": "https://gitlab.com/pushrocks/gulp-function/issues"
   },
-  "homepage": "https://github.com/pushrocks/gulp-function",
+  "homepage": "https://gitlab.com/pushrocks/gulp-function",
   "dependencies": {
-    "beautylog": "^2.1.1",
-    "q": "^1.4.1",
-    "through2": "^2.0.1"
+    "@types/through2": "^2.0.32",
+    "smartq": "^1.1.1",
+    "through2": "^2.0.3",
+    "typings-global": "^1.0.16"
   },
   "devDependencies": {
+    "beautylog": "^6.1.10",
     "gulp": "^3.9.1",
-    "npmts": "^2.2.3"
+    "tapbundle": "^1.0.10"
   }
 }

test/test.d.ts

@@ -1,8 +0,0 @@
-/// <reference path="ts/typings/main.d.ts" />
-declare var gulp: any;
-declare var gulpFunction: any;
-declare var beautylog: any;
-declare var Q: any;
-declare var myFunction: () => any;
-declare var myFunction2: () => any;
-declare var myFunction3: () => any;

test/test.js

@@ -1,45 +0,0 @@
-#!/usr/bin/env node
-
-/// <reference path="typings/main.d.ts" />
-var gulp = require("gulp");
-var gulpFunction = require("../index.js");
-var beautylog = require("beautylog");
-var Q = require("q");
-var myFunction = function () {
-    var done = Q.defer();
-    beautylog.log("Function executed");
-    done.resolve();
-    return done.promise;
-};
-var myFunction2 = function () {
-    var done = Q.defer();
-    beautylog.ok("Function2 executed");
-    done.resolve();
-    return done.promise;
-};
-var myFunction3 = function () {
-    var done = Q.defer();
-    beautylog.success("Function3 executed");
-    done.resolve();
-    return done.promise;
-};
-describe("gulpFunction", function () {
-    it("should run through smoothly with " + "'forEach'".blue, function (done) {
-        gulp.src('./test/*.md')
-            .pipe(gulpFunction(myFunction, 'forEach'))
-            .pipe(gulp.dest("./test/result/"));
-        gulp.src('./test/*.md')
-            .pipe(gulpFunction([myFunction2, myFunction3], 'forEach'))
-            .pipe(gulp.dest("./test/result/"))
-            .pipe(gulpFunction(done, "atEnd"));
-    });
-    it("should run through smoothly with " + "'atEnd'".blue, function (done) {
-        gulp.src('./test/*.md')
-            .pipe(gulpFunction(myFunction, 'atEnd'))
-            .pipe(gulp.dest("./test/result/"));
-        gulp.src('./test/*.md')
-            .pipe(gulpFunction([myFunction2, myFunction3], 'atEnd'))
-            .pipe(gulp.dest("./test/result/"))
-            .pipe(gulpFunction(done, "atEnd"));
-    });
-});

test/test.ts

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

ts/index.ts

@@ -1,60 +1,89 @@
-/// <reference path="typings/main.d.ts" />
+import 'typings-global'
+import * as q from 'smartq'
+import * as through2 from 'through2'
+import { Transform } from 'stream'
 
-var plugins = {
-    beautylog: require("beautylog"),
-    Q: require("q"),
-    through: require("through2")
+export type TExecutionMode = 'forEach' | 'forFirst' | 'atEnd'
+
+export interface IPromiseFunction {
+  (file?, enc?): PromiseLike<any>
 }
 
+let defaultExport = (
+  functionsToExecuteArg: IPromiseFunction | IPromiseFunction[],
+  executionModeArg: TExecutionMode = 'forEach'
+): Transform => {
 
-
-
-module.exports = function (functionsToExecuteArg:any|any[],executionModeArg:string = 'forEach') {
-    //important vars
-    var executionMode = executionModeArg; //can be forEach or atEnd
-    var functionsToExecute = functionsToExecuteArg;
-    var promiseArray = [];
-    var runFunction = function(functionArg){
-        var returnValue = functionArg();
-        if (typeof returnValue !== "undefined" && typeof returnValue.then !== "undefined") {
-            promiseArray.push(returnValue);
+  let promiseArray = []
+  let runFunction = function (functionArg, file, enc) {
+    let returnValue = functionArg(file, enc)
+    if (typeof returnValue !== 'undefined' && typeof returnValue.then !== 'undefined') {
+      promiseArray.push(returnValue)
+    }
   }
-    };
 
-    var checkAndRunFunction = function () {
-        if (typeof functionsToExecute === "function" ) {
-            runFunction(functionsToExecute);
-        } else if (Array.isArray(functionsToExecute)) {
-            for (var anyFunction in functionsToExecute) {
-                runFunction(functionsToExecute[anyFunction]);
+  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 {
-            plugins.beautylog.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 plugins.Q.all(promiseArray);
-    };
 
-
-    var forEach = function (file, enc, cb) {
-        if (executionMode === 'forEach') {
-            checkAndRunFunction().then(function(){
-                cb(null, file);
-            });
+  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);
+          cb(null, file)
+        }
+        hasExecutedOnce = true
+        break
+      case 'atEnd':
+        cb(null, file)
+        break
+      default:
+        break
+    }
   }
-        //tell gulp that we are complete
 
-    };
-
-    var atEnd = function(cb) {
-        if (executionMode === "atEnd") {
-            checkAndRunFunction().then(function(){
-                cb();
-            });
+  let atEnd = function (cb) {
+    if (executionModeArg === 'atEnd') {
+      checkAndRunFunction(null, null).then(function () {
+        cb()
+      })
     } else {
-            cb();
+      cb()
     }
-    };
-    return plugins.through.obj(forEach,atEnd);
-};
+  }
+  return through2.obj(forEach, atEnd)
+}
+
+export let forEach = (funcArg: IPromiseFunction) => {
+  return defaultExport(funcArg, 'forEach')
+}
+
+export let forFirst = (funcArg: IPromiseFunction) => {
+  return defaultExport(funcArg, 'forFirst')
+}
+
+export let atEnd = (funcArg: IPromiseFunction) => {
+  return defaultExport(funcArg, 'atEnd')
+}
+
+export default defaultExport

ts/test.ts

@@ -1,50 +0,0 @@
-/// <reference path="typings/main.d.ts" />
-var gulp = require("gulp");
-var gulpFunction = require("../index.js");
-var beautylog = require("beautylog");
-var Q = require("q");
-
-var myFunction = function () {
-    var done = Q.defer()
-    beautylog.log("Function executed");
-    done.resolve();
-    return done.promise;
-};
-var myFunction2 = function () {
-    var done = Q.defer();
-    beautylog.ok("Function2 executed");
-    done.resolve();
-    return done.promise;
-};
-var myFunction3 = function () {
-    var done = Q.defer();
-    beautylog.success("Function3 executed");
-    done.resolve();
-    return done.promise;
-};
-
-describe("gulpFunction",function(){
-    it("should run through smoothly with " + "'forEach'".blue,function(done){
-        gulp.src('./test/*.md')
-            .pipe(gulpFunction(myFunction,'forEach'))
-            .pipe(gulp.dest("./test/result/"));
-
-        gulp.src('./test/*.md')
-            .pipe(gulpFunction([myFunction2,myFunction3],'forEach'))
-            .pipe(gulp.dest("./test/result/"))
-            .pipe(gulpFunction(done,"atEnd"));
-
-    });
-
-    it("should run through smoothly with " + "'atEnd'".blue,function(done){
-        gulp.src('./test/*.md')
-            .pipe(gulpFunction(myFunction,'atEnd'))
-            .pipe(gulp.dest("./test/result/"));
-
-        gulp.src('./test/*.md')
-            .pipe(gulpFunction([myFunction2,myFunction3],'atEnd'))
-            .pipe(gulp.dest("./test/result/"))
-            .pipe(gulpFunction(done,"atEnd"));
-    });
-});
-

ts/tsd.json

@@ -1,15 +0,0 @@
-{
-  "version": "v4",
-  "repo": "borisyankov/DefinitelyTyped",
-  "ref": "master",
-  "path": "typings",
-  "bundle": "typings/tsd.d.ts",
-  "installed": {
-    "node/node.d.ts": {
-      "commit": "efa0c1196d7280640e624ac1e7fa604502e7bd63"
-    },
-    "colors/colors.d.ts": {
-      "commit": "3191f6e0088eee07c4d8fd24e4d27a40a60d9eb9"
-    }
-  }
-}

ts/typings.json

@@ -1,7 +0,0 @@
-{
-  "ambientDependencies": {
-    "node": "github:DefinitelyTyped/DefinitelyTyped/node/node.d.ts",
-    "mocha": "github:Bartvds/tsd-deftools/typings/DefinitelyTyped/mocha/mocha.d.ts",
-    "colors": "github:DefinitelyTyped/DefinitelyTyped/colors/colors.d.ts"
-  }
-}

tslint.json

@@ -0,0 +1,3 @@
+{
+    "extends": "tslint-config-standard"
+}