Compare commits
55 Commits
Author | SHA1 | Date | |
---|---|---|---|
e7ccd9aec4 | |||
63bf7204dd | |||
a34a1b89fe | |||
f4455a9b91 | |||
1a01198d7f | |||
b3ec364a1d | |||
5d15c96511 | |||
f6e071156b | |||
63fe7c7423 | |||
c8dcdc0df4 | |||
743c7a03a5 | |||
f9e7bf450b | |||
b55a511fcb | |||
96c15cb90a | |||
0d772e8ab0 | |||
a324deb942 | |||
cb60bec110 | |||
291583b17a | |||
9d54da207f | |||
7aad993847 | |||
c208f04e23 | |||
54d8ef2576 | |||
8b891c74e4 | |||
1d8de68a66 | |||
a2b37a066d | |||
8a2c516274 | |||
e10c31c740 | |||
af68a92702 | |||
a8c3fa048a | |||
bea33fa29f | |||
739542bda1 | |||
63cf7091a1 | |||
04d7f9cf7e | |||
afc9fd122f | |||
a3dec7bb8a | |||
0e725c3fb4 | |||
6cd0ee78a3 | |||
b037dc99df | |||
27439d84cd | |||
ada13619d0 | |||
9ae1a40260 | |||
e19184e29b | |||
36e02502d0 | |||
75219a5474 | |||
8f0ecb3f4a | |||
ec18663137 | |||
a476cf8c99 | |||
5af3185742 | |||
81849dc5eb | |||
51b9088d3e | |||
375b43a11c | |||
5b0a1edaa4 | |||
855e9b48c8 | |||
99db113285 | |||
844812311e |
10
.gitignore
vendored
10
.gitignore
vendored
@ -1,11 +1,5 @@
|
|||||||
node_modules/
|
node_modules/
|
||||||
.settings/
|
|
||||||
.idea/
|
|
||||||
coverage/
|
coverage/
|
||||||
docs/
|
public/
|
||||||
|
pages/
|
||||||
ts/*.js
|
|
||||||
ts/*.js.map
|
|
||||||
ts/typings/
|
|
||||||
test/result/
|
|
||||||
|
|
||||||
|
86
.gitlab-ci.yml
Normal file
86
.gitlab-ci.yml
Normal file
@ -0,0 +1,86 @@
|
|||||||
|
# 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
|
@ -1,3 +1,5 @@
|
|||||||
ts/
|
ts/
|
||||||
test/
|
test/
|
||||||
|
docs/
|
||||||
|
coverage/
|
||||||
node_modules/
|
node_modules/
|
||||||
|
14
.travis.yml
14
.travis.yml
@ -1,14 +0,0 @@
|
|||||||
language: node_js
|
|
||||||
node_js:
|
|
||||||
- 4.2.4
|
|
||||||
deploy:
|
|
||||||
provider: npm
|
|
||||||
email: npm@lossless.digital
|
|
||||||
api_key:
|
|
||||||
secure: TWN/oiICeNbAhGTbwf75FnKhXnIvyA66FhNF7C0jpjn2SChSgTANai87r0f9oU9ZP3307XdGHB+fTTCJnk3upNiBoWZnkV8skkAlseOY4mVzF9mS0ZEkxVR32FjJDWfqzv6hC+Y9qNDsGs2+Avsm6fQUOispLXYAk6VzSQC1HgIfyOJtIWT5LqEyXyT6oJIZ7xwt1CYcIeEpHUiAaPYsMEpwF5OBDFByVmNV38VdRGIBsoQd3lixso7/zOOgYvjR4b/onz5WzeWYlhzAuyzOnRGr1r/9eXAzzkYydvgFx3ix5OlrreKVFB6OtMpz4jmHdu9YDGT5bcvL2bSU2SGVQM5Bx8zZXkAxACQR8ZvWmPaWYAWCu9wrW5oovjqFUV0iR26z/sTABJqz4GaXf/vFcll2EdTfUT6xj2kCodfxljaudjPUF27FSt1UJBC7jQky08wHb6+onrE8WoQXteIE2oxtHWEGOlV/GAz0+q4ih0bdOSKfThmux0iEFmeF16sWH9UdL2jBBKuus+fBPdhA3V6uwYQtsCAurhquQLISkf7kT3KujdLS302bEbkut+D1Kd22IYA1J0wYd87th88TZHx7wgQyC+8lVHG+B1R20xGLxyHVEOfyZtChfBRdn53EcUiA2XriJbfiIym4dAMUtOg2iRJamHAL7jebQEUu7oA=
|
|
||||||
on:
|
|
||||||
tags: true
|
|
||||||
repo: pushrocks/gulp-function
|
|
||||||
notifications:
|
|
||||||
slack:
|
|
||||||
secure: Bb8P3fboL52CugSsp0RhOkGCeWVbgjb+QDpnMHdSOa0Nequj8V4kvrzBLZOBOjaSB0/gMvdoB4Slv2bls1dAxXW1IX1DdRb3RLMKj/Owje7eTd4IoUuSs49y6/yEkVK+E1wicdwjlMmvsk8fQE/owDRMRXYoXxhN2ZOVSQvAQ3iBO0eokFvWO7yj/VSxKoITymCXA3LfyzXXUuhvxuQd3BPZCe25xa6GWuHtaa5fbJg17pp8jJX6VZYLSRcSYyJxMU8SLdkrOsQZKj0+/Yfpu7XTmPbqxjNapuE7Zm70mi+aB26IQCnmwkdcEQNJVxQOKoP2+/ZnDfcTLQROwH1PJVzol0hneH6DdOlWt9bvBJcUvFRwaDgIb5xXQV8bGsRe5ayE/4MgCgfvdBTvevu6n12fmPx74prIv4pOPMwlALjjP8XavGL4A6amOuV7fJiSyGAku8aUe1rlUXyfoHJswMyOfkIsvnGDE3eEfq1WUIjn8tW1ZozJyoCTAIh6IHPI3Nsg3LkTRvDHPYq25/xCKWxGb2OaJc3JeqVREqm0auDqj6HoVAi/mW/uyvwX9jEVX8fNoQ69ac5VUMFfn2Mx3sU6aHKgZe/tdrtql6NYtIA+g5/ZDnHE1mnbl6MfrYiKwRbrICH5v/u1xK+4+yh09BUqazi3PzOhyTRfba/gRUg=
|
|
62
README.md
62
README.md
@ -1,51 +1,29 @@
|
|||||||
# gulp-function
|
# gulp-function
|
||||||
accepts call to execute in gulp pipeline.
|
accepts a function call as parameter to execute in gulp pipeline
|
||||||
|
|
||||||
### Status
|
## Availabililty
|
||||||
[](https://travis-ci.org/pushrocks/gulp-function)
|
[](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://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/master/dependencies/npm)
|
||||||
[](https://www.bithound.io/github/pushrocks/gulp-function)
|
[](https://www.bithound.io/github/pushrocks/gulp-function)
|
||||||
[](https://codecov.io/github/pushrocks/gulp-function?branch=master)
|
[](https://nodejs.org/dist/latest-v6.x/docs/api/)
|
||||||
|
[](https://nodejs.org/dist/latest-v6.x/docs/api/)
|
||||||
|
[](http://standardjs.com/)
|
||||||
|
|
||||||
### Version
|
## Usage
|
||||||
[](https://badge.fury.io/gh/pushrocks%2Fgulp-function)
|
Use TypeScript for best in class instellisense.
|
||||||
[](https://badge.fury.io/js/gulp-function)
|
|
||||||
|
|
||||||
### Usage
|
For further information read the linked docs at the top of this README.
|
||||||
```javascript
|
|
||||||
var gulp = require("gulp");
|
|
||||||
var gulpFunction = require("gulp-function");
|
|
||||||
var Q = require("q");
|
|
||||||
|
|
||||||
var myFunction = function () {
|
> MIT licensed | **©** [Lossless GmbH](https://lossless.gmbh)
|
||||||
var done = Q.defer();
|
| By using this npm module you agree to our [privacy policy](https://lossless.gmbH/privacy.html)
|
||||||
console.log("Hello World!")
|
|
||||||
|
|
||||||
// NOTE:
|
|
||||||
// you can use done.resolve as callback function
|
|
||||||
// of any async tasks within this function
|
|
||||||
done.resolve();
|
|
||||||
|
|
||||||
return done.promise;
|
|
||||||
}
|
|
||||||
|
|
||||||
gulp.task('gulpTest',function() {
|
[](https://push.rocks)
|
||||||
var stream = gulp.src('./mydir/*.something')
|
|
||||||
.pipe(gulpFunction(myFunction,'forEach')) //read the notes below
|
|
||||||
.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.
|
|
||||||
* 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.
|
|
||||||
* "atEnd" - executes like "forFirst" but with every chunk/vinylfile in the stream;
|
|
||||||
* "atLast" - executes after all chunks have passed and are processed in full.
|
|
||||||
That means the stream's "finish" event fires before "atLast" is executed!!!
|
|
||||||
|
6
dist/gulpfunction.plugins.js
vendored
6
dist/gulpfunction.plugins.js
vendored
@ -1,6 +0,0 @@
|
|||||||
/// <reference path="typings/main.d.ts" />
|
|
||||||
"use strict";
|
|
||||||
exports.Q = require("q");
|
|
||||||
exports.through2 = require("through2");
|
|
||||||
|
|
||||||
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJzb3VyY2VzIjpbImd1bHBmdW5jdGlvbi5wbHVnaW5zLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiJBQUFBLDBDQUEwQzs7QUFFL0IsU0FBQyxHQUFHLE9BQU8sQ0FBQyxHQUFHLENBQUMsQ0FBQztBQUNqQixnQkFBUSxHQUFHLE9BQU8sQ0FBQyxVQUFVLENBQUMsQ0FBQyIsImZpbGUiOiJndWxwZnVuY3Rpb24ucGx1Z2lucy5qcyIsInNvdXJjZXNDb250ZW50IjpbIi8vLyA8cmVmZXJlbmNlIHBhdGg9XCJ0eXBpbmdzL21haW4uZC50c1wiIC8+XG5cbmV4cG9ydCBsZXQgUSA9IHJlcXVpcmUoXCJxXCIpO1xuZXhwb3J0IGxldCB0aHJvdWdoMiA9IHJlcXVpcmUoXCJ0aHJvdWdoMlwiKTtcbiJdLCJzb3VyY2VSb290IjoiL3NvdXJjZS8ifQ==
|
|
12
dist/index.d.ts
vendored
Normal file
12
dist/index.d.ts
vendored
Normal file
@ -0,0 +1,12 @@
|
|||||||
|
/// <reference types="node" />
|
||||||
|
import 'typings-global';
|
||||||
|
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;
|
82
dist/index.js
vendored
82
dist/index.js
vendored
File diff suppressed because one or more lines are too long
40
docs/index.md
Normal file
40
docs/index.md
Normal file
@ -0,0 +1,40 @@
|
|||||||
|
### Usage
|
||||||
|
```javascript
|
||||||
|
import * as gulp from 'gulp';
|
||||||
|
import gulpFunction from 'gulp-function' // default ES6 export
|
||||||
|
// 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 done = Q.defer();
|
||||||
|
console.log("Hello World!")
|
||||||
|
|
||||||
|
// NOTE:
|
||||||
|
// you can use done.resolve as callback function
|
||||||
|
// of any async tasks within this function
|
||||||
|
done.resolve();
|
||||||
|
|
||||||
|
return done.promise;
|
||||||
|
}
|
||||||
|
|
||||||
|
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**!!!
|
10
npmextra.json
Normal file
10
npmextra.json
Normal file
@ -0,0 +1,10 @@
|
|||||||
|
{
|
||||||
|
"npmts": {
|
||||||
|
"mode": "default"
|
||||||
|
},
|
||||||
|
"npmci": {
|
||||||
|
"globalNpmTools": [
|
||||||
|
"npmts"
|
||||||
|
]
|
||||||
|
}
|
||||||
|
}
|
@ -1,4 +0,0 @@
|
|||||||
{
|
|
||||||
"mode":"default",
|
|
||||||
"coveralls":true
|
|
||||||
}
|
|
24
package.json
24
package.json
@ -1,17 +1,15 @@
|
|||||||
{
|
{
|
||||||
"name": "gulp-function",
|
"name": "gulp-function",
|
||||||
"version": "1.2.1",
|
"version": "2.2.11",
|
||||||
"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",
|
||||||
"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",
|
||||||
"url": "https://github.com/pushrocks/gulp-function.git"
|
"url": "https://gitlab.com/pushrocks/gulp-function.git"
|
||||||
},
|
},
|
||||||
"keywords": [
|
"keywords": [
|
||||||
"gulpplugin",
|
"gulpplugin",
|
||||||
@ -21,16 +19,18 @@
|
|||||||
"author": "Lossless GmbH <office@lossless.com> (https://lossless.com)",
|
"author": "Lossless GmbH <office@lossless.com> (https://lossless.com)",
|
||||||
"license": "MIT",
|
"license": "MIT",
|
||||||
"bugs": {
|
"bugs": {
|
||||||
"url": "https://github.com/pushrocks/gulp-function/issues"
|
"url": "https://gitlab.com/pushrocks/gulp-function/issues"
|
||||||
},
|
},
|
||||||
"homepage": "https://github.com/pushrocks/gulp-function",
|
"homepage": "https://gitlab.com/pushrocks/gulp-function",
|
||||||
"dependencies": {
|
"dependencies": {
|
||||||
"beautylog": "^3.1.2",
|
"@types/through2": "^2.0.32",
|
||||||
"q": "^1.4.1",
|
"smartq": "^1.1.6",
|
||||||
"through2": "^2.0.1"
|
"through2": "^2.0.3",
|
||||||
|
"typings-global": "^1.0.16"
|
||||||
},
|
},
|
||||||
"devDependencies": {
|
"devDependencies": {
|
||||||
"gulp": "^3.9.1",
|
"gulp": "^3.9.1",
|
||||||
"npmts": "^4.0.2"
|
"smartgulp": "^1.0.1",
|
||||||
|
"tapbundle": "^1.0.10"
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
102
test/test.js
102
test/test.js
File diff suppressed because one or more lines are too long
@ -1 +0,0 @@
|
|||||||
{"version":3,"file":"test.js","sourceRoot":"","sources":["test.ts"],"names":[],"mappings":"AAAA,gDAAgD;AAChD,IAAI,IAAI,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC;AAC3B,IAAI,YAAY,GAAG,OAAO,CAAC,kBAAkB,CAAC,CAAC;AAC/C,IAAI,SAAS,GAAG,OAAO,CAAC,WAAW,CAAC,CAAC;AACrC,IAAI,CAAC,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC;AAErB,IAAI,UAAU,GAAG;IACb,IAAI,IAAI,GAAG,CAAC,CAAC,KAAK,EAAE,CAAA;IACpB,SAAS,CAAC,GAAG,CAAC,mBAAmB,CAAC,CAAC;IACnC,IAAI,CAAC,OAAO,EAAE,CAAC;IACf,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC;AACxB,CAAC,CAAC;AACF,IAAI,WAAW,GAAG;IACd,IAAI,IAAI,GAAG,CAAC,CAAC,KAAK,EAAE,CAAC;IACrB,SAAS,CAAC,EAAE,CAAC,oBAAoB,CAAC,CAAC;IACnC,IAAI,CAAC,OAAO,EAAE,CAAC;IACf,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC;AACxB,CAAC,CAAC;AACF,IAAI,WAAW,GAAG;IACd,IAAI,IAAI,GAAG,CAAC,CAAC,KAAK,EAAE,CAAC;IACrB,SAAS,CAAC,OAAO,CAAC,oBAAoB,CAAC,CAAC;IACxC,IAAI,CAAC,OAAO,EAAE,CAAC;IACf,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC;AACxB,CAAC,CAAC;AAEF,IAAI,cAAc,GAAG;IACjB,IAAI,IAAI,GAAG,CAAC,CAAC,KAAK,EAAE,CAAC;IACrB,SAAS,CAAC,OAAO,CAAC,yBAAyB,CAAC,CAAC;IAC7C,IAAI,CAAC,OAAO,EAAE,CAAC;IACf,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC;AACxB,CAAC,CAAC;AAEF,IAAI,iBAAiB,GAAG,KAAK,CAAC;AAE9B,IAAI,cAAc,GAAG;IACjB,IAAI,IAAI,GAAG,CAAC,CAAC,KAAK,EAAE,CAAC;IACrB,SAAS,CAAC,OAAO,CAAC,yBAAyB,CAAC,CAAC;IAC7C,UAAU,CAAC;QACP,SAAS,CAAC,GAAG,CAAC,eAAe,CAAC,CAAC;QAC/B,iBAAiB,GAAG,IAAI,CAAC;QACzB,IAAI,CAAC,OAAO,EAAE,CAAC;IACnB,CAAC,EAAE,GAAG,CAAC,CAAC;IACR,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC;AACxB,CAAC,CAAC;AAEF,IAAI,aAAa,GAAG;IAChB,IAAI,IAAI,GAAG,CAAC,CAAC,KAAK,EAAE,CAAC;IACrB,SAAS,CAAC,OAAO,CAAC,wBAAwB,CAAC,CAAC;IAC5C,IAAI,CAAC,OAAO,EAAE,CAAC;IACf,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC;AACxB,CAAC,CAAC;AAEF,IAAI,eAAe,GAAG;IAClB,IAAI,IAAI,GAAG,CAAC,CAAC,KAAK,EAAE,CAAC;IACrB,UAAU,CAAC;QACP,SAAS,CAAC,GAAG,CAAC,oBAAoB,CAAC,CAAC;QACpC,IAAI,CAAC,OAAO,EAAE,CAAC;IACnB,CAAC,EAAC,IAAI,CAAC,CAAC;IACR,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC;AACxB,CAAC,CAAC;AAIF,QAAQ,CAAC,cAAc,EAAC;IACpB,EAAE,CAAC,mCAAmC,GAAG,WAAW,CAAC,IAAI,EAAC,UAAS,IAAI;QACnE,IAAI,CAAC,GAAG,CAAC,aAAa,CAAC;aAClB,IAAI,CAAC,YAAY,CAAC,UAAU,EAAC,SAAS,CAAC,CAAC;aACxC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,gBAAgB,CAAC,CAAC,CAAC;QAEvC,IAAI,CAAC,GAAG,CAAC,aAAa,CAAC;aAClB,IAAI,CAAC,YAAY,CAAC,CAAC,WAAW,EAAC,WAAW,CAAC,EAAC,SAAS,CAAC,CAAC;aACvD,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,gBAAgB,CAAC,CAAC;aACjC,IAAI,CAAC,YAAY,CAAC,IAAI,EAAC,OAAO,CAAC,CAAC,CAAC;IAE1C,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,mCAAmC,GAAG,SAAS,CAAC,IAAI,EAAC,UAAS,IAAI;QACjE,IAAI,CAAC,GAAG,CAAC,aAAa,CAAC;aAClB,IAAI,CAAC,YAAY,CAAC,UAAU,EAAC,OAAO,CAAC,CAAC;aACtC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,gBAAgB,CAAC,CAAC,CAAC;QAEvC,IAAI,CAAC,GAAG,CAAC,aAAa,CAAC;aAClB,IAAI,CAAC,YAAY,CAAC,CAAC,WAAW,EAAC,WAAW,CAAC,EAAC,OAAO,CAAC,CAAC;aACrD,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,gBAAgB,CAAC,CAAC;aACjC,IAAI,CAAC,YAAY,CAAC,IAAI,EAAC,OAAO,CAAC,CAAC,CAAC;IAC1C,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,wCAAwC,GAAG,WAAW,CAAC,IAAI,EAAC,UAAS,IAAI;QAExE,IAAI,CAAC,GAAG,CAAC,aAAa,CAAC;aAClB,IAAI,CAAC,YAAY,CAAC,CAAC,WAAW,EAAC,WAAW,CAAC,EAAC,UAAU,CAAC,CAAC;aACxD,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,gBAAgB,CAAC,CAAC;aACjC,IAAI,CAAC,YAAY,CAAC,IAAI,EAAC,OAAO,CAAC,CAAC,CAAC;IAC1C,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,qBAAqB,EAAC,UAAS,IAAI;QAClC,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;QACnB,IAAI,MAAM,GAAG,IAAI,CAAC,GAAG,CAAC,aAAa,CAAC;aAC/B,IAAI,CAAC,YAAY,CAAC,CAAC,cAAc,EAAC,cAAc,EAAC,cAAc,CAAC,EAAC,OAAO,CAAC,CAAC;aAC1E,IAAI,CAAC,YAAY,CAAC;YACf,SAAS,CAAC,GAAG,CAAC,mBAAmB,CAAC,CAAC;YACnC,IAAI,KAAK,GAAG,CAAC,CAAC,KAAK,EAAE,CAAC;YACtB,KAAK,CAAC,OAAO,EAAE,CAAC;YAChB,MAAM,CAAC,KAAK,CAAC,OAAO,CAAC;QACzB,CAAC,EAAC,SAAS,CAAC,CAAC;aACZ,IAAI,CAAC,YAAY,CAAC;YACf,SAAS,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC;QAC9B,CAAC,CAAC,CAAC;aACF,IAAI,CAAC,YAAY,CAAC,aAAa,EAAC,OAAO,CAAC,CAAC;aACzC,IAAI,CAAC,YAAY,CAAC,eAAe,EAAC,OAAO,CAAC,CAAC,CAAC;QAEjD,MAAM,CAAC,EAAE,CAAC,QAAQ,EAAC;YACf,SAAS,CAAC,IAAI,CAAC,iBAAiB,CAAC,CAAC;YAClC,IAAI,EAAE,CAAC;QACX,CAAC,CAAC,CAAC;IACP,CAAC,CAAC,CAAC;AACP,CAAC,CAAC,CAAC"}
|
|
141
test/test.ts
141
test/test.ts
@ -1,118 +1,33 @@
|
|||||||
/// <reference path="../ts/typings/main.d.ts" />
|
import { expect, tap } from 'tapbundle'
|
||||||
var gulp = require("gulp");
|
|
||||||
var gulpFunction = require("../dist/index.js");
|
|
||||||
var beautylog = require("beautylog");
|
|
||||||
var Q = require("q");
|
|
||||||
|
|
||||||
var myFunction = function () {
|
import * as smartgulp from 'smartgulp'
|
||||||
var done = Q.defer()
|
let gulp = require('gulp')
|
||||||
beautylog.log("Function executed");
|
import * as gulpFunction from '../ts/index'
|
||||||
done.resolve();
|
|
||||||
return done.promise;
|
|
||||||
};
|
|
||||||
var myFunction2 = function () {
|
|
||||||
var done = Q.defer();
|
|
||||||
beautylog.ok("Function2 executed");
|
|
||||||
done.resolve();
|
|
||||||
return done.promise;
|
|
||||||
};
|
|
||||||
var myFunction3 = function () {
|
|
||||||
var done = Q.defer();
|
|
||||||
beautylog.success("Function3 executed");
|
|
||||||
done.resolve();
|
|
||||||
return done.promise;
|
|
||||||
};
|
|
||||||
|
|
||||||
var beforeFunction = function () {
|
let smartq = require('smartq')
|
||||||
var done = Q.defer();
|
|
||||||
beautylog.success("beforeFunction executed");
|
|
||||||
done.resolve();
|
|
||||||
return done.promise;
|
|
||||||
};
|
|
||||||
|
|
||||||
var middleFunctionRun = false;
|
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++
|
||||||
|
if (counter === 2) {
|
||||||
|
done.resolve()
|
||||||
|
}
|
||||||
|
}))
|
||||||
|
await done.promise
|
||||||
|
})
|
||||||
|
|
||||||
var middleFunction = function () {
|
tap.test('should run through smoothly with ' + "'forEach'", async (tools) => {
|
||||||
var done = Q.defer();
|
let done = smartq.defer()
|
||||||
beautylog.success("middleFunction executed");
|
let counter = 0
|
||||||
setTimeout(function(){
|
smartgulp.src(['./test/testfiles/*.md'])
|
||||||
beautylog.log("timeout fired");
|
.pipe(gulpFunction.atEnd(async () => {
|
||||||
middleFunctionRun = true;
|
console.log('atEnd')
|
||||||
done.resolve();
|
done.resolve()
|
||||||
}, 500);
|
}))
|
||||||
return done.promise;
|
await done.promise
|
||||||
};
|
})
|
||||||
|
|
||||||
var afterFunction = function () {
|
|
||||||
var done = Q.defer();
|
|
||||||
beautylog.success("afterFunction executed");
|
|
||||||
done.resolve();
|
|
||||||
return done.promise;
|
|
||||||
};
|
|
||||||
|
|
||||||
let timeoutFunction = function(){
|
|
||||||
var done = Q.defer();
|
|
||||||
setTimeout(function(){
|
|
||||||
beautylog.log("largeTimeout fired");
|
|
||||||
done.resolve();
|
|
||||||
},2000);
|
|
||||||
return done.promise;
|
|
||||||
};
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
describe("gulpFunction",function(){
|
|
||||||
it("should run through smoothly with " + "'forEach'".blue,function(done){
|
|
||||||
gulp.src('./test/*.md')
|
|
||||||
.pipe(gulpFunction(myFunction,'forEach'))
|
|
||||||
.pipe(gulp.dest("./test/result/"));
|
|
||||||
|
|
||||||
gulp.src('./test/*.md')
|
|
||||||
.pipe(gulpFunction([myFunction2,myFunction3],'forEach'))
|
|
||||||
.pipe(gulp.dest("./test/result/"))
|
|
||||||
.pipe(gulpFunction(done,"atEnd"));
|
|
||||||
|
|
||||||
});
|
|
||||||
|
|
||||||
it("should run through smoothly with " + "'atEnd'".blue,function(done){
|
|
||||||
gulp.src('./test/*.md')
|
|
||||||
.pipe(gulpFunction(myFunction,'atEnd'))
|
|
||||||
.pipe(gulp.dest("./test/result/"));
|
|
||||||
|
|
||||||
gulp.src('./test/*.md')
|
|
||||||
.pipe(gulpFunction([myFunction2,myFunction3],'atEnd'))
|
|
||||||
.pipe(gulp.dest("./test/result/"))
|
|
||||||
.pipe(gulpFunction(done,"atEnd"));
|
|
||||||
});
|
|
||||||
|
|
||||||
it("should run through smoothly once with " + "'atFirst'".blue,function(done){
|
|
||||||
|
|
||||||
gulp.src('./test/*.md')
|
|
||||||
.pipe(gulpFunction([myFunction2,myFunction3],'forFirst'))
|
|
||||||
.pipe(gulp.dest("./test/result/"))
|
|
||||||
.pipe(gulpFunction(done,"atEnd"));
|
|
||||||
});
|
|
||||||
|
|
||||||
it("should run in order",function(done){
|
|
||||||
this.timeout(5000);
|
|
||||||
let stream = gulp.src('./test/*.md')
|
|
||||||
.pipe(gulpFunction([beforeFunction,middleFunction,middleFunction],'atEnd'))
|
|
||||||
.pipe(gulpFunction(function(){
|
|
||||||
beautylog.log("stream progressed");
|
|
||||||
var done2 = Q.defer();
|
|
||||||
done2.resolve();
|
|
||||||
return done2.promise;
|
|
||||||
},"forEach"))
|
|
||||||
.pipe(gulpFunction(function(){
|
|
||||||
beautylog.log("nextStep");
|
|
||||||
}))
|
|
||||||
.pipe(gulpFunction(afterFunction,"atEnd"))
|
|
||||||
.pipe(gulpFunction(timeoutFunction,"atEnd"));
|
|
||||||
|
|
||||||
stream.on("finish",function(){
|
|
||||||
beautylog.info("stream finished");
|
|
||||||
done();
|
|
||||||
});
|
|
||||||
});
|
|
||||||
});
|
|
||||||
|
|
||||||
|
tap.start()
|
||||||
|
@ -1,2 +0,0 @@
|
|||||||
# Test.md
|
|
||||||
This is a test file for the test.js gulp pipeline
|
|
@ -1,2 +0,0 @@
|
|||||||
# Test.md
|
|
||||||
This is another test file for the test.js gulp pipeline
|
|
1
test/testfiles/test01.md
Normal file
1
test/testfiles/test01.md
Normal file
@ -0,0 +1 @@
|
|||||||
|
# the 1st testfile
|
1
test/testfiles/test02.md
Normal file
1
test/testfiles/test02.md
Normal file
@ -0,0 +1 @@
|
|||||||
|
# the second testfile
|
1
test/testfiles/test03.md
Normal file
1
test/testfiles/test03.md
Normal file
@ -0,0 +1 @@
|
|||||||
|
# the third testfile
|
1
test/testfiles/test04.md
Normal file
1
test/testfiles/test04.md
Normal file
@ -0,0 +1 @@
|
|||||||
|
# the fourth testfile
|
1
test/testfiles/test05.md
Normal file
1
test/testfiles/test05.md
Normal file
@ -0,0 +1 @@
|
|||||||
|
# the fifth testfile
|
1
test/testfiles/test06.md
Normal file
1
test/testfiles/test06.md
Normal file
@ -0,0 +1 @@
|
|||||||
|
# the sixth testfile
|
1
test/testfiles/test07.md
Normal file
1
test/testfiles/test07.md
Normal file
@ -0,0 +1 @@
|
|||||||
|
# the seventh testfile
|
1
test/testfiles/test08.md
Normal file
1
test/testfiles/test08.md
Normal file
@ -0,0 +1 @@
|
|||||||
|
# the eighth testfile
|
1
test/testfiles/test09.md
Normal file
1
test/testfiles/test09.md
Normal file
@ -0,0 +1 @@
|
|||||||
|
# the nineth testfile
|
1
test/testfiles/test10.md
Normal file
1
test/testfiles/test10.md
Normal file
@ -0,0 +1 @@
|
|||||||
|
# the tenth testfile
|
1
test/testfiles/test11.md
Normal file
1
test/testfiles/test11.md
Normal file
@ -0,0 +1 @@
|
|||||||
|
# the eleventh testfile
|
1
test/testfiles/test12.md
Normal file
1
test/testfiles/test12.md
Normal file
@ -0,0 +1 @@
|
|||||||
|
# the twelveth testfile
|
1
test/testfiles/test13.md
Normal file
1
test/testfiles/test13.md
Normal file
@ -0,0 +1 @@
|
|||||||
|
# the second testfile
|
1
test/testfiles/test14.md
Normal file
1
test/testfiles/test14.md
Normal file
@ -0,0 +1 @@
|
|||||||
|
# the second testfile
|
1
test/testfiles/test15.md
Normal file
1
test/testfiles/test15.md
Normal file
@ -0,0 +1 @@
|
|||||||
|
# the second testfile
|
1
test/testfiles/test16.md
Normal file
1
test/testfiles/test16.md
Normal file
@ -0,0 +1 @@
|
|||||||
|
# the second testfile
|
1
test/testfiles/test17.md
Normal file
1
test/testfiles/test17.md
Normal file
@ -0,0 +1 @@
|
|||||||
|
# the second testfile
|
1
test/testfiles/test18.md
Normal file
1
test/testfiles/test18.md
Normal file
@ -0,0 +1 @@
|
|||||||
|
# the 18th testfile
|
@ -1,4 +0,0 @@
|
|||||||
/// <reference path="typings/main.d.ts" />
|
|
||||||
|
|
||||||
export let Q = require("q");
|
|
||||||
export let through2 = require("through2");
|
|
134
ts/index.ts
134
ts/index.ts
@ -1,65 +1,89 @@
|
|||||||
/// <reference path="typings/main.d.ts" />
|
import 'typings-global'
|
||||||
|
import * as q from 'smartq'
|
||||||
|
import * as through2 from 'through2'
|
||||||
|
import { Transform } from 'stream'
|
||||||
|
|
||||||
import plugins = require("./gulpfunction.plugins");
|
export type TExecutionMode = 'forEach' | 'forFirst' | 'atEnd'
|
||||||
|
|
||||||
|
export interface IPromiseFunction {
|
||||||
|
(file?, enc?): PromiseLike<any>
|
||||||
|
}
|
||||||
|
|
||||||
|
let defaultExport = (
|
||||||
|
functionsToExecuteArg: IPromiseFunction | IPromiseFunction[],
|
||||||
|
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') {
|
||||||
|
promiseArray.push(returnValue)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
module.exports = function (functionsToExecuteArg:any|any[],executionModeArg:string = 'forEach') {
|
let checkAndRunFunction = function (file, enc) {
|
||||||
//important vars
|
if (typeof functionsToExecuteArg === 'function') {
|
||||||
let executionMode = executionModeArg; //can be forEach or atEnd
|
runFunction(functionsToExecuteArg, file, enc)
|
||||||
let functionsToExecute = functionsToExecuteArg;
|
} else if (Array.isArray(functionsToExecuteArg)) {
|
||||||
let promiseArray = [];
|
for (let anyFunction in functionsToExecuteArg) {
|
||||||
let runFunction = function(functionArg){
|
runFunction(functionsToExecuteArg[ anyFunction ], file, enc)
|
||||||
let returnValue = functionArg();
|
}
|
||||||
if (typeof returnValue !== "undefined" && typeof returnValue.then !== "undefined") {
|
} else {
|
||||||
promiseArray.push(returnValue);
|
throw new Error('gulp-callfunction: something is strange with the given arguments')
|
||||||
}
|
}
|
||||||
};
|
return Promise.all(promiseArray)
|
||||||
|
}
|
||||||
|
|
||||||
let checkAndRunFunction = function () {
|
let hasExecutedOnce = false
|
||||||
if (typeof functionsToExecute === "function" ) {
|
let forEach = function (file, enc, cb) { // the forEach function is called for every chunk
|
||||||
runFunction(functionsToExecute);
|
switch (executionModeArg) {
|
||||||
} else if (Array.isArray(functionsToExecute)) {
|
case 'forEach':
|
||||||
for (let anyFunction in functionsToExecute) {
|
checkAndRunFunction(file, enc).then(function () {
|
||||||
runFunction(functionsToExecute[anyFunction]);
|
cb(null, file)
|
||||||
}
|
})
|
||||||
|
break
|
||||||
|
case 'forFirst':
|
||||||
|
if (hasExecutedOnce) {
|
||||||
|
checkAndRunFunction(file, enc)
|
||||||
|
.then(function () {
|
||||||
|
cb(null, file)
|
||||||
|
})
|
||||||
} else {
|
} else {
|
||||||
throw new Error("gulp-callfunction: something is strange with the given arguments");
|
cb(null, file)
|
||||||
}
|
}
|
||||||
return plugins.Q.all(promiseArray);
|
hasExecutedOnce = true
|
||||||
};
|
break
|
||||||
|
case 'atEnd':
|
||||||
|
cb()
|
||||||
|
break
|
||||||
|
default:
|
||||||
|
break
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
let hasExecutedOnce = false;
|
let atEnd = function (cb) {
|
||||||
let forEach = function (file, enc, cb) { //the forEach function is called for every chunk
|
if (executionModeArg === 'atEnd') {
|
||||||
switch (executionMode){
|
checkAndRunFunction(null, null).then(function () {
|
||||||
case "forEach":
|
cb()
|
||||||
checkAndRunFunction().then(function(){
|
})
|
||||||
cb(null, file);
|
} else {
|
||||||
});
|
cb()
|
||||||
break;
|
}
|
||||||
case "forFirst":
|
}
|
||||||
!hasExecutedOnce ? checkAndRunFunction().then(function(){
|
return through2.obj(forEach, atEnd)
|
||||||
cb(null, file);
|
}
|
||||||
}) : cb(null, file);
|
|
||||||
hasExecutedOnce = true;
|
|
||||||
break;
|
|
||||||
case "atEnd":
|
|
||||||
cb(null, file);
|
|
||||||
break;
|
|
||||||
default:
|
|
||||||
break;
|
|
||||||
}
|
|
||||||
};
|
|
||||||
|
|
||||||
let atEnd = function(cb) {
|
export let forEach = (funcArg: IPromiseFunction) => {
|
||||||
if (executionMode === "atEnd") {
|
return defaultExport(funcArg, 'forEach')
|
||||||
checkAndRunFunction().then(function(){
|
}
|
||||||
cb();
|
|
||||||
});
|
export let forFirst = (funcArg: IPromiseFunction) => {
|
||||||
} else {
|
return defaultExport(funcArg, 'forFirst')
|
||||||
cb();
|
}
|
||||||
}
|
|
||||||
};
|
export let atEnd = (funcArg: IPromiseFunction) => {
|
||||||
return plugins.through2.obj(forEach,atEnd);
|
return defaultExport(funcArg, 'atEnd')
|
||||||
};
|
}
|
||||||
|
|
||||||
|
export default defaultExport
|
||||||
|
15
ts/tsd.json
15
ts/tsd.json
@ -1,15 +0,0 @@
|
|||||||
{
|
|
||||||
"version": "v4",
|
|
||||||
"repo": "borisyankov/DefinitelyTyped",
|
|
||||||
"ref": "master",
|
|
||||||
"path": "typings",
|
|
||||||
"bundle": "typings/tsd.d.ts",
|
|
||||||
"installed": {
|
|
||||||
"node/node.d.ts": {
|
|
||||||
"commit": "efa0c1196d7280640e624ac1e7fa604502e7bd63"
|
|
||||||
},
|
|
||||||
"colors/colors.d.ts": {
|
|
||||||
"commit": "3191f6e0088eee07c4d8fd24e4d27a40a60d9eb9"
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
@ -1,7 +0,0 @@
|
|||||||
{
|
|
||||||
"ambientDependencies": {
|
|
||||||
"node": "github:DefinitelyTyped/DefinitelyTyped/node/node.d.ts",
|
|
||||||
"mocha": "github:Bartvds/tsd-deftools/typings/DefinitelyTyped/mocha/mocha.d.ts",
|
|
||||||
"colors": "github:DefinitelyTyped/DefinitelyTyped/colors/colors.d.ts"
|
|
||||||
}
|
|
||||||
}
|
|
3
tslint.json
Normal file
3
tslint.json
Normal file
@ -0,0 +1,3 @@
|
|||||||
|
{
|
||||||
|
"extends": "tslint-config-standard"
|
||||||
|
}
|
Reference in New Issue
Block a user