Compare commits
22 Commits
Author | SHA1 | Date | |
---|---|---|---|
faa4bb88a8 | |||
a95319d99f | |||
e7c0e1228b | |||
9586f34d64 | |||
6300845ec8 | |||
2316a983ed | |||
a1fa6b751e | |||
5792a13b01 | |||
1008c3f103 | |||
c366bde211 | |||
e22c6764b7 | |||
50836eab06 | |||
077834f7a4 | |||
ca348b5475 | |||
2c9ab52cee | |||
7d35f4c90b | |||
a05253bdcd | |||
54b80098d2 | |||
c39a4a6cb0 | |||
f325479a11 | |||
c79f443c18 | |||
14bb4a90bb |
19
.gitignore
vendored
19
.gitignore
vendored
@ -1,5 +1,22 @@
|
||||
node_modules/
|
||||
.nogit/
|
||||
|
||||
# artifacts
|
||||
coverage/
|
||||
public/
|
||||
pages/
|
||||
|
||||
# installs
|
||||
node_modules/
|
||||
|
||||
# caches
|
||||
.yarn/
|
||||
.cache/
|
||||
.rpt2_cache
|
||||
|
||||
# builds
|
||||
dist/
|
||||
dist_web/
|
||||
dist_serve/
|
||||
dist_ts_web/
|
||||
|
||||
# custom
|
104
.gitlab-ci.yml
104
.gitlab-ci.yml
@ -1,86 +1,126 @@
|
||||
# gitzone standard
|
||||
image: hosttoday/ht-docker-node:npmci
|
||||
# gitzone ci_default
|
||||
image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
|
||||
|
||||
cache:
|
||||
paths:
|
||||
- .yarn/
|
||||
key: "$CI_BUILD_STAGE"
|
||||
- .npmci_cache/
|
||||
key: '$CI_BUILD_STAGE'
|
||||
|
||||
stages:
|
||||
- mirror
|
||||
- security
|
||||
- test
|
||||
- release
|
||||
- trigger
|
||||
- pages
|
||||
- metadata
|
||||
|
||||
# ====================
|
||||
# security stage
|
||||
# ====================
|
||||
mirror:
|
||||
stage: mirror
|
||||
stage: security
|
||||
script:
|
||||
- npmci git mirror
|
||||
tags:
|
||||
- lossless
|
||||
- docker
|
||||
- notpriv
|
||||
|
||||
testLEGACY:
|
||||
stage: test
|
||||
snyk:
|
||||
image: registry.gitlab.com/hosttoday/ht-docker-node:snyk
|
||||
stage: security
|
||||
script:
|
||||
- npmci node install legacy
|
||||
- npmci npm install
|
||||
- npmci npm test
|
||||
coverage: /\d+.?\d+?\%\s*coverage/
|
||||
- npmci npm prepare
|
||||
- npmci command npm install --ignore-scripts
|
||||
- npmci command snyk test
|
||||
tags:
|
||||
- lossless
|
||||
- docker
|
||||
allow_failure: true
|
||||
- notpriv
|
||||
|
||||
testLTS:
|
||||
stage: test
|
||||
script:
|
||||
- npmci node install lts
|
||||
- npmci npm install
|
||||
- npmci npm test
|
||||
coverage: /\d+.?\d+?\%\s*coverage/
|
||||
tags:
|
||||
- docker
|
||||
|
||||
testSTABLE:
|
||||
# ====================
|
||||
# test stage
|
||||
# ====================
|
||||
|
||||
testStable:
|
||||
stage: test
|
||||
script:
|
||||
- npmci npm prepare
|
||||
- npmci node install stable
|
||||
- npmci npm install
|
||||
- npmci npm test
|
||||
coverage: /\d+.?\d+?\%\s*coverage/
|
||||
tags:
|
||||
- lossless
|
||||
- docker
|
||||
- priv
|
||||
|
||||
testBuild:
|
||||
stage: test
|
||||
script:
|
||||
- npmci npm prepare
|
||||
- npmci node install stable
|
||||
- npmci npm install
|
||||
- npmci command npm run build
|
||||
coverage: /\d+.?\d+?\%\s*coverage/
|
||||
tags:
|
||||
- lossless
|
||||
- docker
|
||||
- notpriv
|
||||
|
||||
release:
|
||||
stage: release
|
||||
script:
|
||||
- npmci npm prepare
|
||||
- npmci node install stable
|
||||
- npmci npm publish
|
||||
only:
|
||||
- tags
|
||||
tags:
|
||||
- lossless
|
||||
- docker
|
||||
- notpriv
|
||||
|
||||
# ====================
|
||||
# metadata stage
|
||||
# ====================
|
||||
codequality:
|
||||
stage: metadata
|
||||
allow_failure: true
|
||||
script:
|
||||
- npmci command npm install -g tslint typescript
|
||||
- npmci npm prepare
|
||||
- npmci npm install
|
||||
- npmci command "tslint -c tslint.json ./ts/**/*.ts"
|
||||
tags:
|
||||
- lossless
|
||||
- docker
|
||||
- priv
|
||||
|
||||
trigger:
|
||||
stage: trigger
|
||||
stage: metadata
|
||||
script:
|
||||
- npmci trigger
|
||||
only:
|
||||
- tags
|
||||
tags:
|
||||
- lossless
|
||||
- docker
|
||||
- notpriv
|
||||
|
||||
pages:
|
||||
image: hosttoday/ht-docker-node:npmci
|
||||
stage: pages
|
||||
stage: metadata
|
||||
script:
|
||||
- npmci command yarn global add npmpage
|
||||
- npmci command npmpage
|
||||
- npmci node install lts
|
||||
- npmci command npm install -g @gitzone/tsdoc
|
||||
- npmci npm prepare
|
||||
- npmci npm install
|
||||
- npmci command tsdoc
|
||||
tags:
|
||||
- lossless
|
||||
- docker
|
||||
- notpriv
|
||||
only:
|
||||
- tags
|
||||
artifacts:
|
||||
expire_in: 1 week
|
||||
paths:
|
||||
- public
|
||||
allow_failure: true
|
||||
|
@ -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
|
||||
|
63
README.md
63
README.md
@ -1,63 +0,0 @@
|
||||
# gulp-function
|
||||
|
||||
accepts a function call as parameter to execute in gulp pipeline
|
||||
|
||||
## Availabililty
|
||||
|
||||
[](https://www.npmjs.com/package/gulp-function)
|
||||
[](https://GitLab.com/pushrocks/gulp-function)
|
||||
[](https://github.com/pushrocks/gulp-function)
|
||||
[](https://pushrocks.gitlab.io/gulp-function/)
|
||||
|
||||
## Status for master
|
||||
|
||||
[](https://GitLab.com/pushrocks/gulp-function/commits/master)
|
||||
[](https://GitLab.com/pushrocks/gulp-function/commits/master)
|
||||
[](https://www.npmjs.com/package/gulp-function)
|
||||
[](https://david-dm.org/pushrocks/gulp-function)
|
||||
[](https://www.bithound.io/github/pushrocks/gulp-function/master/dependencies/npm)
|
||||
[](https://www.bithound.io/github/pushrocks/gulp-function)
|
||||
[](https://nodejs.org/dist/latest-v6.x/docs/api/)
|
||||
[](https://nodejs.org/dist/latest-v6.x/docs/api/)
|
||||
[](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 | **©** [Lossless GmbH](https://lossless.gmbh)
|
||||
> | By using this npm module you agree to our [privacy policy](https://lossless.gmbH/privacy.html)
|
||||
|
||||
[](https://push.rocks)
|
11
dist/index.d.ts
vendored
11
dist/index.d.ts
vendored
@ -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;
|
76
dist/index.js
vendored
76
dist/index.js
vendored
@ -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
|
@ -3,8 +3,17 @@
|
||||
"mode": "default"
|
||||
},
|
||||
"npmci": {
|
||||
"globalNpmTools": [
|
||||
"npmts"
|
||||
]
|
||||
"npmGlobalTools": [],
|
||||
"npmAccessLevel": "public"
|
||||
},
|
||||
"gitzone": {
|
||||
"module": {
|
||||
"githost": "gitlab.com",
|
||||
"gitscope": "pushrocks",
|
||||
"gitrepo": "gulp-function",
|
||||
"shortDescription": "accepts a function call as parameter to execute in gulp pipeline",
|
||||
"npmPackagename": "@pushrocks/gulp-function",
|
||||
"license": "MIT"
|
||||
}
|
||||
}
|
||||
}
|
5402
package-lock.json
generated
Normal file
5402
package-lock.json
generated
Normal file
File diff suppressed because it is too large
Load Diff
35
package.json
35
package.json
@ -1,11 +1,13 @@
|
||||
{
|
||||
"name": "gulp-function",
|
||||
"version": "2.2.12",
|
||||
"name": "@pushrocks/gulp-function",
|
||||
"private": false,
|
||||
"version": "3.0.5",
|
||||
"description": "accepts a function call as parameter to execute in gulp pipeline",
|
||||
"main": "dist/index.js",
|
||||
"typings": "dist/index.d.ts",
|
||||
"scripts": {
|
||||
"test": "(npmts)"
|
||||
"test": "(tstest test/)",
|
||||
"build": "(tsbuild)"
|
||||
},
|
||||
"repository": {
|
||||
"type": "git",
|
||||
@ -24,13 +26,28 @@
|
||||
},
|
||||
"homepage": "https://gitlab.com/pushrocks/gulp-function",
|
||||
"dependencies": {
|
||||
"@pushrocks/smartpromise": "^3.0.6",
|
||||
"@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"
|
||||
}
|
||||
"@gitzone/tsbuild": "^2.1.17",
|
||||
"@gitzone/tstest": "^1.0.28",
|
||||
"@pushrocks/smartgulp": "^2.0.2",
|
||||
"@pushrocks/tapbundle": "^3.2.0",
|
||||
"gulp": "^4.0.2",
|
||||
"tslint": "^5.20.1",
|
||||
"tslint-config-prettier": "^1.18.0"
|
||||
},
|
||||
"files": [
|
||||
"ts/**/*",
|
||||
"ts_web/**/*",
|
||||
"dist/**/*",
|
||||
"dist_web/**/*",
|
||||
"dist_ts_web/**/*",
|
||||
"assets/**/*",
|
||||
"cli.js",
|
||||
"npmextra.json",
|
||||
"readme.md"
|
||||
]
|
||||
}
|
||||
|
64
readme.md
Normal file
64
readme.md
Normal file
@ -0,0 +1,64 @@
|
||||
# @pushrocks/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/@pushrocks/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
|
||||
[](https://gitlab.com/pushrocks/gulp-function/commits/master)
|
||||
[](https://gitlab.com/pushrocks/gulp-function/commits/master)
|
||||
[](https://www.npmjs.com/package/@pushrocks/gulp-function)
|
||||
[](https://snyk.io/test/npm/@pushrocks/gulp-function)
|
||||
[](https://nodejs.org/dist/latest-v10.x/docs/api/)
|
||||
[](https://nodejs.org/dist/latest-v10.x/docs/api/)
|
||||
[](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 | **©** [Lossless GmbH](https://lossless.gmbh)
|
||||
| By using this npm module you agree to our [privacy policy](https://lossless.gmbH/privacy)
|
||||
|
||||
[](https://maintainedby.lossless.com)
|
50
test/test.ts
50
test/test.ts
@ -1,33 +1,35 @@
|
||||
import { expect, tap } from 'tapbundle'
|
||||
import { expect, tap } from '@pushrocks/tapbundle';
|
||||
|
||||
import * as smartgulp from 'smartgulp'
|
||||
let gulp = require('gulp')
|
||||
import * as gulpFunction from '../ts/index'
|
||||
import * as smartgulp from '@pushrocks/smartgulp';
|
||||
let gulp = require('gulp');
|
||||
import * as gulpFunction from '../ts/index';
|
||||
|
||||
let smartq = require('smartq')
|
||||
import * as smartpromise from '@pushrocks/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();
|
||||
|
8
ts/00_commitinfo_data.ts
Normal file
8
ts/00_commitinfo_data.ts
Normal file
@ -0,0 +1,8 @@
|
||||
/**
|
||||
* autocreated commitinfo by @pushrocks/commitinfo
|
||||
*/
|
||||
export const commitinfo = {
|
||||
name: '@pushrocks/gulp-function',
|
||||
version: '3.0.5',
|
||||
description: 'accepts a function call as parameter to execute in gulp pipeline'
|
||||
}
|
35
ts/index.ts
35
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 '@pushrocks/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;
|
||||
|
16
tslint.json
16
tslint.json
@ -1,3 +1,17 @@
|
||||
{
|
||||
"extends": "tslint-config-standard"
|
||||
"extends": ["tslint:latest", "tslint-config-prettier"],
|
||||
"rules": {
|
||||
"semicolon": [true, "always"],
|
||||
"no-console": false,
|
||||
"ordered-imports": false,
|
||||
"object-literal-sort-keys": false,
|
||||
"member-ordering": {
|
||||
"options":{
|
||||
"order": [
|
||||
"static-method"
|
||||
]
|
||||
}
|
||||
}
|
||||
},
|
||||
"defaultSeverity": "warning"
|
||||
}
|
||||
|
Reference in New Issue
Block a user