Compare commits

...

16 Commits

Author SHA1 Message Date
98a583bae1 2.2.12 2018-01-29 23:28:06 +01:00
848d9ac1e0 update to latest standards 2018-01-29 23:28:03 +01:00
e7ccd9aec4 2.2.11 2017-10-27 12:49:45 +02:00
63bf7204dd update 2017-10-27 12:49:43 +02:00
a34a1b89fe 2.2.10 2017-09-07 22:33:43 +02:00
f4455a9b91 update dependencies 2017-09-07 22:33:40 +02:00
1a01198d7f 2.2.9 2017-04-30 17:28:18 +02:00
b3ec364a1d 2.2.8 2017-04-30 17:23:26 +02:00
5d15c96511 update docs and .gitignore 2017-04-30 17:23:22 +02:00
f6e071156b 2.2.7 2017-04-30 17:11:50 +02:00
63fe7c7423 update README 2017-04-30 17:11:40 +02:00
c8dcdc0df4 update README 2017-04-30 17:11:19 +02:00
743c7a03a5 2.2.6 2017-04-30 01:07:35 +02:00
f9e7bf450b now cleans pipe correctly 2017-04-30 01:07:30 +02:00
b55a511fcb 2.2.5 2017-04-30 00:45:23 +02:00
96c15cb90a update ci 2017-04-30 00:45:19 +02:00
30 changed files with 1191 additions and 636 deletions

8
.gitignore vendored
View File

@ -1,13 +1,5 @@
node_modules/ node_modules/
.settings/
.idea/
coverage/ coverage/
docs/
public/ public/
pages/ pages/
ts/*.js
ts/*.js.map
ts/typings/
test/result/

View File

@ -1,50 +1,83 @@
image: hosttoday/ht-docker-node:npmts # gitzone standard
image: hosttoday/ht-docker-node:npmci
cache:
paths:
- .yarn/
key: "$CI_BUILD_STAGE"
stages: stages:
- mirror
- test - test
- release - release
- trigger - trigger
- pages - pages
mirror:
stage: mirror
script:
- npmci git mirror
tags:
- docker
testLEGACY: testLEGACY:
stage: test stage: test
script: script:
- npmci test legacy - npmci node install legacy
- npmci npm install
- npmci npm test
coverage: /\d+.?\d+?\%\s*coverage/
tags: tags:
- docker - docker
allow_failure: true allow_failure: true
testLTS: testLTS:
stage: test stage: test
script: script:
- npmci test lts - npmci node install lts
- npmci npm install
- npmci npm test
coverage: /\d+.?\d+?\%\s*coverage/
tags: tags:
- docker - docker
testSTABLE: testSTABLE:
stage: test stage: test
script: script:
- npmci test stable - npmci node install stable
- npmci npm install
- npmci npm test
coverage: /\d+.?\d+?\%\s*coverage/
tags: tags:
- docker - docker
release: release:
stage: release stage: release
script: script:
- npmci publish - npmci npm prepare
- npmci npm publish
only: only:
- tags - tags
tags: tags:
- docker - docker
trigger: trigger:
stage: trigger stage: trigger
script: script:
- npmci trigger - npmci trigger
only: only:
- tags - tags
tags: tags:
- docker - docker
pages: pages:
image: hosttoday/ht-docker-node:npmpage image: hosttoday/ht-docker-node:npmci
stage: pages stage: pages
script: script:
- npmci command npmpage --host gitlab - npmci command yarn global add npmpage
- npmci command npmpage
tags:
- docker
only: only:
- tags - tags
artifacts: artifacts:

View File

@ -1,15 +1,19 @@
# gulp-function # gulp-function
accepts call to execute in gulp pipeline.
accepts a function call as parameter to execute in gulp pipeline
## Availabililty ## 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) [![npm](https://pushrocks.gitlab.io/assets/repo-button-npm.svg)](https://www.npmjs.com/package/gulp-function)
[![git](https://push.rocks/assets/repo-button-mirror.svg)](https://github.com/pushrocks/gulp-function) [![git](https://pushrocks.gitlab.io/assets/repo-button-git.svg)](https://GitLab.com/pushrocks/gulp-function)
[![docs](https://push.rocks/assets/repo-button-docs.svg)](https://pushrocks.gitlab.io/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 ## 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) [![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) [![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 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) [![bitHound Code](https://www.bithound.io/github/pushrocks/gulp-function/badges/code.svg)](https://www.bithound.io/github/pushrocks/gulp-function)
@ -18,44 +22,42 @@ accepts call to execute in gulp pipeline.
[![JavaScript Style Guide](https://img.shields.io/badge/code%20style-standard-brightgreen.svg)](http://standardjs.com/) [![JavaScript Style Guide](https://img.shields.io/badge/code%20style-standard-brightgreen.svg)](http://standardjs.com/)
### Usage ### Usage
```javascript
import * as gulp from 'gulp'; ```typescript
import gulpFunction from 'gulp-function' // default ES6 export import * as gulp from "gulp";
import gulpFunction from "gulp-function"; // default ES6 export
// import {forFirst, forEach, atEnd} from 'gulp-function' // import {forFirst, forEach, atEnd} from '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 myAsyncFunction = async (file, enc) => {
let done = Q.defer(); // await some async stuff
console.log("Hello World!") };
// NOTE: gulp.task("gulpTest", function() {
// you can use done.resolve as callback function let stream = gulp
// of any async tasks within this function .src("./mydir/*.something")
done.resolve(); .pipe(gulpFunction(myFunction, "forEach")) //read the notes below
// .pipe(forEach(myFunction)) // if imported as >> import { forEach } from 'gulp-function' <<
return done.promise; .pipe(gulp.dest("./build/"));
} return stream; // by returning the stream gulp knows when our task has finished.
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: ### Notes
* The first argument of gulpFunction can also be an **array of multiple functionnames**. * 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. 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 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 second argument can be empty, it defaults to "forEach"
* The following options are available: * The following options are available:
* "forFirst" - executes when first chunk/vinylfile of the stream reaches the pipestop. * "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. 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; * "forEach" - executes like "forFirst" but with every chunk/vinylfile in the stream;
* "atEnd" - executes after all chunks have passed and are processed in full. * "atEnd" - executes after all chunks have passed and are processed in full.
That means the stream's "finish" event fires **before "atLast" is executed**!!! That means the stream's "finish" event fires **before "atLast" is executed**!!!
[![npm](https://push.rocks/assets/repo-header.svg)](https://push.rocks) 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)

5
dist/index.d.ts vendored
View File

@ -1,7 +1,6 @@
/// <reference types="node" /> /// <reference types="node" />
import 'typings-global'; import { Transform } from "stream";
import { Transform } from 'stream'; export declare type TExecutionMode = "forEach" | "forFirst" | "atEnd";
export declare type TExecutionMode = 'forEach' | 'forFirst' | 'atEnd';
export interface IPromiseFunction { export interface IPromiseFunction {
(file?: any, enc?: any): PromiseLike<any>; (file?: any, enc?: any): PromiseLike<any>;
} }

32
dist/index.js vendored
View File

@ -1,17 +1,17 @@
"use strict"; "use strict";
Object.defineProperty(exports, "__esModule", { value: true }); Object.defineProperty(exports, "__esModule", { value: true });
require("typings-global");
const through2 = require("through2"); const through2 = require("through2");
let defaultExport = (functionsToExecuteArg, executionModeArg = 'forEach') => { let defaultExport = (functionsToExecuteArg, executionModeArg = "forEach") => {
let promiseArray = []; let promiseArray = [];
let runFunction = function (functionArg, file, enc) { let runFunction = function (functionArg, file, enc) {
let returnValue = 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); promiseArray.push(returnValue);
} }
}; };
let checkAndRunFunction = function (file, enc) { let checkAndRunFunction = function (file, enc) {
if (typeof functionsToExecuteArg === 'function') { if (typeof functionsToExecuteArg === "function") {
runFunction(functionsToExecuteArg, file, enc); runFunction(functionsToExecuteArg, file, enc);
} }
else if (Array.isArray(functionsToExecuteArg)) { else if (Array.isArray(functionsToExecuteArg)) {
@ -20,22 +20,22 @@ let defaultExport = (functionsToExecuteArg, executionModeArg = 'forEach') => {
} }
} }
else { 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); return Promise.all(promiseArray);
}; };
let hasExecutedOnce = false; let hasExecutedOnce = false;
let forEach = function (file, enc, cb) { let forEach = function (file, enc, cb) {
// the forEach function is called for every chunk
switch (executionModeArg) { switch (executionModeArg) {
case 'forEach': case "forEach":
checkAndRunFunction(file, enc).then(function () { checkAndRunFunction(file, enc).then(function () {
cb(null, file); cb(null, file);
}); });
break; break;
case 'forFirst': case "forFirst":
if (hasExecutedOnce) { if (hasExecutedOnce) {
checkAndRunFunction(file, enc) checkAndRunFunction(file, enc).then(function () {
.then(function () {
cb(null, file); cb(null, file);
}); });
} }
@ -44,15 +44,15 @@ let defaultExport = (functionsToExecuteArg, executionModeArg = 'forEach') => {
} }
hasExecutedOnce = true; hasExecutedOnce = true;
break; break;
case 'atEnd': case "atEnd":
cb(null, file); cb();
break; break;
default: default:
break; break;
} }
}; };
let atEnd = function (cb) { let atEnd = function (cb) {
if (executionModeArg === 'atEnd') { if (executionModeArg === "atEnd") {
checkAndRunFunction(null, null).then(function () { checkAndRunFunction(null, null).then(function () {
cb(); cb();
}); });
@ -64,13 +64,13 @@ let defaultExport = (functionsToExecuteArg, executionModeArg = 'forEach') => {
return through2.obj(forEach, atEnd); return through2.obj(forEach, atEnd);
}; };
exports.forEach = (funcArg) => { exports.forEach = (funcArg) => {
return defaultExport(funcArg, 'forEach'); return defaultExport(funcArg, "forEach");
}; };
exports.forFirst = (funcArg) => { exports.forFirst = (funcArg) => {
return defaultExport(funcArg, 'forFirst'); return defaultExport(funcArg, "forFirst");
}; };
exports.atEnd = (funcArg) => { exports.atEnd = (funcArg) => {
return defaultExport(funcArg, 'atEnd'); return defaultExport(funcArg, "atEnd");
}; };
exports.default = defaultExport; exports.default = defaultExport;
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi90cy9pbmRleC50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiOztBQUFBLDBCQUF1QjtBQUV2QixxQ0FBb0M7QUFTcEMsSUFBSSxhQUFhLEdBQUcsQ0FDbEIscUJBQTRELEVBQzVELG1CQUFtQyxTQUFTO0lBRzVDLElBQUksWUFBWSxHQUFHLEVBQUUsQ0FBQTtJQUNyQixJQUFJLFdBQVcsR0FBRyxVQUFVLFdBQVcsRUFBRSxJQUFJLEVBQUUsR0FBRztRQUNoRCxJQUFJLFdBQVcsR0FBRyxXQUFXLENBQUMsSUFBSSxFQUFFLEdBQUcsQ0FBQyxDQUFBO1FBQ3hDLEVBQUUsQ0FBQyxDQUFDLE9BQU8sV0FBVyxLQUFLLFdBQVcsSUFBSSxPQUFPLFdBQVcsQ0FBQyxJQUFJLEtBQUssV0FBVyxDQUFDLENBQUMsQ0FBQztZQUNsRixZQUFZLENBQUMsSUFBSSxDQUFDLFdBQVcsQ0FBQyxDQUFBO1FBQ2hDLENBQUM7SUFDSCxDQUFDLENBQUE7SUFFRCxJQUFJLG1CQUFtQixHQUFHLFVBQVUsSUFBSSxFQUFFLEdBQUc7UUFDM0MsRUFBRSxDQUFDLENBQUMsT0FBTyxxQkFBcUIsS0FBSyxVQUFVLENBQUMsQ0FBQyxDQUFDO1lBQ2hELFdBQVcsQ0FBQyxxQkFBcUIsRUFBRSxJQUFJLEVBQUUsR0FBRyxDQUFDLENBQUE7UUFDL0MsQ0FBQztRQUFDLElBQUksQ0FBQyxFQUFFLENBQUMsQ0FBQyxLQUFLLENBQUMsT0FBTyxDQUFDLHFCQUFxQixDQUFDLENBQUMsQ0FBQyxDQUFDO1lBQ2hELEdBQUcsQ0FBQyxDQUFDLElBQUksV0FBVyxJQUFJLHFCQUFxQixDQUFDLENBQUMsQ0FBQztnQkFDOUMsV0FBVyxDQUFDLHFCQUFxQixDQUFFLFdBQVcsQ0FBRSxFQUFFLElBQUksRUFBRSxHQUFHLENBQUMsQ0FBQTtZQUM5RCxDQUFDO1FBQ0gsQ0FBQztRQUFDLElBQUksQ0FBQyxDQUFDO1lBQ04sTUFBTSxJQUFJLEtBQUssQ0FBQyxrRUFBa0UsQ0FBQyxDQUFBO1FBQ3JGLENBQUM7UUFDRCxNQUFNLENBQUMsT0FBTyxDQUFDLEdBQUcsQ0FBQyxZQUFZLENBQUMsQ0FBQTtJQUNsQyxDQUFDLENBQUE7SUFFRCxJQUFJLGVBQWUsR0FBRyxLQUFLLENBQUE7SUFDM0IsSUFBSSxPQUFPLEdBQUcsVUFBVSxJQUFJLEVBQUUsR0FBRyxFQUFFLEVBQUU7UUFDbkMsTUFBTSxDQUFDLENBQUMsZ0JBQWdCLENBQUMsQ0FBQyxDQUFDO1lBQ3pCLEtBQUssU0FBUztnQkFDWixtQkFBbUIsQ0FBQyxJQUFJLEVBQUUsR0FBRyxDQUFDLENBQUMsSUFBSSxDQUFDO29CQUNsQyxFQUFFLENBQUMsSUFBSSxFQUFFLElBQUksQ0FBQyxDQUFBO2dCQUNoQixDQUFDLENBQUMsQ0FBQTtnQkFDRixLQUFLLENBQUE7WUFDUCxLQUFLLFVBQVU7Z0JBQ2IsRUFBRSxDQUFDLENBQUMsZUFBZSxDQUFDLENBQUMsQ0FBQztvQkFDcEIsbUJBQW1CLENBQUMsSUFBSSxFQUFFLEdBQUcsQ0FBQzt5QkFDM0IsSUFBSSxDQUFDO3dCQUNKLEVBQUUsQ0FBQyxJQUFJLEVBQUUsSUFBSSxDQUFDLENBQUE7b0JBQ2hCLENBQUMsQ0FBQyxDQUFBO2dCQUNOLENBQUM7Z0JBQUMsSUFBSSxDQUFDLENBQUM7b0JBQ04sRUFBRSxDQUFDLElBQUksRUFBRSxJQUFJLENBQUMsQ0FBQTtnQkFDaEIsQ0FBQztnQkFDRCxlQUFlLEdBQUcsSUFBSSxDQUFBO2dCQUN0QixLQUFLLENBQUE7WUFDUCxLQUFLLE9BQU87Z0JBQ1YsRUFBRSxDQUFDLElBQUksRUFBRSxJQUFJLENBQUMsQ0FBQTtnQkFDZCxLQUFLLENBQUE7WUFDUDtnQkFDRSxLQUFLLENBQUE7UUFDVCxDQUFDO0lBQ0gsQ0FBQyxDQUFBO0lBRUQsSUFBSSxLQUFLLEdBQUcsVUFBVSxFQUFFO1FBQ3RCLEVBQUUsQ0FBQyxDQUFDLGdCQUFnQixLQUFLLE9BQU8sQ0FBQyxDQUFDLENBQUM7WUFDakMsbUJBQW1CLENBQUMsSUFBSSxFQUFFLElBQUksQ0FBQyxDQUFDLElBQUksQ0FBQztnQkFDbkMsRUFBRSxFQUFFLENBQUE7WUFDTixDQUFDLENBQUMsQ0FBQTtRQUNKLENBQUM7UUFBQyxJQUFJLENBQUMsQ0FBQztZQUNOLEVBQUUsRUFBRSxDQUFBO1FBQ04sQ0FBQztJQUNILENBQUMsQ0FBQTtJQUNELE1BQU0sQ0FBQyxRQUFRLENBQUMsR0FBRyxDQUFDLE9BQU8sRUFBRSxLQUFLLENBQUMsQ0FBQTtBQUNyQyxDQUFDLENBQUE7QUFFVSxRQUFBLE9BQU8sR0FBRyxDQUFDLE9BQXlCO0lBQzdDLE1BQU0sQ0FBQyxhQUFhLENBQUMsT0FBTyxFQUFFLFNBQVMsQ0FBQyxDQUFBO0FBQzFDLENBQUMsQ0FBQTtBQUVVLFFBQUEsUUFBUSxHQUFHLENBQUMsT0FBeUI7SUFDOUMsTUFBTSxDQUFDLGFBQWEsQ0FBQyxPQUFPLEVBQUUsVUFBVSxDQUFDLENBQUE7QUFDM0MsQ0FBQyxDQUFBO0FBRVUsUUFBQSxLQUFLLEdBQUcsQ0FBQyxPQUF5QjtJQUMzQyxNQUFNLENBQUMsYUFBYSxDQUFDLE9BQU8sRUFBRSxPQUFPLENBQUMsQ0FBQTtBQUN4QyxDQUFDLENBQUE7QUFFRCxrQkFBZSxhQUFhLENBQUEifQ== //# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi90cy9pbmRleC50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiOztBQUNBLHFDQUFxQztBQVNyQyxJQUFJLGFBQWEsR0FBRyxDQUNsQixxQkFBNEQsRUFDNUQsbUJBQW1DLFNBQVMsRUFDakMsRUFBRTtJQUNiLElBQUksWUFBWSxHQUFHLEVBQUUsQ0FBQztJQUN0QixJQUFJLFdBQVcsR0FBRyxVQUFTLFdBQVcsRUFBRSxJQUFJLEVBQUUsR0FBRztRQUMvQyxJQUFJLFdBQVcsR0FBRyxXQUFXLENBQUMsSUFBSSxFQUFFLEdBQUcsQ0FBQyxDQUFDO1FBQ3pDLEVBQUUsQ0FBQyxDQUNELE9BQU8sV0FBVyxLQUFLLFdBQVc7WUFDbEMsT0FBTyxXQUFXLENBQUMsSUFBSSxLQUFLLFdBQzlCLENBQUMsQ0FBQyxDQUFDO1lBQ0QsWUFBWSxDQUFDLElBQUksQ0FBQyxXQUFXLENBQUMsQ0FBQztRQUNqQyxDQUFDO0lBQ0gsQ0FBQyxDQUFDO0lBRUYsSUFBSSxtQkFBbUIsR0FBRyxVQUFTLElBQUksRUFBRSxHQUFHO1FBQzFDLEVBQUUsQ0FBQyxDQUFDLE9BQU8scUJBQXFCLEtBQUssVUFBVSxDQUFDLENBQUMsQ0FBQztZQUNoRCxXQUFXLENBQUMscUJBQXFCLEVBQUUsSUFBSSxFQUFFLEdBQUcsQ0FBQyxDQUFDO1FBQ2hELENBQUM7UUFBQyxJQUFJLENBQUMsRUFBRSxDQUFDLENBQUMsS0FBSyxDQUFDLE9BQU8sQ0FBQyxxQkFBcUIsQ0FBQyxDQUFDLENBQUMsQ0FBQztZQUNoRCxHQUFHLENBQUMsQ0FBQyxJQUFJLFdBQVcsSUFBSSxxQkFBcUIsQ0FBQyxDQUFDLENBQUM7Z0JBQzlDLFdBQVcsQ0FBQyxxQkFBcUIsQ0FBQyxXQUFXLENBQUMsRUFBRSxJQUFJLEVBQUUsR0FBRyxDQUFDLENBQUM7WUFDN0QsQ0FBQztRQUNILENBQUM7UUFBQyxJQUFJLENBQUMsQ0FBQztZQUNOLE1BQU0sSUFBSSxLQUFLLENBQ2Isa0VBQWtFLENBQ25FLENBQUM7UUFDSixDQUFDO1FBQ0QsTUFBTSxDQUFDLE9BQU8sQ0FBQyxHQUFHLENBQUMsWUFBWSxDQUFDLENBQUM7SUFDbkMsQ0FBQyxDQUFDO0lBRUYsSUFBSSxlQUFlLEdBQUcsS0FBSyxDQUFDO0lBQzVCLElBQUksT0FBTyxHQUFHLFVBQVMsSUFBSSxFQUFFLEdBQUcsRUFBRSxFQUFFO1FBQ2xDLGlEQUFpRDtRQUNqRCxNQUFNLENBQUMsQ0FBQyxnQkFBZ0IsQ0FBQyxDQUFDLENBQUM7WUFDekIsS0FBSyxTQUFTO2dCQUNaLG1CQUFtQixDQUFDLElBQUksRUFBRSxHQUFHLENBQUMsQ0FBQyxJQUFJLENBQUM7b0JBQ2xDLEVBQUUsQ0FBQyxJQUFJLEVBQUUsSUFBSSxDQUFDLENBQUM7Z0JBQ2pCLENBQUMsQ0FBQyxDQUFDO2dCQUNILEtBQUssQ0FBQztZQUNSLEtBQUssVUFBVTtnQkFDYixFQUFFLENBQUMsQ0FBQyxlQUFlLENBQUMsQ0FBQyxDQUFDO29CQUNwQixtQkFBbUIsQ0FBQyxJQUFJLEVBQUUsR0FBRyxDQUFDLENBQUMsSUFBSSxDQUFDO3dCQUNsQyxFQUFFLENBQUMsSUFBSSxFQUFFLElBQUksQ0FBQyxDQUFDO29CQUNqQixDQUFDLENBQUMsQ0FBQztnQkFDTCxDQUFDO2dCQUFDLElBQUksQ0FBQyxDQUFDO29CQUNOLEVBQUUsQ0FBQyxJQUFJLEVBQUUsSUFBSSxDQUFDLENBQUM7Z0JBQ2pCLENBQUM7Z0JBQ0QsZUFBZSxHQUFHLElBQUksQ0FBQztnQkFDdkIsS0FBSyxDQUFDO1lBQ1IsS0FBSyxPQUFPO2dCQUNWLEVBQUUsRUFBRSxDQUFDO2dCQUNMLEtBQUssQ0FBQztZQUNSO2dCQUNFLEtBQUssQ0FBQztRQUNWLENBQUM7SUFDSCxDQUFDLENBQUM7SUFFRixJQUFJLEtBQUssR0FBRyxVQUFTLEVBQUU7UUFDckIsRUFBRSxDQUFDLENBQUMsZ0JBQWdCLEtBQUssT0FBTyxDQUFDLENBQUMsQ0FBQztZQUNqQyxtQkFBbUIsQ0FBQyxJQUFJLEVBQUUsSUFBSSxDQUFDLENBQUMsSUFBSSxDQUFDO2dCQUNuQyxFQUFFLEVBQUUsQ0FBQztZQUNQLENBQUMsQ0FBQyxDQUFDO1FBQ0wsQ0FBQztRQUFDLElBQUksQ0FBQyxDQUFDO1lBQ04sRUFBRSxFQUFFLENBQUM7UUFDUCxDQUFDO0lBQ0gsQ0FBQyxDQUFDO0lBQ0YsTUFBTSxDQUFDLFFBQVEsQ0FBQyxHQUFHLENBQUMsT0FBTyxFQUFFLEtBQUssQ0FBQyxDQUFDO0FBQ3RDLENBQUMsQ0FBQztBQUVTLFFBQUEsT0FBTyxHQUFHLENBQUMsT0FBeUIsRUFBRSxFQUFFO0lBQ2pELE1BQU0sQ0FBQyxhQUFhLENBQUMsT0FBTyxFQUFFLFNBQVMsQ0FBQyxDQUFDO0FBQzNDLENBQUMsQ0FBQztBQUVTLFFBQUEsUUFBUSxHQUFHLENBQUMsT0FBeUIsRUFBRSxFQUFFO0lBQ2xELE1BQU0sQ0FBQyxhQUFhLENBQUMsT0FBTyxFQUFFLFVBQVUsQ0FBQyxDQUFDO0FBQzVDLENBQUMsQ0FBQztBQUVTLFFBQUEsS0FBSyxHQUFHLENBQUMsT0FBeUIsRUFBRSxFQUFFO0lBQy9DLE1BQU0sQ0FBQyxhQUFhLENBQUMsT0FBTyxFQUFFLE9BQU8sQ0FBQyxDQUFDO0FBQ3pDLENBQUMsQ0FBQztBQUVGLGtCQUFlLGFBQWEsQ0FBQyJ9

View File

@ -1,5 +1,10 @@
{ {
"npmts": { "npmts": {
"mode": "default" "mode": "default"
},
"npmci": {
"globalNpmTools": [
"npmts"
]
} }
} }

View File

@ -1,14 +1,11 @@
{ {
"name": "gulp-function", "name": "gulp-function",
"version": "2.2.4", "version": "2.2.12",
"description": "accepts a function call as parameter to execute in gulp pipeline", "description": "accepts a function call as parameter to execute in gulp pipeline",
"main": "dist/index.js", "main": "dist/index.js",
"typings": "dist/index.d.ts", "typings": "dist/index.d.ts",
"scripts": { "scripts": {
"test": "(npmts)", "test": "(npmts)"
"reinstall": "(rm -r node_modules && npm install)",
"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)",
"startdev": "(git checkout master && git pull origin master)"
}, },
"repository": { "repository": {
"type": "git", "type": "git",
@ -17,7 +14,8 @@
"keywords": [ "keywords": [
"gulpplugin", "gulpplugin",
"gulp", "gulp",
"function" "function",
"pushrocks"
], ],
"author": "Lossless GmbH <office@lossless.com> (https://lossless.com)", "author": "Lossless GmbH <office@lossless.com> (https://lossless.com)",
"license": "MIT", "license": "MIT",
@ -27,13 +25,12 @@
"homepage": "https://gitlab.com/pushrocks/gulp-function", "homepage": "https://gitlab.com/pushrocks/gulp-function",
"dependencies": { "dependencies": {
"@types/through2": "^2.0.32", "@types/through2": "^2.0.32",
"smartq": "^1.1.1", "smartq": "^1.1.6",
"through2": "^2.0.3", "through2": "^2.0.3"
"typings-global": "^1.0.16"
}, },
"devDependencies": { "devDependencies": {
"beautylog": "^6.1.10",
"gulp": "^3.9.1", "gulp": "^3.9.1",
"smartgulp": "^1.0.1",
"tapbundle": "^1.0.10" "tapbundle": "^1.0.10"
} }
} }

View File

@ -1,16 +1,15 @@
import { expect, tap } from 'tapbundle' import { expect, tap } from 'tapbundle'
import * as smartgulp from 'smartgulp'
let gulp = require('gulp') let gulp = require('gulp')
import * as gulpFunction from '../dist/index' import * as gulpFunction from '../ts/index'
import * as beautylog from 'beautylog'
let smartq = require('smartq') let smartq = require('smartq')
tap.test('should run through smoothly with ' + "'forEach'", async (tools) => { tap.test('should run through smoothly with ' + "'forEach'", async (tools) => {
let done = smartq.defer() let done = smartq.defer()
let counter = 0 let counter = 0
gulp.src('./test/*.md') gulp.src('./test/testfiles/*.md')
.pipe(gulpFunction.forEach(async () => { .pipe(gulpFunction.forEach(async () => {
counter++ counter++
if (counter === 2) { if (counter === 2) {
@ -23,7 +22,7 @@ tap.test('should run through smoothly with ' + "'forEach'", async (tools) => {
tap.test('should run through smoothly with ' + "'forEach'", async (tools) => { tap.test('should run through smoothly with ' + "'forEach'", async (tools) => {
let done = smartq.defer() let done = smartq.defer()
let counter = 0 let counter = 0
gulp.src('./test/*.md') smartgulp.src(['./test/testfiles/*.md'])
.pipe(gulpFunction.atEnd(async () => { .pipe(gulpFunction.atEnd(async () => {
console.log('atEnd') console.log('atEnd')
done.resolve() done.resolve()

View File

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

View File

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

1
test/testfiles/test01.md Normal file
View File

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

1
test/testfiles/test02.md Normal file
View File

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

1
test/testfiles/test03.md Normal file
View File

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

1
test/testfiles/test04.md Normal file
View File

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

1
test/testfiles/test05.md Normal file
View File

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

1
test/testfiles/test06.md Normal file
View File

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

1
test/testfiles/test07.md Normal file
View File

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

1
test/testfiles/test08.md Normal file
View File

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

1
test/testfiles/test09.md Normal file
View File

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

1
test/testfiles/test10.md Normal file
View File

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

1
test/testfiles/test11.md Normal file
View File

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

1
test/testfiles/test12.md Normal file
View File

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

1
test/testfiles/test13.md Normal file
View File

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

1
test/testfiles/test14.md Normal file
View File

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

1
test/testfiles/test15.md Normal file
View File

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

1
test/testfiles/test16.md Normal file
View File

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

1
test/testfiles/test17.md Normal file
View File

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

1
test/testfiles/test18.md Normal file
View File

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

View File

@ -1,89 +1,92 @@
import 'typings-global' import * as q from "smartq";
import * as q from 'smartq' 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 { export interface IPromiseFunction {
(file?, enc?): PromiseLike<any> (file?, enc?): PromiseLike<any>;
} }
let defaultExport = ( let defaultExport = (
functionsToExecuteArg: IPromiseFunction | IPromiseFunction[], functionsToExecuteArg: IPromiseFunction | IPromiseFunction[],
executionModeArg: TExecutionMode = 'forEach' executionModeArg: TExecutionMode = "forEach"
): Transform => { ): Transform => {
let promiseArray = [];
let promiseArray = [] let runFunction = function(functionArg, file, enc) {
let runFunction = function (functionArg, file, enc) { let returnValue = functionArg(file, enc);
let returnValue = functionArg(file, enc) if (
if (typeof returnValue !== 'undefined' && typeof returnValue.then !== 'undefined') { typeof returnValue !== "undefined" &&
promiseArray.push(returnValue) typeof returnValue.then !== "undefined"
) {
promiseArray.push(returnValue);
} }
} };
let checkAndRunFunction = function (file, enc) { let checkAndRunFunction = function(file, enc) {
if (typeof functionsToExecuteArg === 'function') { if (typeof functionsToExecuteArg === "function") {
runFunction(functionsToExecuteArg, file, enc) runFunction(functionsToExecuteArg, file, enc);
} else if (Array.isArray(functionsToExecuteArg)) { } else if (Array.isArray(functionsToExecuteArg)) {
for (let anyFunction in functionsToExecuteArg) { for (let anyFunction in functionsToExecuteArg) {
runFunction(functionsToExecuteArg[ anyFunction ], file, enc) runFunction(functionsToExecuteArg[anyFunction], file, enc);
} }
} else { } 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) 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) { switch (executionModeArg) {
case 'forEach': case "forEach":
checkAndRunFunction(file, enc).then(function () { checkAndRunFunction(file, enc).then(function() {
cb(null, file) cb(null, file);
}) });
break break;
case 'forFirst': case "forFirst":
if (hasExecutedOnce) { if (hasExecutedOnce) {
checkAndRunFunction(file, enc) checkAndRunFunction(file, enc).then(function() {
.then(function () { cb(null, file);
cb(null, file) });
})
} else { } else {
cb(null, file) cb(null, file);
} }
hasExecutedOnce = true hasExecutedOnce = true;
break break;
case 'atEnd': case "atEnd":
cb(null, file) cb();
break break;
default: default:
break break;
} }
} };
let atEnd = function (cb) { let atEnd = function(cb) {
if (executionModeArg === 'atEnd') { if (executionModeArg === "atEnd") {
checkAndRunFunction(null, null).then(function () { checkAndRunFunction(null, null).then(function() {
cb() cb();
}) });
} else { } else {
cb() cb();
} }
} };
return through2.obj(forEach, atEnd) return through2.obj(forEach, atEnd);
} };
export let forEach = (funcArg: IPromiseFunction) => { export let forEach = (funcArg: IPromiseFunction) => {
return defaultExport(funcArg, 'forEach') return defaultExport(funcArg, "forEach");
} };
export let forFirst = (funcArg: IPromiseFunction) => { export let forFirst = (funcArg: IPromiseFunction) => {
return defaultExport(funcArg, 'forFirst') return defaultExport(funcArg, "forFirst");
} };
export let atEnd = (funcArg: IPromiseFunction) => { export let atEnd = (funcArg: IPromiseFunction) => {
return defaultExport(funcArg, 'atEnd') return defaultExport(funcArg, "atEnd");
} };
export default defaultExport export default defaultExport;

1471
yarn.lock

File diff suppressed because it is too large Load Diff