update tsconfig

npmextra.json

@@ -12,12 +12,23 @@
       "githost": "code.foss.global",
       "gitscope": "push.rocks",
       "gitrepo": "gulp-function",
-      "description": "accepts a function call as parameter to execute in gulp pipeline",
+      "description": "A Gulp plugin to execute functions within a Gulp task pipeline.",
       "npmPackagename": "@push.rocks/gulp-function",
-      "license": "MIT"
+      "license": "MIT",
+      "keywords": [
+        "gulp",
+        "plugin",
+        "task automation",
+        "stream manipulation",
+        "async function execution",
+        "pipeline",
+        "build tool",
+        "JavaScript",
+        "TypeScript"
+      ]
     }
   },
-  "tsdocs": {
+  "tsdoc": {
     "legal": "\n## License and Legal Information\n\nThis repository contains open-source code that is licensed under the MIT License. A copy of the MIT License can be found in the [license](license) file within this repository. \n\n**Please note:** The MIT License does not grant permission to use the trade names, trademarks, service marks, or product names of the project, except as required for reasonable and customary use in describing the origin of the work and reproducing the content of the NOTICE file.\n\n### Trademarks\n\nThis project is owned and maintained by Task Venture Capital GmbH. The names and logos associated with Task Venture Capital GmbH and any related products or services are trademarks of Task Venture Capital GmbH and are not included within the scope of the MIT license granted herein. Use of these trademarks must comply with Task Venture Capital GmbH's Trademark Guidelines, and any usage must be approved in writing by Task Venture Capital GmbH.\n\n### Company Information\n\nTask Venture Capital GmbH  \nRegistered at District court Bremen HRB 35230 HB, Germany\n\nFor any legal inquiries or if you require further information, please contact us via email at hello@task.vc.\n\nBy using this repository, you acknowledge that you have read this section, agree to comply with its terms, and understand that the licensing of the code does not imply endorsement by Task Venture Capital GmbH of any derivative works.\n"
   }
 }

package.json

@@ -2,7 +2,7 @@
   "name": "@push.rocks/gulp-function",
   "private": false,
   "version": "3.0.7",
-  "description": "accepts a function call as parameter to execute in gulp pipeline",
+  "description": "A Gulp plugin to execute functions within a Gulp task pipeline.",
   "main": "dist_ts/index.js",
   "typings": "dist_ts/index.d.ts",
   "scripts": {
@@ -15,10 +15,15 @@
     "url": "git+https://gitlab.com/push.rocks/gulp-function.git"
   },
   "keywords": [
-    "gulpplugin",
     "gulp",
-    "function",
+    "plugin",
-    "pushrocks"
+    "task automation",
+    "stream manipulation",
+    "async function execution",
+    "pipeline",
+    "build tool",
+    "JavaScript",
+    "TypeScript"
   ],
   "author": "Lossless GmbH <office@lossless.com> (https://lossless.com)",
   "license": "MIT",
@@ -55,4 +60,4 @@
   "browserslist": [
     "last 1 chrome versions"
   ]
-}
+}

readme.hints.md

@@ -0,0 +1 @@
+ 

readme.md

@@ -1,64 +1,106 @@
 # @push.rocks/gulp-function
-accepts a function call as parameter to execute in gulp pipeline
 
-## Availabililty and Links
+[@push.rocks/gulp-function](https://www.npmjs.com/package/@push.rocks/gulp-function) is a Gulp plugin designed to execute custom functions within a Gulp pipeline. It accepts a function call as a parameter and allows for flexible task executions, including asynchronous tasks, with easy integration into the Gulp workflow.
-* [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
+## Install
-[![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)
+To use @push.rocks/gulp-function in your project, you'll first need to install it via npm. You can do this by running the following command in your project's root directory:
-[![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)
+```bash
-[![TypeScript](https://img.shields.io/badge/TypeScript->=%203.x-blue.svg)](https://nodejs.org/dist/latest-v10.x/docs/api/)
+npm install @push.rocks/gulp-function --save-dev
-[![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/)
+
+This command will add `@push.rocks/gulp-function` as a development dependency to your project, making it available for use in your Gulp tasks.
 
 ## Usage
 
-Please use TypeScript for best in class intellisense.
+The primary use case for `@push.rocks/gulp-function` is to incorporate custom function executions into your Gulp pipelines. This can be particularly useful for tasks that require conditional processing, external API calls, or any other logic that extends beyond the capabilities of existing Gulp plugins.
+
+Here's how you can use `@push.rocks/gulp-function` within your Gulp setup:
+
+### Basic Example
+
+Let's start with a simple scenario where you want to log the path of files processed by Gulp.
 
 ```typescript
-import gulp = require('gulp');
+import gulp from 'gulp';
-import gulpFunction from 'gulp-function'; // default ES6 export
+import gulpFunction, { forEach } from '@push.rocks/gulp-function';
-// import {forFirst, forEach, atEnd} from 'gulp-function'
 
-let myAsyncFunction = async (file, enc) => {
+const logFilePath = async (file: Buffer, enc: string) => {
-  // await some async stuff
+  console.log(`Processing file: ${file.path}`);
 };
 
-gulp.task('gulpTest', function() {
+gulp.task('log', () => {
-  let stream = gulp
+  return gulp.src('./src/**/*.ts')
-    .src('./mydir/*.something')
+    .pipe(forEach(logFilePath))
-    .pipe(gulpFunction(myAsyncFunction, 'forEach')) //read the notes below
+    .pipe(gulp.dest('./dist'));
-    // .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
+In this example, we're using the `forEach` method exported by `@push.rocks/gulp-function` to execute `logFilePath` for each file matched by `gulp.src`. The file's path is logged to the console during the build process.
 
-- The first argument of gulpFunction can also be an **array of multiple functionnames**.
+### Advanced Use Case: Asynchronous Function Execution
-  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
+`@push.rocks/gulp-function` truly shines when you need to perform asynchronous operations within your Gulp tasks. Here's an example that demonstrates making an asynchronous API call for each file:
 
-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). :)
+```typescript
+import gulp from 'gulp';
+import gulpFunction, { forEach } from '@push.rocks/gulp-function';
+import axios from 'axios';
 
-For further information read the linked docs at the top of this readme.
+const uploadFileToServer = async (file: Buffer, enc: string) => {
+  const formData = new FormData();
+  formData.append('file', file.contents, file.relative);
+  
+  await axios.post('https://example.com/upload', formData, {
+    headers: {
+      'Content-Type': 'multipart/form-data'
+    }
+  });
 
-> MIT licensed | **&copy;** [Lossless GmbH](https://lossless.gmbh)
+  console.log(`Uploaded file: ${file.path}`);
-| 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)
+gulp.task('uploadFiles', () => {
+  return gulp.src('./uploads/**/*')
+    .pipe(forEach(uploadFileToServer))
+    .pipe(gulp.dest('./dist/uploads'));
+});
+```
+
+In this more advanced example, we use the `forEach` method to upload each file to a remote server using `axios`. The function `uploadFileToServer` is executed for each file, where an HTTP POST request is made to upload the file. This shows how you can integrate asynchronous operations seamlessly into your Gulp pipeline.
+
+### Execution Modes
+
+`@push.rocks/gulp-function` supports three execution modes for your functions: `forEach`, `forFirst`, and `atEnd`.
+
+- **forEach**: Executes the provided function for each file in the stream.
+- **forFirst**: Executes the provided function only for the first file that passes through the stream.
+- **atEnd**: Executes the provided function once after all files have passed through the stream.
+
+These modes provide flexibility in determining when your custom functions should be triggered during the build process.
+
+### Conclusion
+
+`@push.rocks/gulp-function` is a powerful tool for integrating custom processing logic into Gulp workflows. Whether you need to execute simple synchronous tasks or complex asynchronous operations, `@push.rocks/gulp-function` offers the flexibility and ease of use to enhance your Gulp builds significantly.
+
+Remember, the examples provided are starting points. The real power of `@push.rocks/gulp-function` lies in its ability to adapt to your specific use cases, enabling you to automate and streamline your build processes as never before.
+
+## License and Legal Information
+
+This repository contains open-source code that is licensed under the MIT License. A copy of the MIT License can be found in the [license](license) file within this repository. 
+
+**Please note:** The MIT License does not grant permission to use the trade names, trademarks, service marks, or product names of the project, except as required for reasonable and customary use in describing the origin of the work and reproducing the content of the NOTICE file.
+
+### Trademarks
+
+This project is owned and maintained by Task Venture Capital GmbH. The names and logos associated with Task Venture Capital GmbH and any related products or services are trademarks of Task Venture Capital GmbH and are not included within the scope of the MIT license granted herein. Use of these trademarks must comply with Task Venture Capital GmbH's Trademark Guidelines, and any usage must be approved in writing by Task Venture Capital GmbH.
+
+### Company Information
+
+Task Venture Capital GmbH  
+Registered at District court Bremen HRB 35230 HB, Germany
+
+For any legal inquiries or if you require further information, please contact us via email at hello@task.vc.
+
+By using this repository, you acknowledge that you have read this section, agree to comply with its terms, and understand that the licensing of the code does not imply endorsement by Task Venture Capital GmbH of any derivative works.