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

switched to ES6 default import

Browse Source
This commit is contained in:
Philipp Kunz 2016-10-19 01:10:45 +02:00
parent e10c31c740
commit 8a2c516274
7 changed files with 118 additions and 110 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
README.md
View File

@ -19,8 +19,8 @@ accepts call to execute in gulp pipeline.
### Usage ### Usage
```javascript ```javascript
let gulp = require("gulp"); import * as gulp from 'gulp';
let gulpFunction = require("gulp-function"); import gulpFunction from 'gulp-function' // default ES6 export
let Q = require("q"); let Q = require("q");
let myFunction = function (file, enc) { // file and enc are optional in case you want to modify the file object let myFunction = function (file, enc) { // file and enc are optional in case you want to modify the file object

4
dist/index.d.ts vendored
View File

@ -1,5 +1,9 @@
/// <reference types="node" />
import 'typings-global'; import 'typings-global';
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>;
} }
declare let mainExportFunction: (functionsToExecuteArg: IPromiseFunction | IPromiseFunction[], executionModeArg?: TExecutionMode) => Transform;
export default mainExportFunction;

6
dist/index.js vendored
View File

@ -2,7 +2,7 @@
require("typings-global"); require("typings-global");
const q = require("q"); const q = require("q");
const through2 = require("through2"); const through2 = require("through2");
module.exports = (functionsToExecuteArg, executionModeArg = 'forEach') => { let mainExportFunction = (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);
@ -63,4 +63,6 @@ module.exports = (functionsToExecuteArg, executionModeArg = 'forEach') => {
}; };
return through2.obj(forEach, atEnd); return through2.obj(forEach, atEnd);
}; };
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi90cy9pbmRleC50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiO0FBQUEsMEJBQXVCO0FBQ3ZCLHVCQUFzQjtBQUN0QixxQ0FBb0M7QUFTcEMsTUFBTSxDQUFDLE9BQU8sR0FBRyxDQUNiLHFCQUE0RCxFQUM1RCxnQkFBZ0IsR0FBbUIsU0FBUztJQUc1QyxJQUFJLFlBQVksR0FBRyxFQUFFLENBQUE7SUFDckIsSUFBSSxXQUFXLEdBQUcsVUFBVSxXQUFXLEVBQUUsSUFBSSxFQUFFLEdBQUc7UUFDOUMsSUFBSSxXQUFXLEdBQUcsV0FBVyxDQUFDLElBQUksRUFBRSxHQUFHLENBQUMsQ0FBQTtRQUN4QyxFQUFFLENBQUMsQ0FBQyxPQUFPLFdBQVcsS0FBSyxXQUFXLElBQUksT0FBTyxXQUFXLENBQUMsSUFBSSxLQUFLLFdBQVcsQ0FBQyxDQUFDLENBQUM7WUFDaEYsWUFBWSxDQUFDLElBQUksQ0FBQyxXQUFXLENBQUMsQ0FBQTtRQUNsQyxDQUFDO0lBQ0wsQ0FBQyxDQUFBO0lBRUQsSUFBSSxtQkFBbUIsR0FBRyxVQUFVLElBQUksRUFBRSxHQUFHO1FBQ3pDLEVBQUUsQ0FBQyxDQUFDLE9BQU8scUJBQXFCLEtBQUssVUFBVSxDQUFDLENBQUMsQ0FBQztZQUM5QyxXQUFXLENBQUMscUJBQXFCLEVBQUUsSUFBSSxFQUFFLEdBQUcsQ0FBQyxDQUFBO1FBQ2pELENBQUM7UUFBQyxJQUFJLENBQUMsRUFBRSxDQUFDLENBQUMsS0FBSyxDQUFDLE9BQU8sQ0FBQyxxQkFBcUIsQ0FBQyxDQUFDLENBQUMsQ0FBQztZQUM5QyxHQUFHLENBQUMsQ0FBQyxJQUFJLFdBQVcsSUFBSSxxQkFBcUIsQ0FBQyxDQUFDLENBQUM7Z0JBQzVDLFdBQVcsQ0FBQyxxQkFBcUIsQ0FBQyxXQUFXLENBQUMsRUFBRSxJQUFJLEVBQUUsR0FBRyxDQUFDLENBQUE7WUFDOUQsQ0FBQztRQUNMLENBQUM7UUFBQyxJQUFJLENBQUMsQ0FBQztZQUNKLE1BQU0sSUFBSSxLQUFLLENBQUMsa0VBQWtFLENBQUMsQ0FBQTtRQUN2RixDQUFDO1FBQ0QsTUFBTSxDQUFDLENBQUMsQ0FBQyxHQUFHLENBQUMsWUFBWSxDQUFDLENBQUE7SUFDOUIsQ0FBQyxDQUFBO0lBRUQsSUFBSSxlQUFlLEdBQUcsS0FBSyxDQUFBO0lBQzNCLElBQUksT0FBTyxHQUFHLFVBQVUsSUFBSSxFQUFFLEdBQUcsRUFBRSxFQUFFO1FBQ2pDLE1BQU0sQ0FBQyxDQUFDLGdCQUFnQixDQUFDLENBQUMsQ0FBQztZQUN2QixLQUFLLFNBQVM7Z0JBQ1YsbUJBQW1CLENBQUMsSUFBSSxFQUFFLEdBQUcsQ0FBQyxDQUFDLElBQUksQ0FBQztvQkFDaEMsRUFBRSxDQUFDLElBQUksRUFBRSxJQUFJLENBQUMsQ0FBQTtnQkFDbEIsQ0FBQyxDQUFDLENBQUE7Z0JBQ0YsS0FBSyxDQUFBO1lBQ1QsS0FBSyxVQUFVO2dCQUNYLEVBQUUsQ0FBQyxDQUFDLGVBQWUsQ0FBQyxDQUFDLENBQUM7b0JBQ2xCLG1CQUFtQixDQUFDLElBQUksRUFBRSxHQUFHLENBQUM7eUJBQ3pCLElBQUksQ0FBQzt3QkFDRixFQUFFLENBQUMsSUFBSSxFQUFFLElBQUksQ0FBQyxDQUFBO29CQUNsQixDQUFDLENBQUMsQ0FBQTtnQkFDVixDQUFDO2dCQUFDLElBQUksQ0FBQyxDQUFDO29CQUNKLEVBQUUsQ0FBQyxJQUFJLEVBQUUsSUFBSSxDQUFDLENBQUE7Z0JBQ2xCLENBQUM7Z0JBQ0QsZUFBZSxHQUFHLElBQUksQ0FBQTtnQkFDdEIsS0FBSyxDQUFBO1lBQ1QsS0FBSyxPQUFPO2dCQUNSLEVBQUUsQ0FBQyxJQUFJLEVBQUUsSUFBSSxDQUFDLENBQUE7Z0JBQ2QsS0FBSyxDQUFBO1lBQ1Q7Z0JBQ0ksS0FBSyxDQUFBO1FBQ2IsQ0FBQztJQUNMLENBQUMsQ0FBQTtJQUVELElBQUksS0FBSyxHQUFHLFVBQVUsRUFBRTtRQUNwQixFQUFFLENBQUMsQ0FBQyxnQkFBZ0IsS0FBSyxPQUFPLENBQUMsQ0FBQyxDQUFDO1lBQy9CLG1CQUFtQixDQUFDLElBQUksRUFBRSxJQUFJLENBQUMsQ0FBQyxJQUFJLENBQUM7Z0JBQ2pDLEVBQUUsRUFBRSxDQUFBO1lBQ1IsQ0FBQyxDQUFDLENBQUE7UUFDTixDQUFDO1FBQUMsSUFBSSxDQUFDLENBQUM7WUFDSixFQUFFLEVBQUUsQ0FBQTtRQUNSLENBQUM7SUFDTCxDQUFDLENBQUE7SUFDRCxNQUFNLENBQUMsUUFBUSxDQUFDLEdBQUcsQ0FBQyxPQUFPLEVBQUUsS0FBSyxDQUFDLENBQUE7QUFDdkMsQ0FBQyxDQUFBIn0= Object.defineProperty(exports, "__esModule", { value: true });
exports.default = mainExportFunction;
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi90cy9pbmRleC50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiO0FBQUEsMEJBQXVCO0FBQ3ZCLHVCQUFzQjtBQUN0QixxQ0FBb0M7QUFTcEMsSUFBSSxrQkFBa0IsR0FBRyxDQUNyQixxQkFBNEQsRUFDNUQsZ0JBQWdCLEdBQW1CLFNBQVM7SUFHNUMsSUFBSSxZQUFZLEdBQUcsRUFBRSxDQUFBO0lBQ3JCLElBQUksV0FBVyxHQUFHLFVBQVUsV0FBVyxFQUFFLElBQUksRUFBRSxHQUFHO1FBQzlDLElBQUksV0FBVyxHQUFHLFdBQVcsQ0FBQyxJQUFJLEVBQUUsR0FBRyxDQUFDLENBQUE7UUFDeEMsRUFBRSxDQUFDLENBQUMsT0FBTyxXQUFXLEtBQUssV0FBVyxJQUFJLE9BQU8sV0FBVyxDQUFDLElBQUksS0FBSyxXQUFXLENBQUMsQ0FBQyxDQUFDO1lBQ2hGLFlBQVksQ0FBQyxJQUFJLENBQUMsV0FBVyxDQUFDLENBQUE7UUFDbEMsQ0FBQztJQUNMLENBQUMsQ0FBQTtJQUVELElBQUksbUJBQW1CLEdBQUcsVUFBVSxJQUFJLEVBQUUsR0FBRztRQUN6QyxFQUFFLENBQUMsQ0FBQyxPQUFPLHFCQUFxQixLQUFLLFVBQVUsQ0FBQyxDQUFDLENBQUM7WUFDOUMsV0FBVyxDQUFDLHFCQUFxQixFQUFFLElBQUksRUFBRSxHQUFHLENBQUMsQ0FBQTtRQUNqRCxDQUFDO1FBQUMsSUFBSSxDQUFDLEVBQUUsQ0FBQyxDQUFDLEtBQUssQ0FBQyxPQUFPLENBQUMscUJBQXFCLENBQUMsQ0FBQyxDQUFDLENBQUM7WUFDOUMsR0FBRyxDQUFDLENBQUMsSUFBSSxXQUFXLElBQUkscUJBQXFCLENBQUMsQ0FBQyxDQUFDO2dCQUM1QyxXQUFXLENBQUMscUJBQXFCLENBQUMsV0FBVyxDQUFDLEVBQUUsSUFBSSxFQUFFLEdBQUcsQ0FBQyxDQUFBO1lBQzlELENBQUM7UUFDTCxDQUFDO1FBQUMsSUFBSSxDQUFDLENBQUM7WUFDSixNQUFNLElBQUksS0FBSyxDQUFDLGtFQUFrRSxDQUFDLENBQUE7UUFDdkYsQ0FBQztRQUNELE1BQU0sQ0FBQyxDQUFDLENBQUMsR0FBRyxDQUFDLFlBQVksQ0FBQyxDQUFBO0lBQzlCLENBQUMsQ0FBQTtJQUVELElBQUksZUFBZSxHQUFHLEtBQUssQ0FBQTtJQUMzQixJQUFJLE9BQU8sR0FBRyxVQUFVLElBQUksRUFBRSxHQUFHLEVBQUUsRUFBRTtRQUNqQyxNQUFNLENBQUMsQ0FBQyxnQkFBZ0IsQ0FBQyxDQUFDLENBQUM7WUFDdkIsS0FBSyxTQUFTO2dCQUNWLG1CQUFtQixDQUFDLElBQUksRUFBRSxHQUFHLENBQUMsQ0FBQyxJQUFJLENBQUM7b0JBQ2hDLEVBQUUsQ0FBQyxJQUFJLEVBQUUsSUFBSSxDQUFDLENBQUE7Z0JBQ2xCLENBQUMsQ0FBQyxDQUFBO2dCQUNGLEtBQUssQ0FBQTtZQUNULEtBQUssVUFBVTtnQkFDWCxFQUFFLENBQUMsQ0FBQyxlQUFlLENBQUMsQ0FBQyxDQUFDO29CQUNsQixtQkFBbUIsQ0FBQyxJQUFJLEVBQUUsR0FBRyxDQUFDO3lCQUN6QixJQUFJLENBQUM7d0JBQ0YsRUFBRSxDQUFDLElBQUksRUFBRSxJQUFJLENBQUMsQ0FBQTtvQkFDbEIsQ0FBQyxDQUFDLENBQUE7Z0JBQ1YsQ0FBQztnQkFBQyxJQUFJLENBQUMsQ0FBQztvQkFDSixFQUFFLENBQUMsSUFBSSxFQUFFLElBQUksQ0FBQyxDQUFBO2dCQUNsQixDQUFDO2dCQUNELGVBQWUsR0FBRyxJQUFJLENBQUE7Z0JBQ3RCLEtBQUssQ0FBQTtZQUNULEtBQUssT0FBTztnQkFDUixFQUFFLENBQUMsSUFBSSxFQUFFLElBQUksQ0FBQyxDQUFBO2dCQUNkLEtBQUssQ0FBQTtZQUNUO2dCQUNJLEtBQUssQ0FBQTtRQUNiLENBQUM7SUFDTCxDQUFDLENBQUE7SUFFRCxJQUFJLEtBQUssR0FBRyxVQUFVLEVBQUU7UUFDcEIsRUFBRSxDQUFDLENBQUMsZ0JBQWdCLEtBQUssT0FBTyxDQUFDLENBQUMsQ0FBQztZQUMvQixtQkFBbUIsQ0FBQyxJQUFJLEVBQUUsSUFBSSxDQUFDLENBQUMsSUFBSSxDQUFDO2dCQUNqQyxFQUFFLEVBQUUsQ0FBQTtZQUNSLENBQUMsQ0FBQyxDQUFBO1FBQ04sQ0FBQztRQUFDLElBQUksQ0FBQyxDQUFDO1lBQ0osRUFBRSxFQUFFLENBQUE7UUFDUixDQUFDO0lBQ0wsQ0FBQyxDQUFBO0lBQ0QsTUFBTSxDQUFDLFFBQVEsQ0FBQyxHQUFHLENBQUMsT0FBTyxFQUFFLEtBQUssQ0FBQyxDQUFBO0FBQ3ZDLENBQUMsQ0FBQTs7QUFFRCxrQkFBZSxrQkFBa0IsQ0FBQSJ9

2
test/test.d.ts vendored
View File

@ -1 +1 @@
import "typings-test"; import 'typings-test';

112
test/test.js
View File

File diff suppressed because one or more lines are too long

96
test/test.ts
View File

@ -1,59 +1,59 @@
import "typings-test" import 'typings-test'
var gulp = require("gulp"); let gulp = require('gulp');
var gulpFunction = require("../dist/index.js"); import gulpFunction from '../dist/index'
var beautylog = require("beautylog"); let beautylog = require('beautylog')
var Q = require("q"); let Q = require('q')
var myFunction = function () { let myFunction = function () {
var done = Q.defer() let done = Q.defer()
beautylog.log("Function executed"); beautylog.log('Function executed');
done.resolve(); done.resolve();
return done.promise; return done.promise;
}; };
var myFunction2 = function () { let myFunction2 = function () {
var done = Q.defer(); let done = Q.defer();
beautylog.ok("Function2 executed"); beautylog.ok('Function2 executed');
done.resolve(); done.resolve();
return done.promise; return done.promise;
}; };
var myFunction3 = function () { let myFunction3 = function () {
var done = Q.defer(); let done = Q.defer();
beautylog.success("Function3 executed"); beautylog.success('Function3 executed');
done.resolve(); done.resolve();
return done.promise; return done.promise;
}; };
var beforeFunction = function () { let beforeFunction = function () {
var done = Q.defer(); let done = Q.defer();
beautylog.success("beforeFunction executed"); beautylog.success('beforeFunction executed');
done.resolve(); done.resolve();
return done.promise; return done.promise;
}; };
var middleFunctionRun = false; let middleFunctionRun = false;
var middleFunction = function () { let middleFunction = function () {
var done = Q.defer(); let done = Q.defer();
beautylog.success("middleFunction executed"); beautylog.success('middleFunction executed');
setTimeout(function(){ setTimeout(function(){
beautylog.log("timeout fired"); beautylog.log('timeout fired');
middleFunctionRun = true; middleFunctionRun = true;
done.resolve(); done.resolve();
}, 500); }, 500);
return done.promise; return done.promise;
}; };
var afterFunction = function () { let afterFunction = function () {
var done = Q.defer(); let done = Q.defer();
beautylog.success("afterFunction executed"); beautylog.success('afterFunction executed');
done.resolve(); done.resolve();
return done.promise; return done.promise;
}; };
let timeoutFunction = function(){ let timeoutFunction = function(){
var done = Q.defer(); let done = Q.defer();
setTimeout(function(){ setTimeout(function(){
beautylog.log("largeTimeout fired"); beautylog.log('largeTimeout fired');
done.resolve(); done.resolve();
},2000); },2000);
return done.promise; return done.promise;
@ -61,56 +61,56 @@ let timeoutFunction = function(){
describe("gulpFunction",function(){ describe('gulpFunction',function(){
it("should run through smoothly with " + "'forEach'".blue,function(done){ it('should run through smoothly with ' + "'forEach'",function(done){
gulp.src('./test/*.md') gulp.src('./test/*.md')
.pipe(gulpFunction(myFunction,'forEach')) .pipe(gulpFunction(myFunction,'forEach'))
.pipe(gulp.dest("./test/result/")); .pipe(gulp.dest('./test/result/'));
gulp.src('./test/*.md') gulp.src('./test/*.md')
.pipe(gulpFunction([myFunction2,myFunction3],'forEach')) .pipe(gulpFunction([myFunction2,myFunction3],'forEach'))
.pipe(gulp.dest("./test/result/")) .pipe(gulp.dest('./test/result/'))
.pipe(gulpFunction(done,"atEnd")); .pipe(gulpFunction(done,'atEnd'));
}); });
it("should run through smoothly with " + "'atEnd'".blue,function(done){ it('should run through smoothly with ' + "'atEnd'",function(done){
gulp.src('./test/*.md') gulp.src('./test/*.md')
.pipe(gulpFunction(myFunction,'atEnd')) .pipe(gulpFunction(myFunction,'atEnd'))
.pipe(gulp.dest("./test/result/")); .pipe(gulp.dest('./test/result/'));
gulp.src('./test/*.md') gulp.src('./test/*.md')
.pipe(gulpFunction([myFunction2,myFunction3],'atEnd')) .pipe(gulpFunction([myFunction2,myFunction3],'atEnd'))
.pipe(gulp.dest("./test/result/")) .pipe(gulp.dest('./test/result/'))
.pipe(gulpFunction(done,"atEnd")); .pipe(gulpFunction(done,'atEnd'));
}); });
it("should run through smoothly once with " + "'atFirst'".blue,function(done){ it('should run through smoothly once with ' + "'atFirst'",function(done){
gulp.src('./test/*.md') gulp.src('./test/*.md')
.pipe(gulpFunction([myFunction2,myFunction3],'forFirst')) .pipe(gulpFunction([myFunction2,myFunction3],'forFirst'))
.pipe(gulp.dest("./test/result/")) .pipe(gulp.dest('./test/result/'))
.pipe(gulpFunction(done,"atEnd")); .pipe(gulpFunction(done,'atEnd'));
}); });
it("should run in order",function(done){ it('should run in order',function(done){
this.timeout(5000); this.timeout(5000);
let stream = gulp.src('./test/*.md') let stream = gulp.src('./test/*.md')
.pipe(gulpFunction([beforeFunction,middleFunction,middleFunction],'atEnd')) .pipe(gulpFunction([beforeFunction,middleFunction,middleFunction],'atEnd'))
.pipe(gulpFunction(function(){ .pipe(gulpFunction(function(){
beautylog.log("stream progressed"); beautylog.log('stream progressed');
var done2 = Q.defer(); let done2 = Q.defer();
done2.resolve(); done2.resolve();
return done2.promise; return done2.promise;
},"forEach")) },'forEach'))
.pipe(gulpFunction(function(){ .pipe(gulpFunction(function(){
beautylog.log("nextStep"); beautylog.log('nextStep');
})) }))
.pipe(gulpFunction(afterFunction,"atEnd")) .pipe(gulpFunction(afterFunction,'atEnd'))
.pipe(gulpFunction(timeoutFunction,"atEnd")); .pipe(gulpFunction(timeoutFunction,'atEnd'));
stream.on("finish",function(){ stream.on('finish',function(){
beautylog.info("stream finished"); beautylog.info('stream finished');
done(); done();
}); });
}); });

4
ts/index.ts
View File

@ -9,7 +9,7 @@ export interface IPromiseFunction {
(file?, enc?): PromiseLike<any> (file?, enc?): PromiseLike<any>
} }
module.exports = ( let mainExportFunction = (
functionsToExecuteArg: IPromiseFunction | IPromiseFunction[], functionsToExecuteArg: IPromiseFunction | IPromiseFunction[],
executionModeArg: TExecutionMode = 'forEach' executionModeArg: TExecutionMode = 'forEach'
): Transform => { ): Transform => {
@ -73,3 +73,5 @@ module.exports = (
} }
return through2.obj(forEach, atEnd) return through2.obj(forEach, atEnd)
} }
export default mainExportFunction