3.0.6

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,5 +1,20 @@
-node_modules/
+.nogit/
+
+# artifacts
 coverage/
 public/
 pages/
 
+# installs
+node_modules/
+
+# caches
+.yarn/
+.cache/
+.rpt2_cache
+
+# builds
+dist/
+dist_*/
+
+# custom

.gitlab-ci.yml

@@ -1,86 +0,0 @@
-# gitzone standard
-image: hosttoday/ht-docker-node:npmci
-
-cache:
-  paths:
-  - .yarn/
-  key: "$CI_BUILD_STAGE"
-
-stages:
-- mirror
-- test
-- release
-- trigger
-- pages
-
-mirror:
-  stage: mirror
-  script:
-  - npmci git mirror
-  tags:
-  - docker
-
-testLEGACY:
-  stage: test
-  script:
-  - npmci node install legacy
-  - npmci npm install
-  - npmci npm test
-  coverage: /\d+.?\d+?\%\s*coverage/
-  tags:
-  - docker
-  allow_failure: true
-
-testLTS:
-  stage: test
-  script:
-  - npmci node install lts
-  - npmci npm install
-  - npmci npm test
-  coverage: /\d+.?\d+?\%\s*coverage/
-  tags:
-  - docker
-    
-testSTABLE:
-  stage: test
-  script:
-  - npmci node install stable
-  - npmci npm install
-  - npmci npm test
-  coverage: /\d+.?\d+?\%\s*coverage/
-  tags:
-  - docker
-
-release:
-  stage: release
-  script:
-  - npmci npm prepare
-  - npmci npm 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

.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,63 +0,0 @@
-# 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)
-[![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
-
-```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)
-
-[![repo-footer](https://pushrocks.gitlab.io/assets/repo-footer.svg)](https://push.rocks)

dist/index.d.ts

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

dist/index.js

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

npmextra.json

@@ -3,8 +3,18 @@
     "mode": "default"
   },
   "npmci": {
-    "globalNpmTools": [
-      "npmts"
-    ]
+    "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,15 +1,18 @@
 {
-  "name": "gulp-function",
-  "version": "2.2.12",
+  "name": "@push.rocks/gulp-function",
+  "private": false,
+  "version": "3.0.6",
   "description": "accepts a function call as parameter to execute in gulp pipeline",
-  "main": "dist/index.js",
-  "typings": "dist/index.d.ts",
+  "main": "dist_ts/index.js",
+  "typings": "dist_ts/index.d.ts",
   "scripts": {
-    "test": "(npmts)"
+    "test": "(tstest test/)",
+    "build": "(tsbuild)",
+    "buildDocs": "tsdoc"
   },
   "repository": {
     "type": "git",
-    "url": "https://gitlab.com/pushrocks/gulp-function.git"
+    "url": "git+https://gitlab.com/push.rocks/gulp-function.git"
   },
   "keywords": [
     "gulpplugin",
@@ -20,17 +23,36 @@
   "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": {
+    "@push.rocks/smartpromise": "^4.0.3",
     "@types/through2": "^2.0.32",
-    "smartq": "^1.1.6",
-    "through2": "^2.0.3"
+    "through2": "^3.0.1"
   },
   "devDependencies": {
-    "gulp": "^3.9.1",
-    "smartgulp": "^1.0.1",
-    "tapbundle": "^1.0.10"
-  }
+    "@git.zone/tsbuild": "^2.1.17",
+    "@git.zone/tsrun": "^1.2.46",
+    "@git.zone/tstest": "^1.0.28",
+    "@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.ts

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

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.6',
+  description: 'accepts a function call as parameter to execute in gulp pipeline'
+}

ts/index.ts

@@ -1,8 +1,8 @@
-import * as q from "smartq";
-import * as through2 from "through2";
-import { Transform } from "stream";
+import * as smartpromise from '@push.rocks/smartpromise';
+import * as through2 from 'through2';
+import { Transform } from 'stream';
 
-export type TExecutionMode = "forEach" | "forFirst" | "atEnd";
+export type TExecutionMode = 'forEach' | 'forFirst' | 'atEnd';
 
 export interface IPromiseFunction {
   (file?, enc?): PromiseLike<any>;
@@ -10,30 +10,25 @@ export interface IPromiseFunction {
 
 let defaultExport = (
   functionsToExecuteArg: IPromiseFunction | IPromiseFunction[],
-  executionModeArg: TExecutionMode = "forEach"
+  executionModeArg: TExecutionMode = 'forEach'
 ): Transform => {
   let promiseArray = [];
   let runFunction = function(functionArg, file, enc) {
     let returnValue = functionArg(file, enc);
-    if (
-      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)) {
       for (let anyFunction in functionsToExecuteArg) {
         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);
   };
@@ -42,12 +37,12 @@ let defaultExport = (
   let forEach = function(file, enc, cb) {
     // the forEach function is called for every chunk
     switch (executionModeArg) {
-      case "forEach":
+      case 'forEach':
         checkAndRunFunction(file, enc).then(function() {
           cb(null, file);
         });
         break;
-      case "forFirst":
+      case 'forFirst':
         if (hasExecutedOnce) {
           checkAndRunFunction(file, enc).then(function() {
             cb(null, file);
@@ -57,7 +52,7 @@ let defaultExport = (
         }
         hasExecutedOnce = true;
         break;
-      case "atEnd":
+      case 'atEnd':
         cb();
         break;
       default:
@@ -66,7 +61,7 @@ let defaultExport = (
   };
 
   let atEnd = function(cb) {
-    if (executionModeArg === "atEnd") {
+    if (executionModeArg === 'atEnd') {
       checkAndRunFunction(null, null).then(function() {
         cb();
       });
@@ -78,15 +73,15 @@ let defaultExport = (
 };
 
 export let forEach = (funcArg: IPromiseFunction) => {
-  return defaultExport(funcArg, "forEach");
+  return defaultExport(funcArg, 'forEach');
 };
 
 export let forFirst = (funcArg: IPromiseFunction) => {
-  return defaultExport(funcArg, "forFirst");
+  return defaultExport(funcArg, 'forFirst');
 };
 
 export let atEnd = (funcArg: IPromiseFunction) => {
-  return defaultExport(funcArg, "atEnd");
+  return defaultExport(funcArg, 'atEnd');
 };
 
 export default defaultExport;

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"
-}