push.rocks/gulp-function
3
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

fix(gulp-function): correct forFirst execution behavior, improve async error handling, and modernize package metadata

Browse Source
This commit is contained in:
Jürgen Kunz
2026-05-02 10:36:21 +00:00
parent edcb1d114f
commit 60607ce021
12 changed files with 8673 additions and 6831 deletions
Download Patch File Download Diff File Expand all files Collapse all files
readme.md
+127 -83
View File
@@ -1,106 +1,150 @@
# @push.rocks/gulp-function
[@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.
`@push.rocks/gulp-function` is a tiny, typed Gulp plugin for running your own sync or async functions inside a Gulp object stream without changing the files that flow through it. Use it when a pipeline needs custom side effects: logging, validation, deployment calls, metrics, cache invalidation, or any project-specific action that does not deserve a full custom Gulp plugin.
## Issue Reporting and Security
For reporting bugs, issues, or security vulnerabilities, please visit [community.foss.global/](https://community.foss.global/). This is the central community hub for all issue reporting. Developers who sign and comply with our contribution agreement and go through identification can also get a [code.foss.global/](https://code.foss.global/) account to submit Pull Requests directly.
## Install
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:
```bash
pnpm add -D @push.rocks/gulp-function
```
## What It Does
Gulp streams are great at moving Vinyl files through transforms. Sometimes you need to run code at a specific point in that stream while leaving every file untouched. `@push.rocks/gulp-function` gives you three small helpers for that:
- `forEach(fn)`: run `fn(file, enc)` for every file and pass the file on after the function resolves.
- `forFirst(fn)`: run `fn(file, enc)` only for the first file and pass all files through.
- `atEnd(fn)`: pass all files through immediately, then run `fn(null, null)` once when the stream flushes.
The default export exposes the same behavior as `gulpFunction(fnOrFns, mode)`, where `mode` is `'forEach'`, `'forFirst'`, or `'atEnd'`. The default export also accepts an array of functions and runs them in parallel for the selected mode.
## Quick Start
```ts
import gulp from 'gulp';
import { forEach } from '@push.rocks/gulp-function';
interface IVinylFile {
path: string;
relative: string;
}
export const logFiles = () =>
gulp.src('./src/**/*.ts')
.pipe(forEach<IVinylFile>(async (file) => {
if (!file) return;
console.log(`Processing ${file.relative}`);
}))
.pipe(gulp.dest('./dist'));
```
The function can return a promise or a plain value. If it throws or rejects, the transform reports the error to Gulp and the pipeline fails normally.
## API
### `forEach(func)`
Runs `func(file, enc)` for every Vinyl file in the stream. The file is pushed onward only after `func` has completed.
```ts
import { forEach } from '@push.rocks/gulp-function';
gulp.src('./content/**/*.md')
.pipe(forEach(async (file) => {
console.log(file?.relative);
}))
.pipe(gulp.dest('./public'));
```
### `forFirst(func)`
Runs `func(file, enc)` only for the first file. This is useful for one-time setup that should still be triggered by a stream.
```ts
import { forFirst } from '@push.rocks/gulp-function';
gulp.src('./assets/**/*')
.pipe(forFirst(async (file) => {
console.log(`Starting asset pipeline with ${file?.relative}`);
}))
.pipe(gulp.dest('./dist/assets'));
```
### `atEnd(func)`
Runs `func(null, null)` once after all files have passed through. This is ideal for final notifications, summary output, or flushing external state.
```ts
import { atEnd, forEach } from '@push.rocks/gulp-function';
let fileCount = 0;
gulp.src('./src/**/*')
.pipe(forEach(() => {
fileCount++;
}))
.pipe(atEnd(async () => {
console.log(`Handled ${fileCount} files`);
}))
.pipe(gulp.dest('./dist'));
```
### Default Export
```ts
import gulpFunction from '@push.rocks/gulp-function';
gulp.src('./src/**/*')
.pipe(gulpFunction([
async (file) => console.log(file?.relative),
async () => console.log('side effect complete')
], 'forEach'));
```
Supported TypeScript exports:
- `TExecutionMode`: `'forEach' | 'forFirst' | 'atEnd'`
- `TGulpFunctionEncoding`: `BufferEncoding | string | null`
- `TGulpFunctionResult`: `PromiseLike<unknown> | unknown`
- `IPromiseFunction<TFile = unknown>`: `(file?: TFile | null, enc?: TGulpFunctionEncoding) => TGulpFunctionResult`
## Behavior Notes
- Files are passed through unchanged.
- Async functions are awaited before the relevant transform or flush callback completes.
- `forEach` and `forFirst` receive the current file and stream encoding.
- `atEnd` receives `null` for both arguments because no single file is active during flush.
- Arrays passed to the default export are executed with `Promise.all`.
- Non-`Error` thrown values are normalized to `Error` instances before being passed to Gulp.
## Testing and Build
```bash
npm install @push.rocks/gulp-function --save-dev
pnpm test
pnpm run build
```
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
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 from 'gulp';
import gulpFunction, { forEach } from '@push.rocks/gulp-function';
const logFilePath = async (file: Buffer, enc: string) => {
console.log(`Processing file: ${file.path}`);
};
gulp.task('log', () => {
return gulp.src('./src/**/*.ts')
.pipe(forEach(logFilePath))
.pipe(gulp.dest('./dist'));
});
```
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.
### Advanced Use Case: Asynchronous Function Execution
`@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:
```typescript
import gulp from 'gulp';
import gulpFunction, { forEach } from '@push.rocks/gulp-function';
import axios from 'axios';
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'
}
});
console.log(`Uploaded file: ${file.path}`);
};
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.
This repository contains open-source code licensed under the MIT License. A copy of the license can be found in the [LICENSE](./LICENSE) file.
**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.
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 or third parties, 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 or the guidelines of the respective third-party owners, and any usage must be approved in writing. Third-party trademarks used herein are the property of their respective owners and used only in a descriptive manner, e.g. for an implementation of an API or similar.
### Company Information
Task Venture Capital GmbH
Registered at District court Bremen HRB 35230 HB, Germany
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.
For any legal inquiries or 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.