3.0.7

Fix sample code in README.md

See merge request pushrocks/gulp-function!2

.gitea/workflows/default_nottags.yaml

@@ -0,0 +1,66 @@
+name: Default (not tags)
+
+on:
+  push:
+    tags-ignore:
+      - '**'
+
+env:
+  IMAGE: registry.gitlab.com/hosttoday/ht-docker-node:npmci
+  NPMCI_COMPUTED_REPOURL: https://${{gitea.repository_owner}}:${{secrets.GITEA_TOKEN}}@gitea.lossless.digital/${{gitea.repository}}.git
+  NPMCI_TOKEN_NPM: ${{secrets.NPMCI_TOKEN_NPM}}
+  NPMCI_TOKEN_NPM2: ${{secrets.NPMCI_TOKEN_NPM2}}
+  NPMCI_GIT_GITHUBTOKEN: ${{secrets.NPMCI_GIT_GITHUBTOKEN}}
+  NPMCI_URL_CLOUDLY: ${{secrets.NPMCI_URL_CLOUDLY}}
+
+jobs:
+  security:
+    runs-on: ubuntu-latest
+    continue-on-error: true
+    container:
+      image: ${{ env.IMAGE }}
+
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Install pnpm and npmci
+        run: |
+          pnpm install -g pnpm
+          pnpm install -g @shipzone/npmci
+
+      - name: Run npm prepare
+        run: npmci npm prepare
+
+      - name: Audit production dependencies
+        run: |
+          npmci command npm config set registry https://registry.npmjs.org
+          npmci command pnpm audit --audit-level=high --prod
+        continue-on-error: true
+
+      - name: Audit development dependencies
+        run: |
+          npmci command npm config set registry https://registry.npmjs.org
+          npmci command pnpm audit --audit-level=high --dev
+        continue-on-error: true
+
+  test:
+    if: ${{ always() }}
+    needs: security
+    runs-on: ubuntu-latest
+    container:
+      image: ${{ env.IMAGE }}
+
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Test stable
+        run: |
+          npmci node install stable
+          npmci npm install
+          npmci npm test
+
+      - name: Test build
+        run: |
+          npmci node install stable
+          npmci npm install
+          npmci npm build

.gitea/workflows/default_tags.yaml

@@ -0,0 +1,124 @@
+name: Default (tags)
+
+on:
+  push:
+    tags:
+      - '*'
+
+env:
+  IMAGE: registry.gitlab.com/hosttoday/ht-docker-node:npmci
+  NPMCI_COMPUTED_REPOURL: https://${{gitea.repository_owner}}:${{secrets.GITEA_TOKEN}}@gitea.lossless.digital/${{gitea.repository}}.git
+  NPMCI_TOKEN_NPM: ${{secrets.NPMCI_TOKEN_NPM}}
+  NPMCI_TOKEN_NPM2: ${{secrets.NPMCI_TOKEN_NPM2}}
+  NPMCI_GIT_GITHUBTOKEN: ${{secrets.NPMCI_GIT_GITHUBTOKEN}}
+  NPMCI_URL_CLOUDLY: ${{secrets.NPMCI_URL_CLOUDLY}}
+
+jobs:
+  security:
+    runs-on: ubuntu-latest
+    continue-on-error: true
+    container:
+      image: ${{ env.IMAGE }}
+
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Prepare
+        run: |
+          pnpm install -g pnpm
+          pnpm install -g @shipzone/npmci
+          npmci npm prepare
+
+      - name: Audit production dependencies
+        run: |
+          npmci command npm config set registry https://registry.npmjs.org
+          npmci command pnpm audit --audit-level=high --prod
+        continue-on-error: true
+
+      - name: Audit development dependencies
+        run: |
+          npmci command npm config set registry https://registry.npmjs.org
+          npmci command pnpm audit --audit-level=high --dev
+        continue-on-error: true
+
+  test:
+    if: ${{ always() }}
+    needs: security
+    runs-on: ubuntu-latest
+    container:
+      image: ${{ env.IMAGE }}
+
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Prepare
+        run: |
+          pnpm install -g pnpm
+          pnpm install -g @shipzone/npmci
+          npmci npm prepare
+
+      - name: Test stable
+        run: |
+          npmci node install stable
+          npmci npm install
+          npmci npm test
+
+      - name: Test build
+        run: |
+          npmci node install stable
+          npmci npm install
+          npmci npm build
+
+  release:
+    needs: test
+    if: github.event_name == 'push' && startsWith(github.ref, 'refs/tags/')
+    runs-on: ubuntu-latest
+    container:
+      image: ${{ env.IMAGE }}
+
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Prepare
+        run: |
+          pnpm install -g pnpm
+          pnpm install -g @shipzone/npmci
+          npmci npm prepare
+
+      - name: Release
+        run: |
+          npmci node install stable
+          npmci npm publish
+
+  metadata:
+    needs: test
+    if: github.event_name == 'push' && startsWith(github.ref, 'refs/tags/')
+    runs-on: ubuntu-latest
+    container:
+      image: ${{ env.IMAGE }}
+    continue-on-error: true
+
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Prepare
+        run: |
+          pnpm install -g pnpm
+          pnpm install -g @shipzone/npmci
+          npmci npm prepare
+
+      - name: Code quality
+        run: |
+          npmci command npm install -g typescript
+          npmci npm install
+
+      - name: Trigger
+        run: npmci trigger
+
+      - name: Build docs and upload artifacts
+        run: |
+          npmci node install stable
+          npmci npm install
+          pnpm install -g @git.zone/tsdoc
+          npmci command tsdoc
+        continue-on-error: true

.gitignore

@@ -1,13 +1,20 @@
-node_modules/
+.nogit/
-.settings/
+
-.idea/
+# artifacts
 coverage/
-docs/
 public/
 pages/
 
-ts/*.js
+# installs
-ts/*.js.map
+node_modules/
-ts/typings/
-test/result/
 
+# caches
+.yarn/
+.cache/
+.rpt2_cache
+
+# builds
+dist/
+dist_*/
+
+# custom

.gitlab-ci.yml

@@ -1,53 +0,0 @@
-image: hosttoday/ht-docker-node:npmts
-stages:
-- test
-- release
-- trigger
-- pages
-testLEGACY:
-  stage: test
-  script:
-    - npmci test legacy
-  tags:
-    - docker
-  allow_failure: true
-testLTS:
-  stage: test
-  script:
-    - npmci test lts
-  tags:
-    - docker
-    
-testSTABLE:
-  stage: test
-  script:
-    - npmci test stable
-  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:npmpage
-  stage: pages
-  script:
-    - npmci command npmpage --host gitlab
-  only:
-    - tags
-  artifacts:
-    expire_in: 1 week
-    paths:
-    - public

.vscode/launch.json

@@ -0,0 +1,11 @@
+{
+  "version": "0.2.0",
+  "configurations": [
+    {
+      "command": "npm test",
+      "name": "Run npm test",
+      "request": "launch",
+      "type": "node-terminal"
+    }
+  ]
+}

.vscode/settings.json

@@ -0,0 +1,26 @@
+{
+  "json.schemas": [
+    {
+      "fileMatch": ["/npmextra.json"],
+      "schema": {
+        "type": "object",
+        "properties": {
+          "npmci": {
+            "type": "object",
+            "description": "settings for npmci"
+          },
+          "gitzone": {
+            "type": "object",
+            "description": "settings for gitzone",
+            "properties": {
+              "projectType": {
+                "type": "string",
+                "enum": ["website", "element", "service", "npm", "wcc"]
+              }
+            }
+          }
+        }
+      }
+    }
+  ]
+}

LICENSE.md

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2015 Push.Rocks
+Copyright (c) 2015 Lossless GmbH
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -1,59 +0,0 @@
-# gulp-function
-accepts call to execute in gulp pipeline.
-
-## 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)
-[![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/)
-
-### Usage
-```javascript
-let gulp = require("gulp");
-let gulpFunction = require("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(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**!!!
-
-[![npm](https://push.rocks/assets/repo-header.svg)](https://push.rocks)

dist/index.d.ts

@@ -1,5 +0,0 @@
-import 'typings-global';
-export declare type TExecutionMode = 'forEach' | 'forFirst' | 'atEnd';
-export interface IPromiseFunction {
-    (file?: any, enc?: any): PromiseLike<any>;
-}

dist/index.js

@@ -1,66 +0,0 @@
-"use strict";
-require("typings-global");
-const q = require("q");
-const through2 = require("through2");
-module.exports = (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 q.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);
-};
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi90cy9pbmRleC50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiO0FBQUEsMEJBQXVCO0FBQ3ZCLHVCQUFzQjtBQUN0QixxQ0FBb0M7QUFTcEMsTUFBTSxDQUFDLE9BQU8sR0FBRyxDQUNiLHFCQUE0RCxFQUM1RCxnQkFBZ0IsR0FBbUIsU0FBUztJQUc1QyxJQUFJLFlBQVksR0FBRyxFQUFFLENBQUE7SUFDckIsSUFBSSxXQUFXLEdBQUcsVUFBVSxXQUFXLEVBQUUsSUFBSSxFQUFFLEdBQUc7UUFDOUMsSUFBSSxXQUFXLEdBQUcsV0FBVyxDQUFDLElBQUksRUFBRSxHQUFHLENBQUMsQ0FBQTtRQUN4QyxFQUFFLENBQUMsQ0FBQyxPQUFPLFdBQVcsS0FBSyxXQUFXLElBQUksT0FBTyxXQUFXLENBQUMsSUFBSSxLQUFLLFdBQVcsQ0FBQyxDQUFDLENBQUM7WUFDaEYsWUFBWSxDQUFDLElBQUksQ0FBQyxXQUFXLENBQUMsQ0FBQTtRQUNsQyxDQUFDO0lBQ0wsQ0FBQyxDQUFBO0lBRUQsSUFBSSxtQkFBbUIsR0FBRyxVQUFVLElBQUksRUFBRSxHQUFHO1FBQ3pDLEVBQUUsQ0FBQyxDQUFDLE9BQU8scUJBQXFCLEtBQUssVUFBVSxDQUFDLENBQUMsQ0FBQztZQUM5QyxXQUFXLENBQUMscUJBQXFCLEVBQUUsSUFBSSxFQUFFLEdBQUcsQ0FBQyxDQUFBO1FBQ2pELENBQUM7UUFBQyxJQUFJLENBQUMsRUFBRSxDQUFDLENBQUMsS0FBSyxDQUFDLE9BQU8sQ0FBQyxxQkFBcUIsQ0FBQyxDQUFDLENBQUMsQ0FBQztZQUM5QyxHQUFHLENBQUMsQ0FBQyxJQUFJLFdBQVcsSUFBSSxxQkFBcUIsQ0FBQyxDQUFDLENBQUM7Z0JBQzVDLFdBQVcsQ0FBQyxxQkFBcUIsQ0FBQyxXQUFXLENBQUMsRUFBRSxJQUFJLEVBQUUsR0FBRyxDQUFDLENBQUE7WUFDOUQsQ0FBQztRQUNMLENBQUM7UUFBQyxJQUFJLENBQUMsQ0FBQztZQUNKLE1BQU0sSUFBSSxLQUFLLENBQUMsa0VBQWtFLENBQUMsQ0FBQTtRQUN2RixDQUFDO1FBQ0QsTUFBTSxDQUFDLENBQUMsQ0FBQyxHQUFHLENBQUMsWUFBWSxDQUFDLENBQUE7SUFDOUIsQ0FBQyxDQUFBO0lBRUQsSUFBSSxlQUFlLEdBQUcsS0FBSyxDQUFBO0lBQzNCLElBQUksT0FBTyxHQUFHLFVBQVUsSUFBSSxFQUFFLEdBQUcsRUFBRSxFQUFFO1FBQ2pDLE1BQU0sQ0FBQyxDQUFDLGdCQUFnQixDQUFDLENBQUMsQ0FBQztZQUN2QixLQUFLLFNBQVM7Z0JBQ1YsbUJBQW1CLENBQUMsSUFBSSxFQUFFLEdBQUcsQ0FBQyxDQUFDLElBQUksQ0FBQztvQkFDaEMsRUFBRSxDQUFDLElBQUksRUFBRSxJQUFJLENBQUMsQ0FBQTtnQkFDbEIsQ0FBQyxDQUFDLENBQUE7Z0JBQ0YsS0FBSyxDQUFBO1lBQ1QsS0FBSyxVQUFVO2dCQUNYLEVBQUUsQ0FBQyxDQUFDLGVBQWUsQ0FBQyxDQUFDLENBQUM7b0JBQ2xCLG1CQUFtQixDQUFDLElBQUksRUFBRSxHQUFHLENBQUM7eUJBQ3pCLElBQUksQ0FBQzt3QkFDRixFQUFFLENBQUMsSUFBSSxFQUFFLElBQUksQ0FBQyxDQUFBO29CQUNsQixDQUFDLENBQUMsQ0FBQTtnQkFDVixDQUFDO2dCQUFDLElBQUksQ0FBQyxDQUFDO29CQUNKLEVBQUUsQ0FBQyxJQUFJLEVBQUUsSUFBSSxDQUFDLENBQUE7Z0JBQ2xCLENBQUM7Z0JBQ0QsZUFBZSxHQUFHLElBQUksQ0FBQTtnQkFDdEIsS0FBSyxDQUFBO1lBQ1QsS0FBSyxPQUFPO2dCQUNSLEVBQUUsQ0FBQyxJQUFJLEVBQUUsSUFBSSxDQUFDLENBQUE7Z0JBQ2QsS0FBSyxDQUFBO1lBQ1Q7Z0JBQ0ksS0FBSyxDQUFBO1FBQ2IsQ0FBQztJQUNMLENBQUMsQ0FBQTtJQUVELElBQUksS0FBSyxHQUFHLFVBQVUsRUFBRTtRQUNwQixFQUFFLENBQUMsQ0FBQyxnQkFBZ0IsS0FBSyxPQUFPLENBQUMsQ0FBQyxDQUFDO1lBQy9CLG1CQUFtQixDQUFDLElBQUksRUFBRSxJQUFJLENBQUMsQ0FBQyxJQUFJLENBQUM7Z0JBQ2pDLEVBQUUsRUFBRSxDQUFBO1lBQ1IsQ0FBQyxDQUFDLENBQUE7UUFDTixDQUFDO1FBQUMsSUFBSSxDQUFDLENBQUM7WUFDSixFQUFFLEVBQUUsQ0FBQTtRQUNSLENBQUM7SUFDTCxDQUFDLENBQUE7SUFDRCxNQUFNLENBQUMsUUFBUSxDQUFDLEdBQUcsQ0FBQyxPQUFPLEVBQUUsS0FBSyxDQUFDLENBQUE7QUFDdkMsQ0FBQyxDQUFBIn0=

npmextra.json

@@ -1,5 +1,20 @@
 {
   "npmts": {
     "mode": "default"
+  },
+  "npmci": {
+    "npmGlobalTools": [],
+    "npmAccessLevel": "public"
+  },
+  "gitzone": {
+    "projectType": "npm",
+    "module": {
+      "githost": "gitlab.com",
+      "gitscope": "push.rocks",
+      "gitrepo": "gulp-function",
+      "description": "accepts a function call as parameter to execute in gulp pipeline",
+      "npmPackagename": "@push.rocks/gulp-function",
+      "license": "MIT"
+    }
   }
 }

package.json

@@ -1,41 +1,58 @@
 {
-  "name": "gulp-function",
+  "name": "@push.rocks/gulp-function",
-  "version": "2.0.2",
+  "private": false,
+  "version": "3.0.7",
   "description": "accepts a function call as parameter to execute in gulp pipeline",
-  "main": "dist/index.js",
+  "main": "dist_ts/index.js",
-  "typings": "dist/index.d.ts",
+  "typings": "dist_ts/index.d.ts",
   "scripts": {
-    "test": "(npmts)",
+    "test": "(tstest test/)",
-    "reinstall": "(rm -r node_modules && npm install)",
+    "build": "(tsbuild --allowimplicitany)",
-    "release": "(git pull origin master && npm version patch && git push origin master && git checkout release && git merge master && git push origin release && git checkout master)",
+    "buildDocs": "tsdoc"
-    "startdev": "(git checkout master && git pull origin master)"
   },
   "repository": {
     "type": "git",
-    "url": "https://gitlab.com/pushrocks/gulp-function.git"
+    "url": "git+https://gitlab.com/push.rocks/gulp-function.git"
   },
   "keywords": [
     "gulpplugin",
     "gulp",
-    "function"
+    "function",
+    "pushrocks"
   ],
   "author": "Lossless GmbH <office@lossless.com> (https://lossless.com)",
   "license": "MIT",
   "bugs": {
-    "url": "https://gitlab.com/pushrocks/gulp-function/issues"
+    "url": "https://gitlab.com/push.rocks/gulp-function/issues"
   },
-  "homepage": "https://gitlab.com/pushrocks/gulp-function",
+  "homepage": "https://gitlab.com/push.rocks/gulp-function#readme",
   "dependencies": {
-    "@types/q": "0.0.32",
+    "@push.rocks/smartpromise": "^4.0.3",
-    "@types/through2": "^2.0.31",
+    "@types/through2": "^2.0.32",
-    "q": "^1.4.1",
+    "through2": "^3.0.1"
-    "through2": "^2.0.1",
-    "typings-global": "^1.0.14"
   },
   "devDependencies": {
-    "beautylog": "^6.0.0",
+    "@git.zone/tsbuild": "^2.1.17",
-    "gulp": "^3.9.1",
+    "@git.zone/tsrun": "^1.2.46",
-    "npmts-g": "^5.2.8",
+    "@git.zone/tstest": "^1.0.28",
-    "typings-test": "^1.0.3"
+    "@push.rocks/smartgulp": "^3.0.3",
-  }
+    "@push.rocks/tapbundle": "^5.0.15",
+    "gulp": "^4.0.2"
+  },
+  "files": [
+    "ts/**/*",
+    "ts_web/**/*",
+    "dist/**/*",
+    "dist_*/**/*",
+    "dist_ts/**/*",
+    "dist_ts_web/**/*",
+    "assets/**/*",
+    "cli.js",
+    "npmextra.json",
+    "readme.md"
+  ],
+  "type": "module",
+  "browserslist": [
+    "last 1 chrome versions"
+  ]
 }

readme.md

@@ -0,0 +1,64 @@
+# @push.rocks/gulp-function
+accepts a function call as parameter to execute in gulp pipeline
+
+## Availabililty and Links
+* [npmjs.org (npm package)](https://www.npmjs.com/package/@push.rocks/gulp-function)
+* [gitlab.com (source)](https://gitlab.com/pushrocks/gulp-function)
+* [github.com (source mirror)](https://github.com/pushrocks/gulp-function)
+* [docs (typedoc)](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/@push.rocks/gulp-function.svg)](https://www.npmjs.com/package/@push.rocks/gulp-function)
+[![Known Vulnerabilities](https://snyk.io/test/npm/@push.rocks/gulp-function/badge.svg)](https://snyk.io/test/npm/@push.rocks/gulp-function)
+[![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/)
+
+## Usage
+
+Please use TypeScript for best in class intellisense.
+
+```typescript
+import gulp = require('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(myAsyncFunction, 'forEach')) //read the notes below
+    // .pipe(forEach(myAsyncFunction)) // 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**!!!
+
+## Contribution
+
+We are always happy for code contributions. If you are not the code contributing type that is ok. Still, maintaining Open Source repositories takes considerable time and thought. If you like the quality of what we do and our modules are useful to you we would appreciate a little monthly contribution: You can [contribute one time](https://lossless.link/contribute-onetime) or [contribute monthly](https://lossless.link/contribute). :)
+
+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)
+
+[![repo-footer](https://lossless.gitlab.io/publicrelations/repofooter.svg)](https://maintainedby.lossless.com)

test/test.d.ts

@@ -1 +0,0 @@
-import "typings-test";

test/test.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"test.js","sourceRoot":"","sources":["test.ts"],"names":[],"mappings":"AAAA,gDAAgD;AAChD,IAAI,IAAI,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC;AAC3B,IAAI,YAAY,GAAG,OAAO,CAAC,kBAAkB,CAAC,CAAC;AAC/C,IAAI,SAAS,GAAG,OAAO,CAAC,WAAW,CAAC,CAAC;AACrC,IAAI,CAAC,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC;AAErB,IAAI,UAAU,GAAG;IACb,IAAI,IAAI,GAAG,CAAC,CAAC,KAAK,EAAE,CAAA;IACpB,SAAS,CAAC,GAAG,CAAC,mBAAmB,CAAC,CAAC;IACnC,IAAI,CAAC,OAAO,EAAE,CAAC;IACf,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC;AACxB,CAAC,CAAC;AACF,IAAI,WAAW,GAAG;IACd,IAAI,IAAI,GAAG,CAAC,CAAC,KAAK,EAAE,CAAC;IACrB,SAAS,CAAC,EAAE,CAAC,oBAAoB,CAAC,CAAC;IACnC,IAAI,CAAC,OAAO,EAAE,CAAC;IACf,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC;AACxB,CAAC,CAAC;AACF,IAAI,WAAW,GAAG;IACd,IAAI,IAAI,GAAG,CAAC,CAAC,KAAK,EAAE,CAAC;IACrB,SAAS,CAAC,OAAO,CAAC,oBAAoB,CAAC,CAAC;IACxC,IAAI,CAAC,OAAO,EAAE,CAAC;IACf,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC;AACxB,CAAC,CAAC;AAEF,IAAI,cAAc,GAAG;IACjB,IAAI,IAAI,GAAG,CAAC,CAAC,KAAK,EAAE,CAAC;IACrB,SAAS,CAAC,OAAO,CAAC,yBAAyB,CAAC,CAAC;IAC7C,IAAI,CAAC,OAAO,EAAE,CAAC;IACf,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC;AACxB,CAAC,CAAC;AAEF,IAAI,iBAAiB,GAAG,KAAK,CAAC;AAE9B,IAAI,cAAc,GAAG;IACjB,IAAI,IAAI,GAAG,CAAC,CAAC,KAAK,EAAE,CAAC;IACrB,SAAS,CAAC,OAAO,CAAC,yBAAyB,CAAC,CAAC;IAC7C,UAAU,CAAC;QACP,SAAS,CAAC,GAAG,CAAC,eAAe,CAAC,CAAC;QAC/B,iBAAiB,GAAG,IAAI,CAAC;QACzB,IAAI,CAAC,OAAO,EAAE,CAAC;IACnB,CAAC,EAAE,GAAG,CAAC,CAAC;IACR,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC;AACxB,CAAC,CAAC;AAEF,IAAI,aAAa,GAAG;IAChB,IAAI,IAAI,GAAG,CAAC,CAAC,KAAK,EAAE,CAAC;IACrB,SAAS,CAAC,OAAO,CAAC,wBAAwB,CAAC,CAAC;IAC5C,IAAI,CAAC,OAAO,EAAE,CAAC;IACf,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC;AACxB,CAAC,CAAC;AAEF,IAAI,eAAe,GAAG;IAClB,IAAI,IAAI,GAAG,CAAC,CAAC,KAAK,EAAE,CAAC;IACrB,UAAU,CAAC;QACP,SAAS,CAAC,GAAG,CAAC,oBAAoB,CAAC,CAAC;QACpC,IAAI,CAAC,OAAO,EAAE,CAAC;IACnB,CAAC,EAAC,IAAI,CAAC,CAAC;IACR,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC;AACxB,CAAC,CAAC;AAIF,QAAQ,CAAC,cAAc,EAAC;IACpB,EAAE,CAAC,mCAAmC,GAAG,WAAW,CAAC,IAAI,EAAC,UAAS,IAAI;QACnE,IAAI,CAAC,GAAG,CAAC,aAAa,CAAC;aAClB,IAAI,CAAC,YAAY,CAAC,UAAU,EAAC,SAAS,CAAC,CAAC;aACxC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,gBAAgB,CAAC,CAAC,CAAC;QAEvC,IAAI,CAAC,GAAG,CAAC,aAAa,CAAC;aAClB,IAAI,CAAC,YAAY,CAAC,CAAC,WAAW,EAAC,WAAW,CAAC,EAAC,SAAS,CAAC,CAAC;aACvD,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,gBAAgB,CAAC,CAAC;aACjC,IAAI,CAAC,YAAY,CAAC,IAAI,EAAC,OAAO,CAAC,CAAC,CAAC;IAE1C,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,mCAAmC,GAAG,SAAS,CAAC,IAAI,EAAC,UAAS,IAAI;QACjE,IAAI,CAAC,GAAG,CAAC,aAAa,CAAC;aAClB,IAAI,CAAC,YAAY,CAAC,UAAU,EAAC,OAAO,CAAC,CAAC;aACtC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,gBAAgB,CAAC,CAAC,CAAC;QAEvC,IAAI,CAAC,GAAG,CAAC,aAAa,CAAC;aAClB,IAAI,CAAC,YAAY,CAAC,CAAC,WAAW,EAAC,WAAW,CAAC,EAAC,OAAO,CAAC,CAAC;aACrD,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,gBAAgB,CAAC,CAAC;aACjC,IAAI,CAAC,YAAY,CAAC,IAAI,EAAC,OAAO,CAAC,CAAC,CAAC;IAC1C,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,wCAAwC,GAAG,WAAW,CAAC,IAAI,EAAC,UAAS,IAAI;QAExE,IAAI,CAAC,GAAG,CAAC,aAAa,CAAC;aAClB,IAAI,CAAC,YAAY,CAAC,CAAC,WAAW,EAAC,WAAW,CAAC,EAAC,UAAU,CAAC,CAAC;aACxD,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,gBAAgB,CAAC,CAAC;aACjC,IAAI,CAAC,YAAY,CAAC,IAAI,EAAC,OAAO,CAAC,CAAC,CAAC;IAC1C,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,qBAAqB,EAAC,UAAS,IAAI;QAClC,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;QACnB,IAAI,MAAM,GAAG,IAAI,CAAC,GAAG,CAAC,aAAa,CAAC;aAC/B,IAAI,CAAC,YAAY,CAAC,CAAC,cAAc,EAAC,cAAc,EAAC,cAAc,CAAC,EAAC,OAAO,CAAC,CAAC;aAC1E,IAAI,CAAC,YAAY,CAAC;YACf,SAAS,CAAC,GAAG,CAAC,mBAAmB,CAAC,CAAC;YACnC,IAAI,KAAK,GAAG,CAAC,CAAC,KAAK,EAAE,CAAC;YACtB,KAAK,CAAC,OAAO,EAAE,CAAC;YAChB,MAAM,CAAC,KAAK,CAAC,OAAO,CAAC;QACzB,CAAC,EAAC,SAAS,CAAC,CAAC;aACZ,IAAI,CAAC,YAAY,CAAC;YACf,SAAS,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC;QAC9B,CAAC,CAAC,CAAC;aACF,IAAI,CAAC,YAAY,CAAC,aAAa,EAAC,OAAO,CAAC,CAAC;aACzC,IAAI,CAAC,YAAY,CAAC,eAAe,EAAC,OAAO,CAAC,CAAC,CAAC;QAEjD,MAAM,CAAC,EAAE,CAAC,QAAQ,EAAC;YACf,SAAS,CAAC,IAAI,CAAC,iBAAiB,CAAC,CAAC;YAClC,IAAI,EAAE,CAAC;QACX,CAAC,CAAC,CAAC;IACP,CAAC,CAAC,CAAC;AACP,CAAC,CAAC,CAAC"}

test/test.ts

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

test/test01.md

@@ -1,2 +0,0 @@
-# Test.md
-This is a test file for the test.js gulp pipeline

test/test02.md

@@ -1,2 +0,0 @@
-# Test.md
-This is another test file for the test.js gulp pipeline

test/testfiles/test01.md

@@ -0,0 +1 @@
+# the 1st testfile

test/testfiles/test02.md

@@ -0,0 +1 @@
+# the second testfile

test/testfiles/test03.md

@@ -0,0 +1 @@
+# the third testfile

test/testfiles/test04.md

@@ -0,0 +1 @@
+# the fourth testfile

test/testfiles/test05.md

@@ -0,0 +1 @@
+# the fifth testfile

test/testfiles/test06.md

@@ -0,0 +1 @@
+# the sixth testfile

test/testfiles/test07.md

@@ -0,0 +1 @@
+# the seventh testfile

test/testfiles/test08.md

@@ -0,0 +1 @@
+# the eighth testfile

test/testfiles/test09.md

@@ -0,0 +1 @@
+# the nineth testfile

test/testfiles/test10.md

@@ -0,0 +1 @@
+# the tenth testfile

test/testfiles/test11.md

@@ -0,0 +1 @@
+# the eleventh testfile

test/testfiles/test12.md

@@ -0,0 +1 @@
+# the twelveth testfile

test/testfiles/test13.md

@@ -0,0 +1 @@
+# the second testfile

test/testfiles/test14.md

@@ -0,0 +1 @@
+# the second testfile

test/testfiles/test15.md

@@ -0,0 +1 @@
+# the second testfile

test/testfiles/test16.md

@@ -0,0 +1 @@
+# the second testfile

test/testfiles/test17.md

@@ -0,0 +1 @@
+# the second testfile

test/testfiles/test18.md

@@ -0,0 +1 @@
+# the 18th testfile

ts/00_commitinfo_data.ts

@@ -0,0 +1,8 @@
+/**
+ * autocreated commitinfo by @pushrocks/commitinfo
+ */
+export const commitinfo = {
+  name: '@push.rocks/gulp-function',
+  version: '3.0.7',
+  description: 'accepts a function call as parameter to execute in gulp pipeline'
+}

ts/index.ts

@@ -1,75 +1,87 @@
-import 'typings-global'
+import * as smartpromise from '@push.rocks/smartpromise';
-import * as q from 'q'
+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>;
 }
 
-module.exports = (
+let defaultExport = (
   functionsToExecuteArg: IPromiseFunction | IPromiseFunction[],
   executionModeArg: TExecutionMode = 'forEach'
 ): Transform => {
-
+  let promiseArray = [];
-    let promiseArray = []
   let runFunction = function(functionArg, file, enc) {
-        let returnValue = functionArg(file, enc)
+    let returnValue = functionArg(file, enc);
     if (typeof returnValue !== 'undefined' && typeof returnValue.then !== 'undefined') {
-            promiseArray.push(returnValue)
+      promiseArray.push(returnValue);
-        }
     }
+  };
 
   let checkAndRunFunction = function(file, enc) {
     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 q.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':
         checkAndRunFunction(file, enc).then(function() {
-                    cb(null, file)
+          cb(null, file);
-                })
+        });
-                break
+        break;
       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':
-                cb(null, file)
+        cb();
-                break
+        break;
       default:
-                break
+        break;
-        }
     }
+  };
 
   let atEnd = function(cb) {
     if (executionModeArg === 'atEnd') {
       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');
+};
+
+export let forFirst = (funcArg: IPromiseFunction) => {
+  return defaultExport(funcArg, 'forFirst');
+};
+
+export let atEnd = (funcArg: IPromiseFunction) => {
+  return defaultExport(funcArg, 'atEnd');
+};
+
+export default defaultExport;

tsconfig.json

@@ -0,0 +1,14 @@
+{
+  "compilerOptions": {
+    "experimentalDecorators": true,
+    "useDefineForClassFields": false,
+    "target": "ES2022",
+    "module": "NodeNext",
+    "moduleResolution": "NodeNext",
+    "esModuleInterop": true,
+    "verbatimModuleSyntax": true
+  },
+  "exclude": [
+    "dist_*/**/*.d.ts"
+  ]
+}

tslint.json

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