2.2.0

.gitlab-ci.yml

@@ -1,4 +1,4 @@
-image: hosttoday/ht-docker-node:npmci
+image: hosttoday/ht-docker-node:npmts
 stages:
 - test
 - release

README.md

@@ -19,12 +19,13 @@ accepts call to execute in gulp pipeline.
 
 ### Usage
 ```javascript
-var gulp = require("gulp");
+import * as gulp from 'gulp';
-var gulpFunction = require("gulp-function");
+import gulpFunction from 'gulp-function' // default ES6 export
-var Q = require("q");
+// import {forFirst, forEach, atEnd} from 'gulp-function'
+let Q = require("q");
 
-var myFunction = function (file, enc) { // file and enc are optional in case you want to modify the file object
+let myFunction = function (file, enc) { // file and enc are optional in case you want to modify the file object
-    var done = Q.defer();
+    let done = Q.defer();
     console.log("Hello World!")
     
     // NOTE:
@@ -36,8 +37,9 @@ var myFunction = function (file, enc) { // file and enc are optional in case you
 }
 
 gulp.task('gulpTest',function() {
-    var stream = gulp.src('./mydir/*.something')
+    let stream = gulp.src('./mydir/*.something')
         .pipe(gulpFunction(myFunction,'forEach')) //read the notes below
+        // .pipe(gulpFunction.forEach(myFunction))
         .pipe(gulp.dest("./build/"));
     return stream; // by returning the stream gulp knows when our task has finished.
 });

dist/index.d.ts

@@ -1,5 +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) => void;
+export declare let forFirst: (funcArg: IPromiseFunction) => void;
+export declare let atEnd: (funcArg: IPromiseFunction) => void;
+export default defaultExport;

dist/index.js

@@ -2,7 +2,7 @@
 require("typings-global");
 const q = require("q");
 const through2 = require("through2");
-module.exports = (functionsToExecuteArg, executionModeArg = 'forEach') => {
+let defaultExport = (functionsToExecuteArg, executionModeArg = 'forEach') => {
     let promiseArray = [];
     let runFunction = function (functionArg, file, enc) {
         let returnValue = functionArg(file, enc);
@@ -63,4 +63,15 @@ module.exports = (functionsToExecuteArg, executionModeArg = 'forEach') => {
     };
     return through2.obj(forEach, atEnd);
 };
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi90cy9pbmRleC50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiO0FBQUEsMEJBQXVCO0FBQ3ZCLHVCQUFzQjtBQUN0QixxQ0FBb0M7QUFTcEMsTUFBTSxDQUFDLE9BQU8sR0FBRyxDQUNiLHFCQUE0RCxFQUM1RCxnQkFBZ0IsR0FBbUIsU0FBUztJQUc1QyxJQUFJLFlBQVksR0FBRyxFQUFFLENBQUE7SUFDckIsSUFBSSxXQUFXLEdBQUcsVUFBVSxXQUFXLEVBQUUsSUFBSSxFQUFFLEdBQUc7UUFDOUMsSUFBSSxXQUFXLEdBQUcsV0FBVyxDQUFDLElBQUksRUFBRSxHQUFHLENBQUMsQ0FBQTtRQUN4QyxFQUFFLENBQUMsQ0FBQyxPQUFPLFdBQVcsS0FBSyxXQUFXLElBQUksT0FBTyxXQUFXLENBQUMsSUFBSSxLQUFLLFdBQVcsQ0FBQyxDQUFDLENBQUM7WUFDaEYsWUFBWSxDQUFDLElBQUksQ0FBQyxXQUFXLENBQUMsQ0FBQTtRQUNsQyxDQUFDO0lBQ0wsQ0FBQyxDQUFBO0lBRUQsSUFBSSxtQkFBbUIsR0FBRyxVQUFVLElBQUksRUFBRSxHQUFHO1FBQ3pDLEVBQUUsQ0FBQyxDQUFDLE9BQU8scUJBQXFCLEtBQUssVUFBVSxDQUFDLENBQUMsQ0FBQztZQUM5QyxXQUFXLENBQUMscUJBQXFCLEVBQUUsSUFBSSxFQUFFLEdBQUcsQ0FBQyxDQUFBO1FBQ2pELENBQUM7UUFBQyxJQUFJLENBQUMsRUFBRSxDQUFDLENBQUMsS0FBSyxDQUFDLE9BQU8sQ0FBQyxxQkFBcUIsQ0FBQyxDQUFDLENBQUMsQ0FBQztZQUM5QyxHQUFHLENBQUMsQ0FBQyxJQUFJLFdBQVcsSUFBSSxxQkFBcUIsQ0FBQyxDQUFDLENBQUM7Z0JBQzVDLFdBQVcsQ0FBQyxxQkFBcUIsQ0FBQyxXQUFXLENBQUMsRUFBRSxJQUFJLEVBQUUsR0FBRyxDQUFDLENBQUE7WUFDOUQsQ0FBQztRQUNMLENBQUM7UUFBQyxJQUFJLENBQUMsQ0FBQztZQUNKLE1BQU0sSUFBSSxLQUFLLENBQUMsa0VBQWtFLENBQUMsQ0FBQTtRQUN2RixDQUFDO1FBQ0QsTUFBTSxDQUFDLENBQUMsQ0FBQyxHQUFHLENBQUMsWUFBWSxDQUFDLENBQUE7SUFDOUIsQ0FBQyxDQUFBO0lBRUQsSUFBSSxlQUFlLEdBQUcsS0FBSyxDQUFBO0lBQzNCLElBQUksT0FBTyxHQUFHLFVBQVUsSUFBSSxFQUFFLEdBQUcsRUFBRSxFQUFFO1FBQ2pDLE1BQU0sQ0FBQyxDQUFDLGdCQUFnQixDQUFDLENBQUMsQ0FBQztZQUN2QixLQUFLLFNBQVM7Z0JBQ1YsbUJBQW1CLENBQUMsSUFBSSxFQUFFLEdBQUcsQ0FBQyxDQUFDLElBQUksQ0FBQztvQkFDaEMsRUFBRSxDQUFDLElBQUksRUFBRSxJQUFJLENBQUMsQ0FBQTtnQkFDbEIsQ0FBQyxDQUFDLENBQUE7Z0JBQ0YsS0FBSyxDQUFBO1lBQ1QsS0FBSyxVQUFVO2dCQUNYLEVBQUUsQ0FBQyxDQUFDLGVBQWUsQ0FBQyxDQUFDLENBQUM7b0JBQ2xCLG1CQUFtQixDQUFDLElBQUksRUFBRSxHQUFHLENBQUM7eUJBQ3pCLElBQUksQ0FBQzt3QkFDRixFQUFFLENBQUMsSUFBSSxFQUFFLElBQUksQ0FBQyxDQUFBO29CQUNsQixDQUFDLENBQUMsQ0FBQTtnQkFDVixDQUFDO2dCQUFDLElBQUksQ0FBQyxDQUFDO29CQUNKLEVBQUUsQ0FBQyxJQUFJLEVBQUUsSUFBSSxDQUFDLENBQUE7Z0JBQ2xCLENBQUM7Z0JBQ0QsZUFBZSxHQUFHLElBQUksQ0FBQTtnQkFDdEIsS0FBSyxDQUFBO1lBQ1QsS0FBSyxPQUFPO2dCQUNSLEVBQUUsQ0FBQyxJQUFJLEVBQUUsSUFBSSxDQUFDLENBQUE7Z0JBQ2QsS0FBSyxDQUFBO1lBQ1Q7Z0JBQ0ksS0FBSyxDQUFBO1FBQ2IsQ0FBQztJQUNMLENBQUMsQ0FBQTtJQUVELElBQUksS0FBSyxHQUFHLFVBQVUsRUFBRTtRQUNwQixFQUFFLENBQUMsQ0FBQyxnQkFBZ0IsS0FBSyxPQUFPLENBQUMsQ0FBQyxDQUFDO1lBQy9CLG1CQUFtQixDQUFDLElBQUksRUFBRSxJQUFJLENBQUMsQ0FBQyxJQUFJLENBQUM7Z0JBQ2pDLEVBQUUsRUFBRSxDQUFBO1lBQ1IsQ0FBQyxDQUFDLENBQUE7UUFDTixDQUFDO1FBQUMsSUFBSSxDQUFDLENBQUM7WUFDSixFQUFFLEVBQUUsQ0FBQTtRQUNSLENBQUM7SUFDTCxDQUFDLENBQUE7SUFDRCxNQUFNLENBQUMsUUFBUSxDQUFDLEdBQUcsQ0FBQyxPQUFPLEVBQUUsS0FBSyxDQUFDLENBQUE7QUFDdkMsQ0FBQyxDQUFBIn0=
+exports.forEach = (funcArg) => {
+    defaultExport(funcArg, 'forEach');
+};
+exports.forFirst = (funcArg) => {
+    defaultExport(funcArg, 'forFirst');
+};
+exports.atEnd = (funcArg) => {
+    defaultExport(funcArg, 'atEnd');
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.default = defaultExport;
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi90cy9pbmRleC50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiO0FBQUEsMEJBQXVCO0FBQ3ZCLHVCQUFzQjtBQUN0QixxQ0FBb0M7QUFTcEMsSUFBSSxhQUFhLEdBQUcsQ0FDaEIscUJBQTRELEVBQzVELGdCQUFnQixHQUFtQixTQUFTO0lBRzVDLElBQUksWUFBWSxHQUFHLEVBQUUsQ0FBQTtJQUNyQixJQUFJLFdBQVcsR0FBRyxVQUFVLFdBQVcsRUFBRSxJQUFJLEVBQUUsR0FBRztRQUM5QyxJQUFJLFdBQVcsR0FBRyxXQUFXLENBQUMsSUFBSSxFQUFFLEdBQUcsQ0FBQyxDQUFBO1FBQ3hDLEVBQUUsQ0FBQyxDQUFDLE9BQU8sV0FBVyxLQUFLLFdBQVcsSUFBSSxPQUFPLFdBQVcsQ0FBQyxJQUFJLEtBQUssV0FBVyxDQUFDLENBQUMsQ0FBQztZQUNoRixZQUFZLENBQUMsSUFBSSxDQUFDLFdBQVcsQ0FBQyxDQUFBO1FBQ2xDLENBQUM7SUFDTCxDQUFDLENBQUE7SUFFRCxJQUFJLG1CQUFtQixHQUFHLFVBQVUsSUFBSSxFQUFFLEdBQUc7UUFDekMsRUFBRSxDQUFDLENBQUMsT0FBTyxxQkFBcUIsS0FBSyxVQUFVLENBQUMsQ0FBQyxDQUFDO1lBQzlDLFdBQVcsQ0FBQyxxQkFBcUIsRUFBRSxJQUFJLEVBQUUsR0FBRyxDQUFDLENBQUE7UUFDakQsQ0FBQztRQUFDLElBQUksQ0FBQyxFQUFFLENBQUMsQ0FBQyxLQUFLLENBQUMsT0FBTyxDQUFDLHFCQUFxQixDQUFDLENBQUMsQ0FBQyxDQUFDO1lBQzlDLEdBQUcsQ0FBQyxDQUFDLElBQUksV0FBVyxJQUFJLHFCQUFxQixDQUFDLENBQUMsQ0FBQztnQkFDNUMsV0FBVyxDQUFDLHFCQUFxQixDQUFDLFdBQVcsQ0FBQyxFQUFFLElBQUksRUFBRSxHQUFHLENBQUMsQ0FBQTtZQUM5RCxDQUFDO1FBQ0wsQ0FBQztRQUFDLElBQUksQ0FBQyxDQUFDO1lBQ0osTUFBTSxJQUFJLEtBQUssQ0FBQyxrRUFBa0UsQ0FBQyxDQUFBO1FBQ3ZGLENBQUM7UUFDRCxNQUFNLENBQUMsQ0FBQyxDQUFDLEdBQUcsQ0FBQyxZQUFZLENBQUMsQ0FBQTtJQUM5QixDQUFDLENBQUE7SUFFRCxJQUFJLGVBQWUsR0FBRyxLQUFLLENBQUE7SUFDM0IsSUFBSSxPQUFPLEdBQUcsVUFBVSxJQUFJLEVBQUUsR0FBRyxFQUFFLEVBQUU7UUFDakMsTUFBTSxDQUFDLENBQUMsZ0JBQWdCLENBQUMsQ0FBQyxDQUFDO1lBQ3ZCLEtBQUssU0FBUztnQkFDVixtQkFBbUIsQ0FBQyxJQUFJLEVBQUUsR0FBRyxDQUFDLENBQUMsSUFBSSxDQUFDO29CQUNoQyxFQUFFLENBQUMsSUFBSSxFQUFFLElBQUksQ0FBQyxDQUFBO2dCQUNsQixDQUFDLENBQUMsQ0FBQTtnQkFDRixLQUFLLENBQUE7WUFDVCxLQUFLLFVBQVU7Z0JBQ1gsRUFBRSxDQUFDLENBQUMsZUFBZSxDQUFDLENBQUMsQ0FBQztvQkFDbEIsbUJBQW1CLENBQUMsSUFBSSxFQUFFLEdBQUcsQ0FBQzt5QkFDekIsSUFBSSxDQUFDO3dCQUNGLEVBQUUsQ0FBQyxJQUFJLEVBQUUsSUFBSSxDQUFDLENBQUE7b0JBQ2xCLENBQUMsQ0FBQyxDQUFBO2dCQUNWLENBQUM7Z0JBQUMsSUFBSSxDQUFDLENBQUM7b0JBQ0osRUFBRSxDQUFDLElBQUksRUFBRSxJQUFJLENBQUMsQ0FBQTtnQkFDbEIsQ0FBQztnQkFDRCxlQUFlLEdBQUcsSUFBSSxDQUFBO2dCQUN0QixLQUFLLENBQUE7WUFDVCxLQUFLLE9BQU87Z0JBQ1IsRUFBRSxDQUFDLElBQUksRUFBRSxJQUFJLENBQUMsQ0FBQTtnQkFDZCxLQUFLLENBQUE7WUFDVDtnQkFDSSxLQUFLLENBQUE7UUFDYixDQUFDO0lBQ0wsQ0FBQyxDQUFBO0lBRUQsSUFBSSxLQUFLLEdBQUcsVUFBVSxFQUFFO1FBQ3BCLEVBQUUsQ0FBQyxDQUFDLGdCQUFnQixLQUFLLE9BQU8sQ0FBQyxDQUFDLENBQUM7WUFDL0IsbUJBQW1CLENBQUMsSUFBSSxFQUFFLElBQUksQ0FBQyxDQUFDLElBQUksQ0FBQztnQkFDakMsRUFBRSxFQUFFLENBQUE7WUFDUixDQUFDLENBQUMsQ0FBQTtRQUNOLENBQUM7UUFBQyxJQUFJLENBQUMsQ0FBQztZQUNKLEVBQUUsRUFBRSxDQUFBO1FBQ1IsQ0FBQztJQUNMLENBQUMsQ0FBQTtJQUNELE1BQU0sQ0FBQyxRQUFRLENBQUMsR0FBRyxDQUFDLE9BQU8sRUFBRSxLQUFLLENBQUMsQ0FBQTtBQUN2QyxDQUFDLENBQUE7QUFFVSxRQUFBLE9BQU8sR0FBRyxDQUFDLE9BQXlCO0lBQzNDLGFBQWEsQ0FBQyxPQUFPLEVBQUUsU0FBUyxDQUFDLENBQUE7QUFDckMsQ0FBQyxDQUFBO0FBRVUsUUFBQSxRQUFRLEdBQUcsQ0FBQyxPQUF5QjtJQUM1QyxhQUFhLENBQUMsT0FBTyxFQUFFLFVBQVUsQ0FBQyxDQUFBO0FBQ3RDLENBQUMsQ0FBQTtBQUVVLFFBQUEsS0FBSyxHQUFHLENBQUMsT0FBeUI7SUFDekMsYUFBYSxDQUFDLE9BQU8sRUFBRSxPQUFPLENBQUMsQ0FBQTtBQUNuQyxDQUFDLENBQUE7O0FBRUQsa0JBQWUsYUFBYSxDQUFBIn0=

package.json

@@ -1,6 +1,6 @@
 {
   "name": "gulp-function",
-  "version": "2.0.0",
+  "version": "2.2.0",
   "description": "accepts a function call as parameter to execute in gulp pipeline",
   "main": "dist/index.js",
   "typings": "dist/index.d.ts",

test/test.d.ts

@@ -1 +1 @@
-import "typings-test";
+import 'typings-test';

test/test.ts

@@ -1,118 +1,119 @@
-import "typings-test"
+import 'typings-test'
-var gulp = require("gulp");
+let gulp = require('gulp')
-var gulpFunction = require("../dist/index.js");
+import gulpFunction from '../dist/index'
-var beautylog = require("beautylog");
-var Q = require("q");
 
-var myFunction = function () {
+import * as beautylog from 'beautylog'
-    var done = Q.defer()
+let Q = require('q')
-    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;
-};
 
-var beforeFunction = function () {
+let myFunction = function () {
-    var done = Q.defer();
+    let done = Q.defer()
-    beautylog.success("beforeFunction executed");
+    beautylog.log('Function executed')
-    done.resolve();
+    done.resolve()
-    return done.promise;
+    return done.promise
-};
+}
+let myFunction2 = function () {
+    let done = Q.defer()
+    beautylog.ok('Function2 executed')
+    done.resolve()
+    return done.promise
+}
+let myFunction3 = function () {
+    let done = Q.defer()
+    beautylog.success('Function3 executed')
+    done.resolve()
+    return done.promise
+}
 
-var middleFunctionRun = false;
+let beforeFunction = function () {
+    let done = Q.defer()
+    beautylog.success('beforeFunction executed')
+    done.resolve()
+    return done.promise
+}
 
-var middleFunction = function () {
+let middleFunctionRun = false
-    var done = Q.defer();
+
-    beautylog.success("middleFunction executed");
+let middleFunction = function () {
+    let done = Q.defer()
+    beautylog.success('middleFunction executed')
     setTimeout(function(){
-        beautylog.log("timeout fired");
+        beautylog.log('timeout fired')
-        middleFunctionRun = true;
+        middleFunctionRun = true
-        done.resolve();
+        done.resolve()
-    }, 500);
+    }, 500)
-    return done.promise;
+    return done.promise
-};
+}
 
-var afterFunction = function () {
+let afterFunction = function () {
-    var done = Q.defer();
+    let done = Q.defer()
-    beautylog.success("afterFunction executed");
+    beautylog.success('afterFunction executed')
-    done.resolve();
+    done.resolve()
-    return done.promise;
+    return done.promise
-};
+}
 
 let timeoutFunction = function(){
-    var done = Q.defer();
+    let done = Q.defer()
     setTimeout(function(){
-        beautylog.log("largeTimeout fired");
+        beautylog.log('largeTimeout fired')
-        done.resolve();
+        done.resolve()
-    },2000);
+    },2000)
-    return done.promise;
+    return done.promise
-};
+}
 
 
 
-describe("gulpFunction",function(){
+describe('gulpFunction',function(){
-    it("should run through smoothly with " + "'forEach'".blue,function(done){
+    it('should run through smoothly with ' + "'forEach'",function(done){
         gulp.src('./test/*.md')
             .pipe(gulpFunction(myFunction,'forEach'))
-            .pipe(gulp.dest("./test/result/"));
+            .pipe(gulp.dest('./test/result/'))
 
         gulp.src('./test/*.md')
             .pipe(gulpFunction([myFunction2,myFunction3],'forEach'))
-            .pipe(gulp.dest("./test/result/"))
+            .pipe(gulp.dest('./test/result/'))
-            .pipe(gulpFunction(done,"atEnd"));
+            .pipe(gulpFunction(done,'atEnd'))
 
-    });
+    })
 
-    it("should run through smoothly with " + "'atEnd'".blue,function(done){
+    it('should run through smoothly with ' + "'atEnd'",function(done){
         gulp.src('./test/*.md')
             .pipe(gulpFunction(myFunction,'atEnd'))
-            .pipe(gulp.dest("./test/result/"));
+            .pipe(gulp.dest('./test/result/'))
 
         gulp.src('./test/*.md')
             .pipe(gulpFunction([myFunction2,myFunction3],'atEnd'))
-            .pipe(gulp.dest("./test/result/"))
+            .pipe(gulp.dest('./test/result/'))
-            .pipe(gulpFunction(done,"atEnd"));
+            .pipe(gulpFunction(done,'atEnd'))
-    });
+    })
 
-    it("should run through smoothly once with " + "'atFirst'".blue,function(done){
+    it('should run through smoothly once with ' + "'atFirst'",function(done){
 
         gulp.src('./test/*.md')
             .pipe(gulpFunction([myFunction2,myFunction3],'forFirst'))
-            .pipe(gulp.dest("./test/result/"))
+            .pipe(gulp.dest('./test/result/'))
-            .pipe(gulpFunction(done,"atEnd"));
+            .pipe(gulpFunction(done,'atEnd'))
-    });
+    })
 
-    it("should run in order",function(done){
+    it('should run in order',function(done){
-        this.timeout(5000);
+        this.timeout(5000)
         let stream = gulp.src('./test/*.md')
             .pipe(gulpFunction([beforeFunction,middleFunction,middleFunction],'atEnd'))
             .pipe(gulpFunction(function(){
-                beautylog.log("stream progressed");
+                beautylog.log('stream progressed')
-                var done2 = Q.defer();
+                let done2 = Q.defer()
-                done2.resolve();
+                done2.resolve()
-                return done2.promise;
+                return done2.promise
-            },"forEach"))
+            },'forEach'))
             .pipe(gulpFunction(function(){
-                beautylog.log("nextStep");
+                beautylog.log('nextStep')
             }))
-            .pipe(gulpFunction(afterFunction,"atEnd"))
+            .pipe(gulpFunction(afterFunction,'atEnd'))
-            .pipe(gulpFunction(timeoutFunction,"atEnd"));
+            .pipe(gulpFunction(timeoutFunction,'atEnd'))
 
-        stream.on("finish",function(){
+        stream.on('finish',function(){
-            beautylog.info("stream finished");
+            beautylog.info('stream finished')
-            done();
+            done()
-        });
+        })
-    });
+    })
-});
+})
 

ts/index.ts

@@ -9,7 +9,7 @@ export interface IPromiseFunction {
     (file?, enc?): PromiseLike<any>
 }
 
-module.exports = (
+let defaultExport = (
     functionsToExecuteArg: IPromiseFunction | IPromiseFunction[],
     executionModeArg: TExecutionMode = 'forEach'
 ): Transform => {
@@ -73,3 +73,17 @@ module.exports = (
     }
     return through2.obj(forEach, atEnd)
 }
+
+export let forEach = (funcArg: IPromiseFunction) => {
+    defaultExport(funcArg, 'forEach')
+}
+
+export let forFirst = (funcArg: IPromiseFunction) => {
+    defaultExport(funcArg, 'forFirst')
+}
+
+export let atEnd = (funcArg: IPromiseFunction) => {
+    defaultExport(funcArg, 'atEnd')
+}
+
+export default defaultExport