mirror of https://gitee.com/antv-l7/antv-l7
Merge pull request #79 from antvis/fix_packgages_modules
fix(packages): remove sub modules node_modules
This commit is contained in:
@thinkinggis
GitHub
commit
3b2b2540ff
|
|
@ -66,6 +66,7 @@ jspm_packages/
|
|||
|
||||
lib/
|
||||
dist/
|
||||
es/
|
||||
|
||||
.DS_Store
|
||||
public
|
||||
|
|
|
|||
|
|
@ -1,21 +0,0 @@
|
|||
The MIT License
|
||||
|
||||
Copyright JS Foundation and other contributors
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
of this software and associated documentation files (the "Software"), to deal
|
||||
in the Software without restriction, including without limitation the rights
|
||||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||
copies of the Software, and to permit persons to whom the Software is
|
||||
furnished to do so, subject to the following conditions:
|
||||
|
||||
The above copyright notice and this permission notice shall be included in
|
||||
all copies or substantial portions of the Software.
|
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
|
||||
THE SOFTWARE.
|
||||
|
|
@ -1,298 +0,0 @@
|
|||
# Tapable
|
||||
|
||||
The tapable package expose many Hook classes, which can be used to create hooks for plugins.
|
||||
|
||||
``` javascript
|
||||
const {
|
||||
SyncHook,
|
||||
SyncBailHook,
|
||||
SyncWaterfallHook,
|
||||
SyncLoopHook,
|
||||
AsyncParallelHook,
|
||||
AsyncParallelBailHook,
|
||||
AsyncSeriesHook,
|
||||
AsyncSeriesBailHook,
|
||||
AsyncSeriesWaterfallHook
|
||||
} = require("tapable");
|
||||
```
|
||||
|
||||
## Installation
|
||||
|
||||
``` shell
|
||||
npm install --save tapable
|
||||
```
|
||||
|
||||
## Usage
|
||||
|
||||
All Hook constructors take one optional argument, which is a list of argument names as strings.
|
||||
|
||||
``` js
|
||||
const hook = new SyncHook(["arg1", "arg2", "arg3"]);
|
||||
```
|
||||
|
||||
The best practice is to expose all hooks of a class in a `hooks` property:
|
||||
|
||||
``` js
|
||||
class Car {
|
||||
constructor() {
|
||||
this.hooks = {
|
||||
accelerate: new SyncHook(["newSpeed"]),
|
||||
brake: new SyncHook(),
|
||||
calculateRoutes: new AsyncParallelHook(["source", "target", "routesList"])
|
||||
};
|
||||
}
|
||||
|
||||
/* ... */
|
||||
}
|
||||
```
|
||||
|
||||
Other people can now use these hooks:
|
||||
|
||||
``` js
|
||||
const myCar = new Car();
|
||||
|
||||
// Use the tap method to add a consument
|
||||
myCar.hooks.brake.tap("WarningLampPlugin", () => warningLamp.on());
|
||||
```
|
||||
|
||||
It's required to pass a name to identify the plugin/reason.
|
||||
|
||||
You may receive arguments:
|
||||
|
||||
``` js
|
||||
myCar.hooks.accelerate.tap("LoggerPlugin", newSpeed => console.log(`Accelerating to ${newSpeed}`));
|
||||
```
|
||||
|
||||
For sync hooks, `tap` is the only valid method to add a plugin. Async hooks also support async plugins:
|
||||
|
||||
``` js
|
||||
myCar.hooks.calculateRoutes.tapPromise("GoogleMapsPlugin", (source, target, routesList) => {
|
||||
// return a promise
|
||||
return google.maps.findRoute(source, target).then(route => {
|
||||
routesList.add(route);
|
||||
});
|
||||
});
|
||||
myCar.hooks.calculateRoutes.tapAsync("BingMapsPlugin", (source, target, routesList, callback) => {
|
||||
bing.findRoute(source, target, (err, route) => {
|
||||
if(err) return callback(err);
|
||||
routesList.add(route);
|
||||
// call the callback
|
||||
callback();
|
||||
});
|
||||
});
|
||||
|
||||
// You can still use sync plugins
|
||||
myCar.hooks.calculateRoutes.tap("CachedRoutesPlugin", (source, target, routesList) => {
|
||||
const cachedRoute = cache.get(source, target);
|
||||
if(cachedRoute)
|
||||
routesList.add(cachedRoute);
|
||||
})
|
||||
```
|
||||
The class declaring these hooks need to call them:
|
||||
|
||||
``` js
|
||||
class Car {
|
||||
/**
|
||||
* You won't get returned value from SyncHook or AsyncParallelHook,
|
||||
* to do that, use SyncWaterfallHook and AsyncSeriesWaterfallHook respectively
|
||||
**/
|
||||
|
||||
setSpeed(newSpeed) {
|
||||
// following call returns undefined even when you returned values
|
||||
this.hooks.accelerate.call(newSpeed);
|
||||
}
|
||||
|
||||
useNavigationSystemPromise(source, target) {
|
||||
const routesList = new List();
|
||||
return this.hooks.calculateRoutes.promise(source, target, routesList).then((res) => {
|
||||
// res is undefined for AsyncParallelHook
|
||||
return routesList.getRoutes();
|
||||
});
|
||||
}
|
||||
|
||||
useNavigationSystemAsync(source, target, callback) {
|
||||
const routesList = new List();
|
||||
this.hooks.calculateRoutes.callAsync(source, target, routesList, err => {
|
||||
if(err) return callback(err);
|
||||
callback(null, routesList.getRoutes());
|
||||
});
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
The Hook will compile a method with the most efficient way of running your plugins. It generates code depending on:
|
||||
* The number of registered plugins (none, one, many)
|
||||
* The kind of registered plugins (sync, async, promise)
|
||||
* The used call method (sync, async, promise)
|
||||
* The number of arguments
|
||||
* Whether interception is used
|
||||
|
||||
This ensures fastest possible execution.
|
||||
|
||||
## Hook types
|
||||
|
||||
Each hook can be tapped with one or several functions. How they are executed depends on the hook type:
|
||||
|
||||
* Basic hook (without “Waterfall”, “Bail” or “Loop” in its name). This hook simply calls every function it tapped in a row.
|
||||
|
||||
* __Waterfall__. A waterfall hook also calls each tapped function in a row. Unlike the basic hook, it passes a return value from each function to the next function.
|
||||
|
||||
* __Bail__. A bail hook allows exiting early. When any of the tapped function returns anything, the bail hook will stop executing the remaining ones.
|
||||
|
||||
* __Loop__. TODO
|
||||
|
||||
Additionally, hooks can be synchronous or asynchronous. To reflect this, there’re “Sync”, “AsyncSeries”, and “AsyncParallel” hook classes:
|
||||
|
||||
* __Sync__. A sync hook can only be tapped with synchronous functions (using `myHook.tap()`).
|
||||
|
||||
* __AsyncSeries__. An async-series hook can be tapped with synchronous, callback-based and promise-based functions (using `myHook.tap()`, `myHook.tapAsync()` and `myHook.tapPromise()`). They call each async method in a row.
|
||||
|
||||
* __AsyncParallel__. An async-parallel hook can also be tapped with synchronous, callback-based and promise-based functions (using `myHook.tap()`, `myHook.tapAsync()` and `myHook.tapPromise()`). However, they run each async method in parallel.
|
||||
|
||||
The hook type is reflected in its class name. E.g., `AsyncSeriesWaterfallHook` allows asynchronous functions and runs them in series, passing each function’s return value into the next function.
|
||||
|
||||
|
||||
## Interception
|
||||
|
||||
All Hooks offer an additional interception API:
|
||||
|
||||
``` js
|
||||
myCar.hooks.calculateRoutes.intercept({
|
||||
call: (source, target, routesList) => {
|
||||
console.log("Starting to calculate routes");
|
||||
},
|
||||
register: (tapInfo) => {
|
||||
// tapInfo = { type: "promise", name: "GoogleMapsPlugin", fn: ... }
|
||||
console.log(`${tapInfo.name} is doing its job`);
|
||||
return tapInfo; // may return a new tapInfo object
|
||||
}
|
||||
})
|
||||
```
|
||||
|
||||
**call**: `(...args) => void` Adding `call` to your interceptor will trigger when hooks are triggered. You have access to the hooks arguments.
|
||||
|
||||
**tap**: `(tap: Tap) => void` Adding `tap` to your interceptor will trigger when a plugin taps into a hook. Provided is the `Tap` object. `Tap` object can't be changed.
|
||||
|
||||
**loop**: `(...args) => void` Adding `loop` to your interceptor will trigger for each loop of a looping hook.
|
||||
|
||||
**register**: `(tap: Tap) => Tap | undefined` Adding `register` to your interceptor will trigger for each added `Tap` and allows to modify it.
|
||||
|
||||
## Context
|
||||
|
||||
Plugins and interceptors can opt-in to access an optional `context` object, which can be used to pass arbitrary values to subsequent plugins and interceptors.
|
||||
|
||||
``` js
|
||||
myCar.hooks.accelerate.intercept({
|
||||
context: true,
|
||||
tap: (context, tapInfo) => {
|
||||
// tapInfo = { type: "sync", name: "NoisePlugin", fn: ... }
|
||||
console.log(`${tapInfo.name} is doing it's job`);
|
||||
|
||||
// `context` starts as an empty object if at least one plugin uses `context: true`.
|
||||
// If no plugins use `context: true`, then `context` is undefined.
|
||||
if (context) {
|
||||
// Arbitrary properties can be added to `context`, which plugins can then access.
|
||||
context.hasMuffler = true;
|
||||
}
|
||||
}
|
||||
});
|
||||
|
||||
myCar.hooks.accelerate.tap({
|
||||
name: "NoisePlugin",
|
||||
context: true
|
||||
}, (context, newSpeed) => {
|
||||
if (context && context.hasMuffler) {
|
||||
console.log("Silence...");
|
||||
} else {
|
||||
console.log("Vroom!");
|
||||
}
|
||||
});
|
||||
```
|
||||
|
||||
## HookMap
|
||||
|
||||
A HookMap is a helper class for a Map with Hooks
|
||||
|
||||
``` js
|
||||
const keyedHook = new HookMap(key => new SyncHook(["arg"]))
|
||||
```
|
||||
|
||||
``` js
|
||||
keyedHook.tap("some-key", "MyPlugin", (arg) => { /* ... */ });
|
||||
keyedHook.tapAsync("some-key", "MyPlugin", (arg, callback) => { /* ... */ });
|
||||
keyedHook.tapPromise("some-key", "MyPlugin", (arg) => { /* ... */ });
|
||||
```
|
||||
|
||||
``` js
|
||||
const hook = keyedHook.get("some-key");
|
||||
if(hook !== undefined) {
|
||||
hook.callAsync("arg", err => { /* ... */ });
|
||||
}
|
||||
```
|
||||
|
||||
## Hook/HookMap interface
|
||||
|
||||
Public:
|
||||
|
||||
``` ts
|
||||
interface Hook {
|
||||
tap: (name: string | Tap, fn: (context?, ...args) => Result) => void,
|
||||
tapAsync: (name: string | Tap, fn: (context?, ...args, callback: (err, result: Result) => void) => void) => void,
|
||||
tapPromise: (name: string | Tap, fn: (context?, ...args) => Promise<Result>) => void,
|
||||
intercept: (interceptor: HookInterceptor) => void
|
||||
}
|
||||
|
||||
interface HookInterceptor {
|
||||
call: (context?, ...args) => void,
|
||||
loop: (context?, ...args) => void,
|
||||
tap: (context?, tap: Tap) => void,
|
||||
register: (tap: Tap) => Tap,
|
||||
context: boolean
|
||||
}
|
||||
|
||||
interface HookMap {
|
||||
for: (key: any) => Hook,
|
||||
tap: (key: any, name: string | Tap, fn: (context?, ...args) => Result) => void,
|
||||
tapAsync: (key: any, name: string | Tap, fn: (context?, ...args, callback: (err, result: Result) => void) => void) => void,
|
||||
tapPromise: (key: any, name: string | Tap, fn: (context?, ...args) => Promise<Result>) => void,
|
||||
intercept: (interceptor: HookMapInterceptor) => void
|
||||
}
|
||||
|
||||
interface HookMapInterceptor {
|
||||
factory: (key: any, hook: Hook) => Hook
|
||||
}
|
||||
|
||||
interface Tap {
|
||||
name: string,
|
||||
type: string
|
||||
fn: Function,
|
||||
stage: number,
|
||||
context: boolean
|
||||
}
|
||||
```
|
||||
|
||||
Protected (only for the class containing the hook):
|
||||
|
||||
``` ts
|
||||
interface Hook {
|
||||
isUsed: () => boolean,
|
||||
call: (...args) => Result,
|
||||
promise: (...args) => Promise<Result>,
|
||||
callAsync: (...args, callback: (err, result: Result) => void) => void,
|
||||
}
|
||||
|
||||
interface HookMap {
|
||||
get: (key: any) => Hook | undefined,
|
||||
for: (key: any) => Hook
|
||||
}
|
||||
```
|
||||
|
||||
## MultiHook
|
||||
|
||||
A helper Hook-like class to redirect taps to multiple other hooks:
|
||||
|
||||
``` js
|
||||
const { MultiHook } = require("tapable");
|
||||
|
||||
this.hooks.allHooks = new MultiHook([this.hooks.hookA, this.hooks.hookB]);
|
||||
```
|
||||
|
|
@ -1,85 +0,0 @@
|
|||
/*
|
||||
MIT License http://www.opensource.org/licenses/mit-license.php
|
||||
Author Tobias Koppers @sokra
|
||||
*/
|
||||
"use strict";
|
||||
|
||||
const Hook = require("./Hook");
|
||||
const HookCodeFactory = require("./HookCodeFactory");
|
||||
|
||||
class AsyncParallelBailHookCodeFactory extends HookCodeFactory {
|
||||
content({ onError, onResult, onDone }) {
|
||||
let code = "";
|
||||
code += `var _results = new Array(${this.options.taps.length});\n`;
|
||||
code += "var _checkDone = () => {\n";
|
||||
code += "for(var i = 0; i < _results.length; i++) {\n";
|
||||
code += "var item = _results[i];\n";
|
||||
code += "if(item === undefined) return false;\n";
|
||||
code += "if(item.result !== undefined) {\n";
|
||||
code += onResult("item.result");
|
||||
code += "return true;\n";
|
||||
code += "}\n";
|
||||
code += "if(item.error) {\n";
|
||||
code += onError("item.error");
|
||||
code += "return true;\n";
|
||||
code += "}\n";
|
||||
code += "}\n";
|
||||
code += "return false;\n";
|
||||
code += "}\n";
|
||||
code += this.callTapsParallel({
|
||||
onError: (i, err, done, doneBreak) => {
|
||||
let code = "";
|
||||
code += `if(${i} < _results.length && ((_results.length = ${i +
|
||||
1}), (_results[${i}] = { error: ${err} }), _checkDone())) {\n`;
|
||||
code += doneBreak(true);
|
||||
code += "} else {\n";
|
||||
code += done();
|
||||
code += "}\n";
|
||||
return code;
|
||||
},
|
||||
onResult: (i, result, done, doneBreak) => {
|
||||
let code = "";
|
||||
code += `if(${i} < _results.length && (${result} !== undefined && (_results.length = ${i +
|
||||
1}), (_results[${i}] = { result: ${result} }), _checkDone())) {\n`;
|
||||
code += doneBreak(true);
|
||||
code += "} else {\n";
|
||||
code += done();
|
||||
code += "}\n";
|
||||
return code;
|
||||
},
|
||||
onTap: (i, run, done, doneBreak) => {
|
||||
let code = "";
|
||||
if (i > 0) {
|
||||
code += `if(${i} >= _results.length) {\n`;
|
||||
code += done();
|
||||
code += "} else {\n";
|
||||
}
|
||||
code += run();
|
||||
if (i > 0) code += "}\n";
|
||||
return code;
|
||||
},
|
||||
onDone
|
||||
});
|
||||
return code;
|
||||
}
|
||||
}
|
||||
|
||||
const factory = new AsyncParallelBailHookCodeFactory();
|
||||
|
||||
const COMPILE = function(options) {
|
||||
factory.setup(this, options);
|
||||
return factory.create(options);
|
||||
};
|
||||
|
||||
function AsyncParallelBailHook(args = [], name = undefined) {
|
||||
const hook = new Hook(args, name);
|
||||
hook.constructor = AsyncParallelBailHook;
|
||||
hook.compile = COMPILE;
|
||||
hook._call = undefined;
|
||||
hook.call = undefined;
|
||||
return hook;
|
||||
}
|
||||
|
||||
AsyncParallelBailHook.prototype = null;
|
||||
|
||||
module.exports = AsyncParallelBailHook;
|
||||
|
|
@ -1,37 +0,0 @@
|
|||
/*
|
||||
MIT License http://www.opensource.org/licenses/mit-license.php
|
||||
Author Tobias Koppers @sokra
|
||||
*/
|
||||
"use strict";
|
||||
|
||||
const Hook = require("./Hook");
|
||||
const HookCodeFactory = require("./HookCodeFactory");
|
||||
|
||||
class AsyncParallelHookCodeFactory extends HookCodeFactory {
|
||||
content({ onError, onDone }) {
|
||||
return this.callTapsParallel({
|
||||
onError: (i, err, done, doneBreak) => onError(err) + doneBreak(true),
|
||||
onDone
|
||||
});
|
||||
}
|
||||
}
|
||||
|
||||
const factory = new AsyncParallelHookCodeFactory();
|
||||
|
||||
const COMPILE = function(options) {
|
||||
factory.setup(this, options);
|
||||
return factory.create(options);
|
||||
};
|
||||
|
||||
function AsyncParallelHook(args = [], name = undefined) {
|
||||
const hook = new Hook(args, name);
|
||||
hook.constructor = AsyncParallelHook;
|
||||
hook.compile = COMPILE;
|
||||
hook._call = undefined;
|
||||
hook.call = undefined;
|
||||
return hook;
|
||||
}
|
||||
|
||||
AsyncParallelHook.prototype = null;
|
||||
|
||||
module.exports = AsyncParallelHook;
|
||||
|
|
@ -1,42 +0,0 @@
|
|||
/*
|
||||
MIT License http://www.opensource.org/licenses/mit-license.php
|
||||
Author Tobias Koppers @sokra
|
||||
*/
|
||||
"use strict";
|
||||
|
||||
const Hook = require("./Hook");
|
||||
const HookCodeFactory = require("./HookCodeFactory");
|
||||
|
||||
class AsyncSeriesBailHookCodeFactory extends HookCodeFactory {
|
||||
content({ onError, onResult, resultReturns, onDone }) {
|
||||
return this.callTapsSeries({
|
||||
onError: (i, err, next, doneBreak) => onError(err) + doneBreak(true),
|
||||
onResult: (i, result, next) =>
|
||||
`if(${result} !== undefined) {\n${onResult(
|
||||
result
|
||||
)};\n} else {\n${next()}}\n`,
|
||||
resultReturns,
|
||||
onDone
|
||||
});
|
||||
}
|
||||
}
|
||||
|
||||
const factory = new AsyncSeriesBailHookCodeFactory();
|
||||
|
||||
const COMPILE = function(options) {
|
||||
factory.setup(this, options);
|
||||
return factory.create(options);
|
||||
};
|
||||
|
||||
function AsyncSeriesBailHook(args = [], name = undefined) {
|
||||
const hook = new Hook(args, name);
|
||||
hook.constructor = AsyncSeriesBailHook;
|
||||
hook.compile = COMPILE;
|
||||
hook._call = undefined;
|
||||
hook.call = undefined;
|
||||
return hook;
|
||||
}
|
||||
|
||||
AsyncSeriesBailHook.prototype = null;
|
||||
|
||||
module.exports = AsyncSeriesBailHook;
|
||||
|
|
@ -1,37 +0,0 @@
|
|||
/*
|
||||
MIT License http://www.opensource.org/licenses/mit-license.php
|
||||
Author Tobias Koppers @sokra
|
||||
*/
|
||||
"use strict";
|
||||
|
||||
const Hook = require("./Hook");
|
||||
const HookCodeFactory = require("./HookCodeFactory");
|
||||
|
||||
class AsyncSeriesHookCodeFactory extends HookCodeFactory {
|
||||
content({ onError, onDone }) {
|
||||
return this.callTapsSeries({
|
||||
onError: (i, err, next, doneBreak) => onError(err) + doneBreak(true),
|
||||
onDone
|
||||
});
|
||||
}
|
||||
}
|
||||
|
||||
const factory = new AsyncSeriesHookCodeFactory();
|
||||
|
||||
const COMPILE = function(options) {
|
||||
factory.setup(this, options);
|
||||
return factory.create(options);
|
||||
};
|
||||
|
||||
function AsyncSeriesHook(args = [], name = undefined) {
|
||||
const hook = new Hook(args, name);
|
||||
hook.constructor = AsyncSeriesHook;
|
||||
hook.compile = COMPILE;
|
||||
hook._call = undefined;
|
||||
hook.call = undefined;
|
||||
return hook;
|
||||
}
|
||||
|
||||
AsyncSeriesHook.prototype = null;
|
||||
|
||||
module.exports = AsyncSeriesHook;
|
||||
|
|
@ -1,37 +0,0 @@
|
|||
/*
|
||||
MIT License http://www.opensource.org/licenses/mit-license.php
|
||||
Author Tobias Koppers @sokra
|
||||
*/
|
||||
"use strict";
|
||||
|
||||
const Hook = require("./Hook");
|
||||
const HookCodeFactory = require("./HookCodeFactory");
|
||||
|
||||
class AsyncSeriesLoopHookCodeFactory extends HookCodeFactory {
|
||||
content({ onError, onDone }) {
|
||||
return this.callTapsLooping({
|
||||
onError: (i, err, next, doneBreak) => onError(err) + doneBreak(true),
|
||||
onDone
|
||||
});
|
||||
}
|
||||
}
|
||||
|
||||
const factory = new AsyncSeriesLoopHookCodeFactory();
|
||||
|
||||
const COMPILE = function(options) {
|
||||
factory.setup(this, options);
|
||||
return factory.create(options);
|
||||
};
|
||||
|
||||
function AsyncSeriesLoopHook(args = [], name = undefined) {
|
||||
const hook = new Hook(args, name);
|
||||
hook.constructor = AsyncSeriesLoopHook;
|
||||
hook.compile = COMPILE;
|
||||
hook._call = undefined;
|
||||
hook.call = undefined;
|
||||
return hook;
|
||||
}
|
||||
|
||||
AsyncSeriesLoopHook.prototype = null;
|
||||
|
||||
module.exports = AsyncSeriesLoopHook;
|
||||
|
|
@ -1,47 +0,0 @@
|
|||
/*
|
||||
MIT License http://www.opensource.org/licenses/mit-license.php
|
||||
Author Tobias Koppers @sokra
|
||||
*/
|
||||
"use strict";
|
||||
|
||||
const Hook = require("./Hook");
|
||||
const HookCodeFactory = require("./HookCodeFactory");
|
||||
|
||||
class AsyncSeriesWaterfallHookCodeFactory extends HookCodeFactory {
|
||||
content({ onError, onResult, onDone }) {
|
||||
return this.callTapsSeries({
|
||||
onError: (i, err, next, doneBreak) => onError(err) + doneBreak(true),
|
||||
onResult: (i, result, next) => {
|
||||
let code = "";
|
||||
code += `if(${result} !== undefined) {\n`;
|
||||
code += `${this._args[0]} = ${result};\n`;
|
||||
code += `}\n`;
|
||||
code += next();
|
||||
return code;
|
||||
},
|
||||
onDone: () => onResult(this._args[0])
|
||||
});
|
||||
}
|
||||
}
|
||||
|
||||
const factory = new AsyncSeriesWaterfallHookCodeFactory();
|
||||
|
||||
const COMPILE = function(options) {
|
||||
factory.setup(this, options);
|
||||
return factory.create(options);
|
||||
};
|
||||
|
||||
function AsyncSeriesWaterfallHook(args = [], name = undefined) {
|
||||
if (args.length < 1)
|
||||
throw new Error("Waterfall hooks must have at least one argument");
|
||||
const hook = new Hook(args, name);
|
||||
hook.constructor = AsyncSeriesWaterfallHook;
|
||||
hook.compile = COMPILE;
|
||||
hook._call = undefined;
|
||||
hook.call = undefined;
|
||||
return hook;
|
||||
}
|
||||
|
||||
AsyncSeriesWaterfallHook.prototype = null;
|
||||
|
||||
module.exports = AsyncSeriesWaterfallHook;
|
||||
|
|
@ -1,175 +0,0 @@
|
|||
/*
|
||||
MIT License http://www.opensource.org/licenses/mit-license.php
|
||||
Author Tobias Koppers @sokra
|
||||
*/
|
||||
"use strict";
|
||||
|
||||
const util = require("util");
|
||||
|
||||
const deprecateContext = util.deprecate(() => {},
|
||||
"Hook.context is deprecated and will be removed");
|
||||
|
||||
const CALL_DELEGATE = function(...args) {
|
||||
this.call = this._createCall("sync");
|
||||
return this.call(...args);
|
||||
};
|
||||
const CALL_ASYNC_DELEGATE = function(...args) {
|
||||
this.callAsync = this._createCall("async");
|
||||
return this.callAsync(...args);
|
||||
};
|
||||
const PROMISE_DELEGATE = function(...args) {
|
||||
this.promise = this._createCall("promise");
|
||||
return this.promise(...args);
|
||||
};
|
||||
|
||||
class Hook {
|
||||
constructor(args = [], name = undefined) {
|
||||
this._args = args;
|
||||
this.name = name;
|
||||
this.taps = [];
|
||||
this.interceptors = [];
|
||||
this._call = CALL_DELEGATE;
|
||||
this.call = CALL_DELEGATE;
|
||||
this._callAsync = CALL_ASYNC_DELEGATE;
|
||||
this.callAsync = CALL_ASYNC_DELEGATE;
|
||||
this._promise = PROMISE_DELEGATE;
|
||||
this.promise = PROMISE_DELEGATE;
|
||||
this._x = undefined;
|
||||
|
||||
this.compile = this.compile;
|
||||
this.tap = this.tap;
|
||||
this.tapAsync = this.tapAsync;
|
||||
this.tapPromise = this.tapPromise;
|
||||
}
|
||||
|
||||
compile(options) {
|
||||
throw new Error("Abstract: should be overridden");
|
||||
}
|
||||
|
||||
_createCall(type) {
|
||||
return this.compile({
|
||||
taps: this.taps,
|
||||
interceptors: this.interceptors,
|
||||
args: this._args,
|
||||
type: type
|
||||
});
|
||||
}
|
||||
|
||||
_tap(type, options, fn) {
|
||||
if (typeof options === "string") {
|
||||
options = {
|
||||
name: options
|
||||
};
|
||||
} else if (typeof options !== "object" || options === null) {
|
||||
throw new Error("Invalid tap options");
|
||||
}
|
||||
if (typeof options.name !== "string" || options.name === "") {
|
||||
throw new Error("Missing name for tap");
|
||||
}
|
||||
if (typeof options.context !== "undefined") {
|
||||
deprecateContext();
|
||||
}
|
||||
options = Object.assign({ type, fn }, options);
|
||||
options = this._runRegisterInterceptors(options);
|
||||
this._insert(options);
|
||||
}
|
||||
|
||||
tap(options, fn) {
|
||||
this._tap("sync", options, fn);
|
||||
}
|
||||
|
||||
tapAsync(options, fn) {
|
||||
this._tap("async", options, fn);
|
||||
}
|
||||
|
||||
tapPromise(options, fn) {
|
||||
this._tap("promise", options, fn);
|
||||
}
|
||||
|
||||
_runRegisterInterceptors(options) {
|
||||
for (const interceptor of this.interceptors) {
|
||||
if (interceptor.register) {
|
||||
const newOptions = interceptor.register(options);
|
||||
if (newOptions !== undefined) {
|
||||
options = newOptions;
|
||||
}
|
||||
}
|
||||
}
|
||||
return options;
|
||||
}
|
||||
|
||||
withOptions(options) {
|
||||
const mergeOptions = opt =>
|
||||
Object.assign({}, options, typeof opt === "string" ? { name: opt } : opt);
|
||||
|
||||
return {
|
||||
name: this.name,
|
||||
tap: (opt, fn) => this.tap(mergeOptions(opt), fn),
|
||||
tapAsync: (opt, fn) => this.tapAsync(mergeOptions(opt), fn),
|
||||
tapPromise: (opt, fn) => this.tapPromise(mergeOptions(opt), fn),
|
||||
intercept: interceptor => this.intercept(interceptor),
|
||||
isUsed: () => this.isUsed(),
|
||||
withOptions: opt => this.withOptions(mergeOptions(opt))
|
||||
};
|
||||
}
|
||||
|
||||
isUsed() {
|
||||
return this.taps.length > 0 || this.interceptors.length > 0;
|
||||
}
|
||||
|
||||
intercept(interceptor) {
|
||||
this._resetCompilation();
|
||||
this.interceptors.push(Object.assign({}, interceptor));
|
||||
if (interceptor.register) {
|
||||
for (let i = 0; i < this.taps.length; i++) {
|
||||
this.taps[i] = interceptor.register(this.taps[i]);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
_resetCompilation() {
|
||||
this.call = this._call;
|
||||
this.callAsync = this._callAsync;
|
||||
this.promise = this._promise;
|
||||
}
|
||||
|
||||
_insert(item) {
|
||||
this._resetCompilation();
|
||||
let before;
|
||||
if (typeof item.before === "string") {
|
||||
before = new Set([item.before]);
|
||||
} else if (Array.isArray(item.before)) {
|
||||
before = new Set(item.before);
|
||||
}
|
||||
let stage = 0;
|
||||
if (typeof item.stage === "number") {
|
||||
stage = item.stage;
|
||||
}
|
||||
let i = this.taps.length;
|
||||
while (i > 0) {
|
||||
i--;
|
||||
const x = this.taps[i];
|
||||
this.taps[i + 1] = x;
|
||||
const xStage = x.stage || 0;
|
||||
if (before) {
|
||||
if (before.has(x.name)) {
|
||||
before.delete(x.name);
|
||||
continue;
|
||||
}
|
||||
if (before.size > 0) {
|
||||
continue;
|
||||
}
|
||||
}
|
||||
if (xStage > stage) {
|
||||
continue;
|
||||
}
|
||||
i++;
|
||||
break;
|
||||
}
|
||||
this.taps[i] = item;
|
||||
}
|
||||
}
|
||||
|
||||
Object.setPrototypeOf(Hook.prototype, null);
|
||||
|
||||
module.exports = Hook;
|
||||
|
|
@ -1,407 +0,0 @@
|
|||
/*
|
||||
MIT License http://www.opensource.org/licenses/mit-license.php
|
||||
Author Tobias Koppers @sokra
|
||||
*/
|
||||
"use strict";
|
||||
|
||||
class HookCodeFactory {
|
||||
constructor(config) {
|
||||
this.config = config;
|
||||
this.options = undefined;
|
||||
this._args = undefined;
|
||||
}
|
||||
|
||||
create(options) {
|
||||
this.init(options);
|
||||
let fn;
|
||||
switch (this.options.type) {
|
||||
case "sync":
|
||||
fn = new Function(
|
||||
this.args(),
|
||||
'"use strict";\n' +
|
||||
this.header() +
|
||||
this.content({
|
||||
onError: err => `throw ${err};\n`,
|
||||
onResult: result => `return ${result};\n`,
|
||||
resultReturns: true,
|
||||
onDone: () => "",
|
||||
rethrowIfPossible: true
|
||||
})
|
||||
);
|
||||
break;
|
||||
case "async":
|
||||
fn = new Function(
|
||||
this.args({
|
||||
after: "_callback"
|
||||
}),
|
||||
'"use strict";\n' +
|
||||
this.header() +
|
||||
this.content({
|
||||
onError: err => `_callback(${err});\n`,
|
||||
onResult: result => `_callback(null, ${result});\n`,
|
||||
onDone: () => "_callback();\n"
|
||||
})
|
||||
);
|
||||
break;
|
||||
case "promise":
|
||||
let errorHelperUsed = false;
|
||||
const content = this.content({
|
||||
onError: err => {
|
||||
errorHelperUsed = true;
|
||||
return `_error(${err});\n`;
|
||||
},
|
||||
onResult: result => `_resolve(${result});\n`,
|
||||
onDone: () => "_resolve();\n"
|
||||
});
|
||||
let code = "";
|
||||
code += '"use strict";\n';
|
||||
code += "return new Promise((_resolve, _reject) => {\n";
|
||||
if (errorHelperUsed) {
|
||||
code += "var _sync = true;\n";
|
||||
code += "function _error(_err) {\n";
|
||||
code += "if(_sync)\n";
|
||||
code += "_resolve(Promise.resolve().then(() => { throw _err; }));\n";
|
||||
code += "else\n";
|
||||
code += "_reject(_err);\n";
|
||||
code += "};\n";
|
||||
}
|
||||
code += this.header();
|
||||
code += content;
|
||||
if (errorHelperUsed) {
|
||||
code += "_sync = false;\n";
|
||||
}
|
||||
code += "});\n";
|
||||
fn = new Function(this.args(), code);
|
||||
break;
|
||||
}
|
||||
this.deinit();
|
||||
return fn;
|
||||
}
|
||||
|
||||
setup(instance, options) {
|
||||
instance._x = options.taps.map(t => t.fn);
|
||||
}
|
||||
|
||||
/**
|
||||
* @param {{ type: "sync" | "promise" | "async", taps: Array<Tap>, interceptors: Array<Interceptor> }} options
|
||||
*/
|
||||
init(options) {
|
||||
this.options = options;
|
||||
this._args = options.args.slice();
|
||||
}
|
||||
|
||||
deinit() {
|
||||
this.options = undefined;
|
||||
this._args = undefined;
|
||||
}
|
||||
|
||||
header() {
|
||||
let code = "";
|
||||
if (this.needContext()) {
|
||||
code += "var _context = {};\n";
|
||||
} else {
|
||||
code += "var _context;\n";
|
||||
}
|
||||
code += "var _x = this._x;\n";
|
||||
if (this.options.interceptors.length > 0) {
|
||||
code += "var _taps = this.taps;\n";
|
||||
code += "var _interceptors = this.interceptors;\n";
|
||||
}
|
||||
for (let i = 0; i < this.options.interceptors.length; i++) {
|
||||
const interceptor = this.options.interceptors[i];
|
||||
if (interceptor.call) {
|
||||
code += `${this.getInterceptor(i)}.call(${this.args({
|
||||
before: interceptor.context ? "_context" : undefined
|
||||
})});\n`;
|
||||
}
|
||||
}
|
||||
return code;
|
||||
}
|
||||
|
||||
needContext() {
|
||||
for (const tap of this.options.taps) if (tap.context) return true;
|
||||
return false;
|
||||
}
|
||||
|
||||
callTap(tapIndex, { onError, onResult, onDone, rethrowIfPossible }) {
|
||||
let code = "";
|
||||
let hasTapCached = false;
|
||||
for (let i = 0; i < this.options.interceptors.length; i++) {
|
||||
const interceptor = this.options.interceptors[i];
|
||||
if (interceptor.tap) {
|
||||
if (!hasTapCached) {
|
||||
code += `var _tap${tapIndex} = ${this.getTap(tapIndex)};\n`;
|
||||
hasTapCached = true;
|
||||
}
|
||||
code += `${this.getInterceptor(i)}.tap(${
|
||||
interceptor.context ? "_context, " : ""
|
||||
}_tap${tapIndex});\n`;
|
||||
}
|
||||
}
|
||||
code += `var _fn${tapIndex} = ${this.getTapFn(tapIndex)};\n`;
|
||||
const tap = this.options.taps[tapIndex];
|
||||
switch (tap.type) {
|
||||
case "sync":
|
||||
if (!rethrowIfPossible) {
|
||||
code += `var _hasError${tapIndex} = false;\n`;
|
||||
code += "try {\n";
|
||||
}
|
||||
if (onResult) {
|
||||
code += `var _result${tapIndex} = _fn${tapIndex}(${this.args({
|
||||
before: tap.context ? "_context" : undefined
|
||||
})});\n`;
|
||||
} else {
|
||||
code += `_fn${tapIndex}(${this.args({
|
||||
before: tap.context ? "_context" : undefined
|
||||
})});\n`;
|
||||
}
|
||||
if (!rethrowIfPossible) {
|
||||
code += "} catch(_err) {\n";
|
||||
code += `_hasError${tapIndex} = true;\n`;
|
||||
code += onError("_err");
|
||||
code += "}\n";
|
||||
code += `if(!_hasError${tapIndex}) {\n`;
|
||||
}
|
||||
if (onResult) {
|
||||
code += onResult(`_result${tapIndex}`);
|
||||
}
|
||||
if (onDone) {
|
||||
code += onDone();
|
||||
}
|
||||
if (!rethrowIfPossible) {
|
||||
code += "}\n";
|
||||
}
|
||||
break;
|
||||
case "async":
|
||||
let cbCode = "";
|
||||
if (onResult) cbCode += `(_err${tapIndex}, _result${tapIndex}) => {\n`;
|
||||
else cbCode += `_err${tapIndex} => {\n`;
|
||||
cbCode += `if(_err${tapIndex}) {\n`;
|
||||
cbCode += onError(`_err${tapIndex}`);
|
||||
cbCode += "} else {\n";
|
||||
if (onResult) {
|
||||
cbCode += onResult(`_result${tapIndex}`);
|
||||
}
|
||||
if (onDone) {
|
||||
cbCode += onDone();
|
||||
}
|
||||
cbCode += "}\n";
|
||||
cbCode += "}";
|
||||
code += `_fn${tapIndex}(${this.args({
|
||||
before: tap.context ? "_context" : undefined,
|
||||
after: cbCode
|
||||
})});\n`;
|
||||
break;
|
||||
case "promise":
|
||||
code += `var _hasResult${tapIndex} = false;\n`;
|
||||
code += `var _promise${tapIndex} = _fn${tapIndex}(${this.args({
|
||||
before: tap.context ? "_context" : undefined
|
||||
})});\n`;
|
||||
code += `if (!_promise${tapIndex} || !_promise${tapIndex}.then)\n`;
|
||||
code += ` throw new Error('Tap function (tapPromise) did not return promise (returned ' + _promise${tapIndex} + ')');\n`;
|
||||
code += `_promise${tapIndex}.then(_result${tapIndex} => {\n`;
|
||||
code += `_hasResult${tapIndex} = true;\n`;
|
||||
if (onResult) {
|
||||
code += onResult(`_result${tapIndex}`);
|
||||
}
|
||||
if (onDone) {
|
||||
code += onDone();
|
||||
}
|
||||
code += `}, _err${tapIndex} => {\n`;
|
||||
code += `if(_hasResult${tapIndex}) throw _err${tapIndex};\n`;
|
||||
code += onError(`_err${tapIndex}`);
|
||||
code += "});\n";
|
||||
break;
|
||||
}
|
||||
return code;
|
||||
}
|
||||
|
||||
callTapsSeries({
|
||||
onError,
|
||||
onResult,
|
||||
resultReturns,
|
||||
onDone,
|
||||
doneReturns,
|
||||
rethrowIfPossible
|
||||
}) {
|
||||
if (this.options.taps.length === 0) return onDone();
|
||||
const firstAsync = this.options.taps.findIndex(t => t.type !== "sync");
|
||||
const somethingReturns = resultReturns || doneReturns || false;
|
||||
let code = "";
|
||||
let current = onDone;
|
||||
for (let j = this.options.taps.length - 1; j >= 0; j--) {
|
||||
const i = j;
|
||||
const unroll = current !== onDone && this.options.taps[i].type !== "sync";
|
||||
if (unroll) {
|
||||
code += `function _next${i}() {\n`;
|
||||
code += current();
|
||||
code += `}\n`;
|
||||
current = () => `${somethingReturns ? "return " : ""}_next${i}();\n`;
|
||||
}
|
||||
const done = current;
|
||||
const doneBreak = skipDone => {
|
||||
if (skipDone) return "";
|
||||
return onDone();
|
||||
};
|
||||
const content = this.callTap(i, {
|
||||
onError: error => onError(i, error, done, doneBreak),
|
||||
onResult:
|
||||
onResult &&
|
||||
(result => {
|
||||
return onResult(i, result, done, doneBreak);
|
||||
}),
|
||||
onDone: !onResult && done,
|
||||
rethrowIfPossible:
|
||||
rethrowIfPossible && (firstAsync < 0 || i < firstAsync)
|
||||
});
|
||||
current = () => content;
|
||||
}
|
||||
code += current();
|
||||
return code;
|
||||
}
|
||||
|
||||
callTapsLooping({ onError, onDone, rethrowIfPossible }) {
|
||||
if (this.options.taps.length === 0) return onDone();
|
||||
const syncOnly = this.options.taps.every(t => t.type === "sync");
|
||||
let code = "";
|
||||
if (!syncOnly) {
|
||||
code += "var _looper = () => {\n";
|
||||
code += "var _loopAsync = false;\n";
|
||||
}
|
||||
code += "var _loop;\n";
|
||||
code += "do {\n";
|
||||
code += "_loop = false;\n";
|
||||
for (let i = 0; i < this.options.interceptors.length; i++) {
|
||||
const interceptor = this.options.interceptors[i];
|
||||
if (interceptor.loop) {
|
||||
code += `${this.getInterceptor(i)}.loop(${this.args({
|
||||
before: interceptor.context ? "_context" : undefined
|
||||
})});\n`;
|
||||
}
|
||||
}
|
||||
code += this.callTapsSeries({
|
||||
onError,
|
||||
onResult: (i, result, next, doneBreak) => {
|
||||
let code = "";
|
||||
code += `if(${result} !== undefined) {\n`;
|
||||
code += "_loop = true;\n";
|
||||
if (!syncOnly) code += "if(_loopAsync) _looper();\n";
|
||||
code += doneBreak(true);
|
||||
code += `} else {\n`;
|
||||
code += next();
|
||||
code += `}\n`;
|
||||
return code;
|
||||
},
|
||||
onDone:
|
||||
onDone &&
|
||||
(() => {
|
||||
let code = "";
|
||||
code += "if(!_loop) {\n";
|
||||
code += onDone();
|
||||
code += "}\n";
|
||||
return code;
|
||||
}),
|
||||
rethrowIfPossible: rethrowIfPossible && syncOnly
|
||||
});
|
||||
code += "} while(_loop);\n";
|
||||
if (!syncOnly) {
|
||||
code += "_loopAsync = true;\n";
|
||||
code += "};\n";
|
||||
code += "_looper();\n";
|
||||
}
|
||||
return code;
|
||||
}
|
||||
|
||||
callTapsParallel({
|
||||
onError,
|
||||
onResult,
|
||||
onDone,
|
||||
rethrowIfPossible,
|
||||
onTap = (i, run) => run()
|
||||
}) {
|
||||
if (this.options.taps.length <= 1) {
|
||||
return this.callTapsSeries({
|
||||
onError,
|
||||
onResult,
|
||||
onDone,
|
||||
rethrowIfPossible
|
||||
});
|
||||
}
|
||||
let code = "";
|
||||
code += "do {\n";
|
||||
code += `var _counter = ${this.options.taps.length};\n`;
|
||||
if (onDone) {
|
||||
code += "var _done = () => {\n";
|
||||
code += onDone();
|
||||
code += "};\n";
|
||||
}
|
||||
for (let i = 0; i < this.options.taps.length; i++) {
|
||||
const done = () => {
|
||||
if (onDone) return "if(--_counter === 0) _done();\n";
|
||||
else return "--_counter;";
|
||||
};
|
||||
const doneBreak = skipDone => {
|
||||
if (skipDone || !onDone) return "_counter = 0;\n";
|
||||
else return "_counter = 0;\n_done();\n";
|
||||
};
|
||||
code += "if(_counter <= 0) break;\n";
|
||||
code += onTap(
|
||||
i,
|
||||
() =>
|
||||
this.callTap(i, {
|
||||
onError: error => {
|
||||
let code = "";
|
||||
code += "if(_counter > 0) {\n";
|
||||
code += onError(i, error, done, doneBreak);
|
||||
code += "}\n";
|
||||
return code;
|
||||
},
|
||||
onResult:
|
||||
onResult &&
|
||||
(result => {
|
||||
let code = "";
|
||||
code += "if(_counter > 0) {\n";
|
||||
code += onResult(i, result, done, doneBreak);
|
||||
code += "}\n";
|
||||
return code;
|
||||
}),
|
||||
onDone:
|
||||
!onResult &&
|
||||
(() => {
|
||||
return done();
|
||||
}),
|
||||
rethrowIfPossible
|
||||
}),
|
||||
done,
|
||||
doneBreak
|
||||
);
|
||||
}
|
||||
code += "} while(false);\n";
|
||||
return code;
|
||||
}
|
||||
|
||||
args({ before, after } = {}) {
|
||||
let allArgs = this._args;
|
||||
if (before) allArgs = [before].concat(allArgs);
|
||||
if (after) allArgs = allArgs.concat(after);
|
||||
if (allArgs.length === 0) {
|
||||
return "";
|
||||
} else {
|
||||
return allArgs.join(", ");
|
||||
}
|
||||
}
|
||||
|
||||
getTapFn(idx) {
|
||||
return `_x[${idx}]`;
|
||||
}
|
||||
|
||||
getTap(idx) {
|
||||
return `_taps[${idx}]`;
|
||||
}
|
||||
|
||||
getInterceptor(idx) {
|
||||
return `_interceptors[${idx}]`;
|
||||
}
|
||||
}
|
||||
|
||||
module.exports = HookCodeFactory;
|
||||
|
|
@ -1,61 +0,0 @@
|
|||
/*
|
||||
MIT License http://www.opensource.org/licenses/mit-license.php
|
||||
Author Tobias Koppers @sokra
|
||||
*/
|
||||
"use strict";
|
||||
|
||||
const util = require("util");
|
||||
|
||||
const defaultFactory = (key, hook) => hook;
|
||||
|
||||
class HookMap {
|
||||
constructor(factory, name = undefined) {
|
||||
this._map = new Map();
|
||||
this.name = name;
|
||||
this._factory = factory;
|
||||
this._interceptors = [];
|
||||
}
|
||||
|
||||
get(key) {
|
||||
return this._map.get(key);
|
||||
}
|
||||
|
||||
for(key) {
|
||||
const hook = this.get(key);
|
||||
if (hook !== undefined) {
|
||||
return hook;
|
||||
}
|
||||
let newHook = this._factory(key);
|
||||
const interceptors = this._interceptors;
|
||||
for (let i = 0; i < interceptors.length; i++) {
|
||||
newHook = interceptors[i].factory(key, newHook);
|
||||
}
|
||||
this._map.set(key, newHook);
|
||||
return newHook;
|
||||
}
|
||||
|
||||
intercept(interceptor) {
|
||||
this._interceptors.push(
|
||||
Object.assign(
|
||||
{
|
||||
factory: defaultFactory
|
||||
},
|
||||
interceptor
|
||||
)
|
||||
);
|
||||
}
|
||||
}
|
||||
|
||||
HookMap.prototype.tap = util.deprecate(function(key, options, fn) {
|
||||
return this.for(key).tap(options, fn);
|
||||
}, "HookMap#tap(key,…) is deprecated. Use HookMap#for(key).tap(…) instead.");
|
||||
|
||||
HookMap.prototype.tapAsync = util.deprecate(function(key, options, fn) {
|
||||
return this.for(key).tapAsync(options, fn);
|
||||
}, "HookMap#tapAsync(key,…) is deprecated. Use HookMap#for(key).tapAsync(…) instead.");
|
||||
|
||||
HookMap.prototype.tapPromise = util.deprecate(function(key, options, fn) {
|
||||
return this.for(key).tapPromise(options, fn);
|
||||
}, "HookMap#tapPromise(key,…) is deprecated. Use HookMap#for(key).tapPromise(…) instead.");
|
||||
|
||||
module.exports = HookMap;
|
||||
|
|
@ -1,54 +0,0 @@
|
|||
/*
|
||||
MIT License http://www.opensource.org/licenses/mit-license.php
|
||||
Author Tobias Koppers @sokra
|
||||
*/
|
||||
"use strict";
|
||||
|
||||
const Hook = require("./Hook");
|
||||
|
||||
class MultiHook {
|
||||
constructor(hooks, name = undefined) {
|
||||
this.hooks = hooks;
|
||||
this.name = name;
|
||||
}
|
||||
|
||||
tap(options, fn) {
|
||||
for (const hook of this.hooks) {
|
||||
hook.tap(options, fn);
|
||||
}
|
||||
}
|
||||
|
||||
tapAsync(options, fn) {
|
||||
for (const hook of this.hooks) {
|
||||
hook.tapAsync(options, fn);
|
||||
}
|
||||
}
|
||||
|
||||
tapPromise(options, fn) {
|
||||
for (const hook of this.hooks) {
|
||||
hook.tapPromise(options, fn);
|
||||
}
|
||||
}
|
||||
|
||||
isUsed() {
|
||||
for (const hook of this.hooks) {
|
||||
if (hook.isUsed()) return true;
|
||||
}
|
||||
return false;
|
||||
}
|
||||
|
||||
intercept(interceptor) {
|
||||
for (const hook of this.hooks) {
|
||||
hook.intercept(interceptor);
|
||||
}
|
||||
}
|
||||
|
||||
withOptions(options) {
|
||||
return new MultiHook(
|
||||
this.hooks.map(h => h.withOptions(options)),
|
||||
this.name
|
||||
);
|
||||
}
|
||||
}
|
||||
|
||||
module.exports = MultiHook;
|
||||
|
|
@ -1,51 +0,0 @@
|
|||
/*
|
||||
MIT License http://www.opensource.org/licenses/mit-license.php
|
||||
Author Tobias Koppers @sokra
|
||||
*/
|
||||
"use strict";
|
||||
|
||||
const Hook = require("./Hook");
|
||||
const HookCodeFactory = require("./HookCodeFactory");
|
||||
|
||||
class SyncBailHookCodeFactory extends HookCodeFactory {
|
||||
content({ onError, onResult, resultReturns, onDone, rethrowIfPossible }) {
|
||||
return this.callTapsSeries({
|
||||
onError: (i, err) => onError(err),
|
||||
onResult: (i, result, next) =>
|
||||
`if(${result} !== undefined) {\n${onResult(
|
||||
result
|
||||
)};\n} else {\n${next()}}\n`,
|
||||
resultReturns,
|
||||
onDone,
|
||||
rethrowIfPossible
|
||||
});
|
||||
}
|
||||
}
|
||||
|
||||
const factory = new SyncBailHookCodeFactory();
|
||||
|
||||
const TAP_ASYNC = () => {
|
||||
throw new Error("tapAsync is not supported on a SyncBailHook");
|
||||
};
|
||||
|
||||
const TAP_PROMISE = () => {
|
||||
throw new Error("tapPromise is not supported on a SyncBailHook");
|
||||
};
|
||||
|
||||
const COMPILE = function(options) {
|
||||
factory.setup(this, options);
|
||||
return factory.create(options);
|
||||
};
|
||||
|
||||
function SyncBailHook(args = [], name = undefined) {
|
||||
const hook = new Hook(args, name);
|
||||
hook.constructor = SyncBailHook;
|
||||
hook.tapAsync = TAP_ASYNC;
|
||||
hook.tapPromise = TAP_PROMISE;
|
||||
hook.compile = COMPILE;
|
||||
return hook;
|
||||
}
|
||||
|
||||
SyncBailHook.prototype = null;
|
||||
|
||||
module.exports = SyncBailHook;
|
||||
|
|
@ -1,46 +0,0 @@
|
|||
/*
|
||||
MIT License http://www.opensource.org/licenses/mit-license.php
|
||||
Author Tobias Koppers @sokra
|
||||
*/
|
||||
"use strict";
|
||||
|
||||
const Hook = require("./Hook");
|
||||
const HookCodeFactory = require("./HookCodeFactory");
|
||||
|
||||
class SyncHookCodeFactory extends HookCodeFactory {
|
||||
content({ onError, onDone, rethrowIfPossible }) {
|
||||
return this.callTapsSeries({
|
||||
onError: (i, err) => onError(err),
|
||||
onDone,
|
||||
rethrowIfPossible
|
||||
});
|
||||
}
|
||||
}
|
||||
|
||||
const factory = new SyncHookCodeFactory();
|
||||
|
||||
const TAP_ASYNC = () => {
|
||||
throw new Error("tapAsync is not supported on a SyncHook");
|
||||
};
|
||||
|
||||
const TAP_PROMISE = () => {
|
||||
throw new Error("tapPromise is not supported on a SyncHook");
|
||||
};
|
||||
|
||||
const COMPILE = function(options) {
|
||||
factory.setup(this, options);
|
||||
return factory.create(options);
|
||||
};
|
||||
|
||||
function SyncHook(args = [], name = undefined) {
|
||||
const hook = new Hook(args, name);
|
||||
hook.constructor = SyncHook;
|
||||
hook.tapAsync = TAP_ASYNC;
|
||||
hook.tapPromise = TAP_PROMISE;
|
||||
hook.compile = COMPILE;
|
||||
return hook;
|
||||
}
|
||||
|
||||
SyncHook.prototype = null;
|
||||
|
||||
module.exports = SyncHook;
|
||||
|
|
@ -1,46 +0,0 @@
|
|||
/*
|
||||
MIT License http://www.opensource.org/licenses/mit-license.php
|
||||
Author Tobias Koppers @sokra
|
||||
*/
|
||||
"use strict";
|
||||
|
||||
const Hook = require("./Hook");
|
||||
const HookCodeFactory = require("./HookCodeFactory");
|
||||
|
||||
class SyncLoopHookCodeFactory extends HookCodeFactory {
|
||||
content({ onError, onDone, rethrowIfPossible }) {
|
||||
return this.callTapsLooping({
|
||||
onError: (i, err) => onError(err),
|
||||
onDone,
|
||||
rethrowIfPossible
|
||||
});
|
||||
}
|
||||
}
|
||||
|
||||
const factory = new SyncLoopHookCodeFactory();
|
||||
|
||||
const TAP_ASYNC = () => {
|
||||
throw new Error("tapAsync is not supported on a SyncLoopHook");
|
||||
};
|
||||
|
||||
const TAP_PROMISE = () => {
|
||||
throw new Error("tapPromise is not supported on a SyncLoopHook");
|
||||
};
|
||||
|
||||
const COMPILE = function(options) {
|
||||
factory.setup(this, options);
|
||||
return factory.create(options);
|
||||
};
|
||||
|
||||
function SyncLoopHook(args = [], name = undefined) {
|
||||
const hook = new Hook(args, name);
|
||||
hook.constructor = SyncLoopHook;
|
||||
hook.tapAsync = TAP_ASYNC;
|
||||
hook.tapPromise = TAP_PROMISE;
|
||||
hook.compile = COMPILE;
|
||||
return hook;
|
||||
}
|
||||
|
||||
SyncLoopHook.prototype = null;
|
||||
|
||||
module.exports = SyncLoopHook;
|
||||
|
|
@ -1,57 +0,0 @@
|
|||
/*
|
||||
MIT License http://www.opensource.org/licenses/mit-license.php
|
||||
Author Tobias Koppers @sokra
|
||||
*/
|
||||
"use strict";
|
||||
|
||||
const Hook = require("./Hook");
|
||||
const HookCodeFactory = require("./HookCodeFactory");
|
||||
|
||||
class SyncWaterfallHookCodeFactory extends HookCodeFactory {
|
||||
content({ onError, onResult, resultReturns, rethrowIfPossible }) {
|
||||
return this.callTapsSeries({
|
||||
onError: (i, err) => onError(err),
|
||||
onResult: (i, result, next) => {
|
||||
let code = "";
|
||||
code += `if(${result} !== undefined) {\n`;
|
||||
code += `${this._args[0]} = ${result};\n`;
|
||||
code += `}\n`;
|
||||
code += next();
|
||||
return code;
|
||||
},
|
||||
onDone: () => onResult(this._args[0]),
|
||||
doneReturns: resultReturns,
|
||||
rethrowIfPossible
|
||||
});
|
||||
}
|
||||
}
|
||||
|
||||
const factory = new SyncWaterfallHookCodeFactory();
|
||||
|
||||
const TAP_ASYNC = () => {
|
||||
throw new Error("tapAsync is not supported on a SyncWaterfallHook");
|
||||
};
|
||||
|
||||
const TAP_PROMISE = () => {
|
||||
throw new Error("tapPromise is not supported on a SyncWaterfallHook");
|
||||
};
|
||||
|
||||
const COMPILE = function(options) {
|
||||
factory.setup(this, options);
|
||||
return factory.create(options);
|
||||
};
|
||||
|
||||
function SyncWaterfallHook(args = [], name = undefined) {
|
||||
if (args.length < 1)
|
||||
throw new Error("Waterfall hooks must have at least one argument");
|
||||
const hook = new Hook(args, name);
|
||||
hook.constructor = SyncWaterfallHook;
|
||||
hook.tapAsync = TAP_ASYNC;
|
||||
hook.tapPromise = TAP_PROMISE;
|
||||
hook.compile = COMPILE;
|
||||
return hook;
|
||||
}
|
||||
|
||||
SyncWaterfallHook.prototype = null;
|
||||
|
||||
module.exports = SyncWaterfallHook;
|
||||
|
|
@ -1,19 +0,0 @@
|
|||
/*
|
||||
MIT License http://www.opensource.org/licenses/mit-license.php
|
||||
Author Tobias Koppers @sokra
|
||||
*/
|
||||
"use strict";
|
||||
|
||||
exports.__esModule = true;
|
||||
exports.SyncHook = require("./SyncHook");
|
||||
exports.SyncBailHook = require("./SyncBailHook");
|
||||
exports.SyncWaterfallHook = require("./SyncWaterfallHook");
|
||||
exports.SyncLoopHook = require("./SyncLoopHook");
|
||||
exports.AsyncParallelHook = require("./AsyncParallelHook");
|
||||
exports.AsyncParallelBailHook = require("./AsyncParallelBailHook");
|
||||
exports.AsyncSeriesHook = require("./AsyncSeriesHook");
|
||||
exports.AsyncSeriesBailHook = require("./AsyncSeriesBailHook");
|
||||
exports.AsyncSeriesLoopHook = require("./AsyncSeriesLoopHook");
|
||||
exports.AsyncSeriesWaterfallHook = require("./AsyncSeriesWaterfallHook");
|
||||
exports.HookMap = require("./HookMap");
|
||||
exports.MultiHook = require("./MultiHook");
|
||||
|
|
@ -1,41 +0,0 @@
|
|||
{
|
||||
"name": "tapable",
|
||||
"version": "2.0.0-beta.8",
|
||||
"author": "Tobias Koppers @sokra",
|
||||
"description": "Just a little module for plugins.",
|
||||
"license": "MIT",
|
||||
"homepage": "https://github.com/webpack/tapable",
|
||||
"repository": {
|
||||
"type": "git",
|
||||
"url": "http://github.com/webpack/tapable.git"
|
||||
},
|
||||
"devDependencies": {
|
||||
"@babel/core": "^7.4.4",
|
||||
"@babel/preset-env": "^7.4.4",
|
||||
"babel-jest": "^24.8.0",
|
||||
"codecov": "^3.5.0",
|
||||
"jest": "^24.8.0",
|
||||
"prettier": "^1.17.1"
|
||||
},
|
||||
"engines": {
|
||||
"node": ">=6"
|
||||
},
|
||||
"files": [
|
||||
"lib",
|
||||
"!lib/__tests__",
|
||||
"tapable.d.ts"
|
||||
],
|
||||
"main": "lib/index.js",
|
||||
"types": "./tapable.d.ts",
|
||||
"scripts": {
|
||||
"test": "jest",
|
||||
"travis": "yarn pretty-lint && jest --coverage && codecov",
|
||||
"pretty-lint": "prettier --check lib/*.js lib/__tests__/*.js",
|
||||
"pretty": "prettier --loglevel warn --write lib/*.js lib/__tests__/*.js"
|
||||
},
|
||||
"jest": {
|
||||
"transform": {
|
||||
"__tests__[\\\\/].+\\.js$": "babel-jest"
|
||||
}
|
||||
}
|
||||
}
|
||||
|
|
@ -1,101 +0,0 @@
|
|||
type FixedSizeArray<T extends number, U> = T extends 0
|
||||
? void[]
|
||||
: ReadonlyArray<U> & {
|
||||
0: U;
|
||||
length: T;
|
||||
};
|
||||
type Measure<T extends number> = T extends 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8
|
||||
? T
|
||||
: never;
|
||||
type Append<T extends any[], U> = {
|
||||
0: [U];
|
||||
1: [T[0], U];
|
||||
2: [T[0], T[1], U];
|
||||
3: [T[0], T[1], T[2], U];
|
||||
4: [T[0], T[1], T[2], T[3], U];
|
||||
5: [T[0], T[1], T[2], T[3], T[4], U];
|
||||
6: [T[0], T[1], T[2], T[3], T[4], T[5], U];
|
||||
7: [T[0], T[1], T[2], T[3], T[4], T[5], T[6], U];
|
||||
8: [T[0], T[1], T[2], T[3], T[4], T[5], T[6], T[7], U];
|
||||
}[Measure<T["length"]>];
|
||||
type AsArray<T> = T extends any[] ? T : [T];
|
||||
|
||||
type Callback<E, T> = (error?: E, result?: T) => void;
|
||||
|
||||
type Tap = TapOptions & {
|
||||
name: string;
|
||||
};
|
||||
|
||||
type TapOptions = {
|
||||
before?: string;
|
||||
stage?: number;
|
||||
};
|
||||
|
||||
interface HookInterceptor<H> {
|
||||
name?: string;
|
||||
tap?: (tap: Tap) => void;
|
||||
call?: (...args: any[]) => void;
|
||||
loop?: (...args: any[]) => void;
|
||||
register?: (hook: H) => H;
|
||||
}
|
||||
|
||||
type ArgumentNames<T extends any[]> = FixedSizeArray<T["length"], string>;
|
||||
|
||||
declare class Hook<T, R> {
|
||||
constructor(args?: ArgumentNames<AsArray<T>>, name?: string);
|
||||
name: string | undefined;
|
||||
intercept(interceptor: HookInterceptor<Hook<T, R>>): void;
|
||||
isUsed(): boolean;
|
||||
callAsync(...args: Append<AsArray<T>, Callback<Error, R>>): void;
|
||||
promise(...args: AsArray<T>): Promise<R>;
|
||||
tap(options: string | Tap, fn: (...args: AsArray<T>) => R): void;
|
||||
withOptions(options: TapOptions): Hook<T, R>;
|
||||
}
|
||||
|
||||
export class SyncHook<T, R = void> extends Hook<T, R> {
|
||||
call(...args: AsArray<T>): R;
|
||||
}
|
||||
|
||||
export class SyncBailHook<T, R> extends SyncHook<T, R> {}
|
||||
export class SyncLoopHook<T> extends SyncHook<T, void> {}
|
||||
export class SyncWaterfallHook<T> extends SyncHook<T, AsArray<T>[0]> {}
|
||||
|
||||
declare class AsyncHook<T, R> extends Hook<T, R> {
|
||||
tapAsync(
|
||||
options: string | Tap,
|
||||
fn: (...args: Append<AsArray<T>, Callback<Error, R>>) => void
|
||||
): void;
|
||||
tapPromise(
|
||||
options: string | Tap,
|
||||
fn: (...args: AsArray<T>) => Promise<R>
|
||||
): void;
|
||||
}
|
||||
|
||||
export class AsyncParallelHook<T> extends AsyncHook<T, void> {}
|
||||
export class AsyncParallelBailHook<T, R> extends AsyncHook<T, R> {}
|
||||
export class AsyncSeriesHook<T> extends AsyncHook<T, void> {}
|
||||
export class AsyncSeriesBailHook<T, R> extends AsyncHook<T, R> {}
|
||||
export class AsyncSeriesLoopHook<T> extends AsyncHook<T, void> {}
|
||||
export class AsyncSeriesWaterfallHook<T> extends AsyncHook<T, AsArray<T>[0]> {}
|
||||
|
||||
type HookFactory<H> = (key: any, hook?: H) => H;
|
||||
|
||||
interface HookMapInterceptor<H> {
|
||||
factory?: HookFactory<H>;
|
||||
}
|
||||
|
||||
export class HookMap<H> {
|
||||
constructor(factory: HookFactory<H>, name?: string);
|
||||
name: string | undefined;
|
||||
get(key: any): H | undefined;
|
||||
for(key: any): H;
|
||||
intercept(interceptor: HookMapInterceptor<H>): void;
|
||||
}
|
||||
|
||||
export class MultiHook<H> {
|
||||
constructor(hooks: H[], name?: string);
|
||||
name: string | undefined;
|
||||
tap(options: string | Tap, fn?: Function): void;
|
||||
tapAsync(options: string | Tap, fn?: Function): void;
|
||||
tapPromise(options: string | Tap, fn?: Function): void;
|
||||
}
|
||||
|
|
@ -1,5 +0,0 @@
|
|||
export * from '@l7/core';
|
||||
export * from '@l7/scene';
|
||||
export * from '@l7/layers';
|
||||
export * from '@l7/component';
|
||||
//# sourceMappingURL=index.js.map
|
||||
|
|
@ -1,21 +0,0 @@
|
|||
The MIT License
|
||||
|
||||
Copyright JS Foundation and other contributors
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
of this software and associated documentation files (the "Software"), to deal
|
||||
in the Software without restriction, including without limitation the rights
|
||||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||
copies of the Software, and to permit persons to whom the Software is
|
||||
furnished to do so, subject to the following conditions:
|
||||
|
||||
The above copyright notice and this permission notice shall be included in
|
||||
all copies or substantial portions of the Software.
|
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
|
||||
THE SOFTWARE.
|
||||
|
|
@ -1,298 +0,0 @@
|
|||
# Tapable
|
||||
|
||||
The tapable package expose many Hook classes, which can be used to create hooks for plugins.
|
||||
|
||||
``` javascript
|
||||
const {
|
||||
SyncHook,
|
||||
SyncBailHook,
|
||||
SyncWaterfallHook,
|
||||
SyncLoopHook,
|
||||
AsyncParallelHook,
|
||||
AsyncParallelBailHook,
|
||||
AsyncSeriesHook,
|
||||
AsyncSeriesBailHook,
|
||||
AsyncSeriesWaterfallHook
|
||||
} = require("tapable");
|
||||
```
|
||||
|
||||
## Installation
|
||||
|
||||
``` shell
|
||||
npm install --save tapable
|
||||
```
|
||||
|
||||
## Usage
|
||||
|
||||
All Hook constructors take one optional argument, which is a list of argument names as strings.
|
||||
|
||||
``` js
|
||||
const hook = new SyncHook(["arg1", "arg2", "arg3"]);
|
||||
```
|
||||
|
||||
The best practice is to expose all hooks of a class in a `hooks` property:
|
||||
|
||||
``` js
|
||||
class Car {
|
||||
constructor() {
|
||||
this.hooks = {
|
||||
accelerate: new SyncHook(["newSpeed"]),
|
||||
brake: new SyncHook(),
|
||||
calculateRoutes: new AsyncParallelHook(["source", "target", "routesList"])
|
||||
};
|
||||
}
|
||||
|
||||
/* ... */
|
||||
}
|
||||
```
|
||||
|
||||
Other people can now use these hooks:
|
||||
|
||||
``` js
|
||||
const myCar = new Car();
|
||||
|
||||
// Use the tap method to add a consument
|
||||
myCar.hooks.brake.tap("WarningLampPlugin", () => warningLamp.on());
|
||||
```
|
||||
|
||||
It's required to pass a name to identify the plugin/reason.
|
||||
|
||||
You may receive arguments:
|
||||
|
||||
``` js
|
||||
myCar.hooks.accelerate.tap("LoggerPlugin", newSpeed => console.log(`Accelerating to ${newSpeed}`));
|
||||
```
|
||||
|
||||
For sync hooks, `tap` is the only valid method to add a plugin. Async hooks also support async plugins:
|
||||
|
||||
``` js
|
||||
myCar.hooks.calculateRoutes.tapPromise("GoogleMapsPlugin", (source, target, routesList) => {
|
||||
// return a promise
|
||||
return google.maps.findRoute(source, target).then(route => {
|
||||
routesList.add(route);
|
||||
});
|
||||
});
|
||||
myCar.hooks.calculateRoutes.tapAsync("BingMapsPlugin", (source, target, routesList, callback) => {
|
||||
bing.findRoute(source, target, (err, route) => {
|
||||
if(err) return callback(err);
|
||||
routesList.add(route);
|
||||
// call the callback
|
||||
callback();
|
||||
});
|
||||
});
|
||||
|
||||
// You can still use sync plugins
|
||||
myCar.hooks.calculateRoutes.tap("CachedRoutesPlugin", (source, target, routesList) => {
|
||||
const cachedRoute = cache.get(source, target);
|
||||
if(cachedRoute)
|
||||
routesList.add(cachedRoute);
|
||||
})
|
||||
```
|
||||
The class declaring these hooks need to call them:
|
||||
|
||||
``` js
|
||||
class Car {
|
||||
/**
|
||||
* You won't get returned value from SyncHook or AsyncParallelHook,
|
||||
* to do that, use SyncWaterfallHook and AsyncSeriesWaterfallHook respectively
|
||||
**/
|
||||
|
||||
setSpeed(newSpeed) {
|
||||
// following call returns undefined even when you returned values
|
||||
this.hooks.accelerate.call(newSpeed);
|
||||
}
|
||||
|
||||
useNavigationSystemPromise(source, target) {
|
||||
const routesList = new List();
|
||||
return this.hooks.calculateRoutes.promise(source, target, routesList).then((res) => {
|
||||
// res is undefined for AsyncParallelHook
|
||||
return routesList.getRoutes();
|
||||
});
|
||||
}
|
||||
|
||||
useNavigationSystemAsync(source, target, callback) {
|
||||
const routesList = new List();
|
||||
this.hooks.calculateRoutes.callAsync(source, target, routesList, err => {
|
||||
if(err) return callback(err);
|
||||
callback(null, routesList.getRoutes());
|
||||
});
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
The Hook will compile a method with the most efficient way of running your plugins. It generates code depending on:
|
||||
* The number of registered plugins (none, one, many)
|
||||
* The kind of registered plugins (sync, async, promise)
|
||||
* The used call method (sync, async, promise)
|
||||
* The number of arguments
|
||||
* Whether interception is used
|
||||
|
||||
This ensures fastest possible execution.
|
||||
|
||||
## Hook types
|
||||
|
||||
Each hook can be tapped with one or several functions. How they are executed depends on the hook type:
|
||||
|
||||
* Basic hook (without “Waterfall”, “Bail” or “Loop” in its name). This hook simply calls every function it tapped in a row.
|
||||
|
||||
* __Waterfall__. A waterfall hook also calls each tapped function in a row. Unlike the basic hook, it passes a return value from each function to the next function.
|
||||
|
||||
* __Bail__. A bail hook allows exiting early. When any of the tapped function returns anything, the bail hook will stop executing the remaining ones.
|
||||
|
||||
* __Loop__. TODO
|
||||
|
||||
Additionally, hooks can be synchronous or asynchronous. To reflect this, there’re “Sync”, “AsyncSeries”, and “AsyncParallel” hook classes:
|
||||
|
||||
* __Sync__. A sync hook can only be tapped with synchronous functions (using `myHook.tap()`).
|
||||
|
||||
* __AsyncSeries__. An async-series hook can be tapped with synchronous, callback-based and promise-based functions (using `myHook.tap()`, `myHook.tapAsync()` and `myHook.tapPromise()`). They call each async method in a row.
|
||||
|
||||
* __AsyncParallel__. An async-parallel hook can also be tapped with synchronous, callback-based and promise-based functions (using `myHook.tap()`, `myHook.tapAsync()` and `myHook.tapPromise()`). However, they run each async method in parallel.
|
||||
|
||||
The hook type is reflected in its class name. E.g., `AsyncSeriesWaterfallHook` allows asynchronous functions and runs them in series, passing each function’s return value into the next function.
|
||||
|
||||
|
||||
## Interception
|
||||
|
||||
All Hooks offer an additional interception API:
|
||||
|
||||
``` js
|
||||
myCar.hooks.calculateRoutes.intercept({
|
||||
call: (source, target, routesList) => {
|
||||
console.log("Starting to calculate routes");
|
||||
},
|
||||
register: (tapInfo) => {
|
||||
// tapInfo = { type: "promise", name: "GoogleMapsPlugin", fn: ... }
|
||||
console.log(`${tapInfo.name} is doing its job`);
|
||||
return tapInfo; // may return a new tapInfo object
|
||||
}
|
||||
})
|
||||
```
|
||||
|
||||
**call**: `(...args) => void` Adding `call` to your interceptor will trigger when hooks are triggered. You have access to the hooks arguments.
|
||||
|
||||
**tap**: `(tap: Tap) => void` Adding `tap` to your interceptor will trigger when a plugin taps into a hook. Provided is the `Tap` object. `Tap` object can't be changed.
|
||||
|
||||
**loop**: `(...args) => void` Adding `loop` to your interceptor will trigger for each loop of a looping hook.
|
||||
|
||||
**register**: `(tap: Tap) => Tap | undefined` Adding `register` to your interceptor will trigger for each added `Tap` and allows to modify it.
|
||||
|
||||
## Context
|
||||
|
||||
Plugins and interceptors can opt-in to access an optional `context` object, which can be used to pass arbitrary values to subsequent plugins and interceptors.
|
||||
|
||||
``` js
|
||||
myCar.hooks.accelerate.intercept({
|
||||
context: true,
|
||||
tap: (context, tapInfo) => {
|
||||
// tapInfo = { type: "sync", name: "NoisePlugin", fn: ... }
|
||||
console.log(`${tapInfo.name} is doing it's job`);
|
||||
|
||||
// `context` starts as an empty object if at least one plugin uses `context: true`.
|
||||
// If no plugins use `context: true`, then `context` is undefined.
|
||||
if (context) {
|
||||
// Arbitrary properties can be added to `context`, which plugins can then access.
|
||||
context.hasMuffler = true;
|
||||
}
|
||||
}
|
||||
});
|
||||
|
||||
myCar.hooks.accelerate.tap({
|
||||
name: "NoisePlugin",
|
||||
context: true
|
||||
}, (context, newSpeed) => {
|
||||
if (context && context.hasMuffler) {
|
||||
console.log("Silence...");
|
||||
} else {
|
||||
console.log("Vroom!");
|
||||
}
|
||||
});
|
||||
```
|
||||
|
||||
## HookMap
|
||||
|
||||
A HookMap is a helper class for a Map with Hooks
|
||||
|
||||
``` js
|
||||
const keyedHook = new HookMap(key => new SyncHook(["arg"]))
|
||||
```
|
||||
|
||||
``` js
|
||||
keyedHook.tap("some-key", "MyPlugin", (arg) => { /* ... */ });
|
||||
keyedHook.tapAsync("some-key", "MyPlugin", (arg, callback) => { /* ... */ });
|
||||
keyedHook.tapPromise("some-key", "MyPlugin", (arg) => { /* ... */ });
|
||||
```
|
||||
|
||||
``` js
|
||||
const hook = keyedHook.get("some-key");
|
||||
if(hook !== undefined) {
|
||||
hook.callAsync("arg", err => { /* ... */ });
|
||||
}
|
||||
```
|
||||
|
||||
## Hook/HookMap interface
|
||||
|
||||
Public:
|
||||
|
||||
``` ts
|
||||
interface Hook {
|
||||
tap: (name: string | Tap, fn: (context?, ...args) => Result) => void,
|
||||
tapAsync: (name: string | Tap, fn: (context?, ...args, callback: (err, result: Result) => void) => void) => void,
|
||||
tapPromise: (name: string | Tap, fn: (context?, ...args) => Promise<Result>) => void,
|
||||
intercept: (interceptor: HookInterceptor) => void
|
||||
}
|
||||
|
||||
interface HookInterceptor {
|
||||
call: (context?, ...args) => void,
|
||||
loop: (context?, ...args) => void,
|
||||
tap: (context?, tap: Tap) => void,
|
||||
register: (tap: Tap) => Tap,
|
||||
context: boolean
|
||||
}
|
||||
|
||||
interface HookMap {
|
||||
for: (key: any) => Hook,
|
||||
tap: (key: any, name: string | Tap, fn: (context?, ...args) => Result) => void,
|
||||
tapAsync: (key: any, name: string | Tap, fn: (context?, ...args, callback: (err, result: Result) => void) => void) => void,
|
||||
tapPromise: (key: any, name: string | Tap, fn: (context?, ...args) => Promise<Result>) => void,
|
||||
intercept: (interceptor: HookMapInterceptor) => void
|
||||
}
|
||||
|
||||
interface HookMapInterceptor {
|
||||
factory: (key: any, hook: Hook) => Hook
|
||||
}
|
||||
|
||||
interface Tap {
|
||||
name: string,
|
||||
type: string
|
||||
fn: Function,
|
||||
stage: number,
|
||||
context: boolean
|
||||
}
|
||||
```
|
||||
|
||||
Protected (only for the class containing the hook):
|
||||
|
||||
``` ts
|
||||
interface Hook {
|
||||
isUsed: () => boolean,
|
||||
call: (...args) => Result,
|
||||
promise: (...args) => Promise<Result>,
|
||||
callAsync: (...args, callback: (err, result: Result) => void) => void,
|
||||
}
|
||||
|
||||
interface HookMap {
|
||||
get: (key: any) => Hook | undefined,
|
||||
for: (key: any) => Hook
|
||||
}
|
||||
```
|
||||
|
||||
## MultiHook
|
||||
|
||||
A helper Hook-like class to redirect taps to multiple other hooks:
|
||||
|
||||
``` js
|
||||
const { MultiHook } = require("tapable");
|
||||
|
||||
this.hooks.allHooks = new MultiHook([this.hooks.hookA, this.hooks.hookB]);
|
||||
```
|
||||
|
|
@ -1,85 +0,0 @@
|
|||
/*
|
||||
MIT License http://www.opensource.org/licenses/mit-license.php
|
||||
Author Tobias Koppers @sokra
|
||||
*/
|
||||
"use strict";
|
||||
|
||||
const Hook = require("./Hook");
|
||||
const HookCodeFactory = require("./HookCodeFactory");
|
||||
|
||||
class AsyncParallelBailHookCodeFactory extends HookCodeFactory {
|
||||
content({ onError, onResult, onDone }) {
|
||||
let code = "";
|
||||
code += `var _results = new Array(${this.options.taps.length});\n`;
|
||||
code += "var _checkDone = () => {\n";
|
||||
code += "for(var i = 0; i < _results.length; i++) {\n";
|
||||
code += "var item = _results[i];\n";
|
||||
code += "if(item === undefined) return false;\n";
|
||||
code += "if(item.result !== undefined) {\n";
|
||||
code += onResult("item.result");
|
||||
code += "return true;\n";
|
||||
code += "}\n";
|
||||
code += "if(item.error) {\n";
|
||||
code += onError("item.error");
|
||||
code += "return true;\n";
|
||||
code += "}\n";
|
||||
code += "}\n";
|
||||
code += "return false;\n";
|
||||
code += "}\n";
|
||||
code += this.callTapsParallel({
|
||||
onError: (i, err, done, doneBreak) => {
|
||||
let code = "";
|
||||
code += `if(${i} < _results.length && ((_results.length = ${i +
|
||||
1}), (_results[${i}] = { error: ${err} }), _checkDone())) {\n`;
|
||||
code += doneBreak(true);
|
||||
code += "} else {\n";
|
||||
code += done();
|
||||
code += "}\n";
|
||||
return code;
|
||||
},
|
||||
onResult: (i, result, done, doneBreak) => {
|
||||
let code = "";
|
||||
code += `if(${i} < _results.length && (${result} !== undefined && (_results.length = ${i +
|
||||
1}), (_results[${i}] = { result: ${result} }), _checkDone())) {\n`;
|
||||
code += doneBreak(true);
|
||||
code += "} else {\n";
|
||||
code += done();
|
||||
code += "}\n";
|
||||
return code;
|
||||
},
|
||||
onTap: (i, run, done, doneBreak) => {
|
||||
let code = "";
|
||||
if (i > 0) {
|
||||
code += `if(${i} >= _results.length) {\n`;
|
||||
code += done();
|
||||
code += "} else {\n";
|
||||
}
|
||||
code += run();
|
||||
if (i > 0) code += "}\n";
|
||||
return code;
|
||||
},
|
||||
onDone
|
||||
});
|
||||
return code;
|
||||
}
|
||||
}
|
||||
|
||||
const factory = new AsyncParallelBailHookCodeFactory();
|
||||
|
||||
const COMPILE = function(options) {
|
||||
factory.setup(this, options);
|
||||
return factory.create(options);
|
||||
};
|
||||
|
||||
function AsyncParallelBailHook(args = [], name = undefined) {
|
||||
const hook = new Hook(args, name);
|
||||
hook.constructor = AsyncParallelBailHook;
|
||||
hook.compile = COMPILE;
|
||||
hook._call = undefined;
|
||||
hook.call = undefined;
|
||||
return hook;
|
||||
}
|
||||
|
||||
AsyncParallelBailHook.prototype = null;
|
||||
|
||||
module.exports = AsyncParallelBailHook;
|
||||
|
|
@ -1,37 +0,0 @@
|
|||
/*
|
||||
MIT License http://www.opensource.org/licenses/mit-license.php
|
||||
Author Tobias Koppers @sokra
|
||||
*/
|
||||
"use strict";
|
||||
|
||||
const Hook = require("./Hook");
|
||||
const HookCodeFactory = require("./HookCodeFactory");
|
||||
|
||||
class AsyncParallelHookCodeFactory extends HookCodeFactory {
|
||||
content({ onError, onDone }) {
|
||||
return this.callTapsParallel({
|
||||
onError: (i, err, done, doneBreak) => onError(err) + doneBreak(true),
|
||||
onDone
|
||||
});
|
||||
}
|
||||
}
|
||||
|
||||
const factory = new AsyncParallelHookCodeFactory();
|
||||
|
||||
const COMPILE = function(options) {
|
||||
factory.setup(this, options);
|
||||
return factory.create(options);
|
||||
};
|
||||
|
||||
function AsyncParallelHook(args = [], name = undefined) {
|
||||
const hook = new Hook(args, name);
|
||||
hook.constructor = AsyncParallelHook;
|
||||
hook.compile = COMPILE;
|
||||
hook._call = undefined;
|
||||
hook.call = undefined;
|
||||
return hook;
|
||||
}
|
||||
|
||||
AsyncParallelHook.prototype = null;
|
||||
|
||||
module.exports = AsyncParallelHook;
|
||||
|
|
@ -1,42 +0,0 @@
|
|||
/*
|
||||
MIT License http://www.opensource.org/licenses/mit-license.php
|
||||
Author Tobias Koppers @sokra
|
||||
*/
|
||||
"use strict";
|
||||
|
||||
const Hook = require("./Hook");
|
||||
const HookCodeFactory = require("./HookCodeFactory");
|
||||
|
||||
class AsyncSeriesBailHookCodeFactory extends HookCodeFactory {
|
||||
content({ onError, onResult, resultReturns, onDone }) {
|
||||
return this.callTapsSeries({
|
||||
onError: (i, err, next, doneBreak) => onError(err) + doneBreak(true),
|
||||
onResult: (i, result, next) =>
|
||||
`if(${result} !== undefined) {\n${onResult(
|
||||
result
|
||||
)};\n} else {\n${next()}}\n`,
|
||||
resultReturns,
|
||||
onDone
|
||||
});
|
||||
}
|
||||
}
|
||||
|
||||
const factory = new AsyncSeriesBailHookCodeFactory();
|
||||
|
||||
const COMPILE = function(options) {
|
||||
factory.setup(this, options);
|
||||
return factory.create(options);
|
||||
};
|
||||
|
||||
function AsyncSeriesBailHook(args = [], name = undefined) {
|
||||
const hook = new Hook(args, name);
|
||||
hook.constructor = AsyncSeriesBailHook;
|
||||
hook.compile = COMPILE;
|
||||
hook._call = undefined;
|
||||
hook.call = undefined;
|
||||
return hook;
|
||||
}
|
||||
|
||||
AsyncSeriesBailHook.prototype = null;
|
||||
|
||||
module.exports = AsyncSeriesBailHook;
|
||||
|
|
@ -1,37 +0,0 @@
|
|||
/*
|
||||
MIT License http://www.opensource.org/licenses/mit-license.php
|
||||
Author Tobias Koppers @sokra
|
||||
*/
|
||||
"use strict";
|
||||
|
||||
const Hook = require("./Hook");
|
||||
const HookCodeFactory = require("./HookCodeFactory");
|
||||
|
||||
class AsyncSeriesHookCodeFactory extends HookCodeFactory {
|
||||
content({ onError, onDone }) {
|
||||
return this.callTapsSeries({
|
||||
onError: (i, err, next, doneBreak) => onError(err) + doneBreak(true),
|
||||
onDone
|
||||
});
|
||||
}
|
||||
}
|
||||
|
||||
const factory = new AsyncSeriesHookCodeFactory();
|
||||
|
||||
const COMPILE = function(options) {
|
||||
factory.setup(this, options);
|
||||
return factory.create(options);
|
||||
};
|
||||
|
||||
function AsyncSeriesHook(args = [], name = undefined) {
|
||||
const hook = new Hook(args, name);
|
||||
hook.constructor = AsyncSeriesHook;
|
||||
hook.compile = COMPILE;
|
||||
hook._call = undefined;
|
||||
hook.call = undefined;
|
||||
return hook;
|
||||
}
|
||||
|
||||
AsyncSeriesHook.prototype = null;
|
||||
|
||||
module.exports = AsyncSeriesHook;
|
||||
|
|
@ -1,37 +0,0 @@
|
|||
/*
|
||||
MIT License http://www.opensource.org/licenses/mit-license.php
|
||||
Author Tobias Koppers @sokra
|
||||
*/
|
||||
"use strict";
|
||||
|
||||
const Hook = require("./Hook");
|
||||
const HookCodeFactory = require("./HookCodeFactory");
|
||||
|
||||
class AsyncSeriesLoopHookCodeFactory extends HookCodeFactory {
|
||||
content({ onError, onDone }) {
|
||||
return this.callTapsLooping({
|
||||
onError: (i, err, next, doneBreak) => onError(err) + doneBreak(true),
|
||||
onDone
|
||||
});
|
||||
}
|
||||
}
|
||||
|
||||
const factory = new AsyncSeriesLoopHookCodeFactory();
|
||||
|
||||
const COMPILE = function(options) {
|
||||
factory.setup(this, options);
|
||||
return factory.create(options);
|
||||
};
|
||||
|
||||
function AsyncSeriesLoopHook(args = [], name = undefined) {
|
||||
const hook = new Hook(args, name);
|
||||
hook.constructor = AsyncSeriesLoopHook;
|
||||
hook.compile = COMPILE;
|
||||
hook._call = undefined;
|
||||
hook.call = undefined;
|
||||
return hook;
|
||||
}
|
||||
|
||||
AsyncSeriesLoopHook.prototype = null;
|
||||
|
||||
module.exports = AsyncSeriesLoopHook;
|
||||
|
|
@ -1,47 +0,0 @@
|
|||
/*
|
||||
MIT License http://www.opensource.org/licenses/mit-license.php
|
||||
Author Tobias Koppers @sokra
|
||||
*/
|
||||
"use strict";
|
||||
|
||||
const Hook = require("./Hook");
|
||||
const HookCodeFactory = require("./HookCodeFactory");
|
||||
|
||||
class AsyncSeriesWaterfallHookCodeFactory extends HookCodeFactory {
|
||||
content({ onError, onResult, onDone }) {
|
||||
return this.callTapsSeries({
|
||||
onError: (i, err, next, doneBreak) => onError(err) + doneBreak(true),
|
||||
onResult: (i, result, next) => {
|
||||
let code = "";
|
||||
code += `if(${result} !== undefined) {\n`;
|
||||
code += `${this._args[0]} = ${result};\n`;
|
||||
code += `}\n`;
|
||||
code += next();
|
||||
return code;
|
||||
},
|
||||
onDone: () => onResult(this._args[0])
|
||||
});
|
||||
}
|
||||
}
|
||||
|
||||
const factory = new AsyncSeriesWaterfallHookCodeFactory();
|
||||
|
||||
const COMPILE = function(options) {
|
||||
factory.setup(this, options);
|
||||
return factory.create(options);
|
||||
};
|
||||
|
||||
function AsyncSeriesWaterfallHook(args = [], name = undefined) {
|
||||
if (args.length < 1)
|
||||
throw new Error("Waterfall hooks must have at least one argument");
|
||||
const hook = new Hook(args, name);
|
||||
hook.constructor = AsyncSeriesWaterfallHook;
|
||||
hook.compile = COMPILE;
|
||||
hook._call = undefined;
|
||||
hook.call = undefined;
|
||||
return hook;
|
||||
}
|
||||
|
||||
AsyncSeriesWaterfallHook.prototype = null;
|
||||
|
||||
module.exports = AsyncSeriesWaterfallHook;
|
||||
|
|
@ -1,175 +0,0 @@
|
|||
/*
|
||||
MIT License http://www.opensource.org/licenses/mit-license.php
|
||||
Author Tobias Koppers @sokra
|
||||
*/
|
||||
"use strict";
|
||||
|
||||
const util = require("util");
|
||||
|
||||
const deprecateContext = util.deprecate(() => {},
|
||||
"Hook.context is deprecated and will be removed");
|
||||
|
||||
const CALL_DELEGATE = function(...args) {
|
||||
this.call = this._createCall("sync");
|
||||
return this.call(...args);
|
||||
};
|
||||
const CALL_ASYNC_DELEGATE = function(...args) {
|
||||
this.callAsync = this._createCall("async");
|
||||
return this.callAsync(...args);
|
||||
};
|
||||
const PROMISE_DELEGATE = function(...args) {
|
||||
this.promise = this._createCall("promise");
|
||||
return this.promise(...args);
|
||||
};
|
||||
|
||||
class Hook {
|
||||
constructor(args = [], name = undefined) {
|
||||
this._args = args;
|
||||
this.name = name;
|
||||
this.taps = [];
|
||||
this.interceptors = [];
|
||||
this._call = CALL_DELEGATE;
|
||||
this.call = CALL_DELEGATE;
|
||||
this._callAsync = CALL_ASYNC_DELEGATE;
|
||||
this.callAsync = CALL_ASYNC_DELEGATE;
|
||||
this._promise = PROMISE_DELEGATE;
|
||||
this.promise = PROMISE_DELEGATE;
|
||||
this._x = undefined;
|
||||
|
||||
this.compile = this.compile;
|
||||
this.tap = this.tap;
|
||||
this.tapAsync = this.tapAsync;
|
||||
this.tapPromise = this.tapPromise;
|
||||
}
|
||||
|
||||
compile(options) {
|
||||
throw new Error("Abstract: should be overridden");
|
||||
}
|
||||
|
||||
_createCall(type) {
|
||||
return this.compile({
|
||||
taps: this.taps,
|
||||
interceptors: this.interceptors,
|
||||
args: this._args,
|
||||
type: type
|
||||
});
|
||||
}
|
||||
|
||||
_tap(type, options, fn) {
|
||||
if (typeof options === "string") {
|
||||
options = {
|
||||
name: options
|
||||
};
|
||||
} else if (typeof options !== "object" || options === null) {
|
||||
throw new Error("Invalid tap options");
|
||||
}
|
||||
if (typeof options.name !== "string" || options.name === "") {
|
||||
throw new Error("Missing name for tap");
|
||||
}
|
||||
if (typeof options.context !== "undefined") {
|
||||
deprecateContext();
|
||||
}
|
||||
options = Object.assign({ type, fn }, options);
|
||||
options = this._runRegisterInterceptors(options);
|
||||
this._insert(options);
|
||||
}
|
||||
|
||||
tap(options, fn) {
|
||||
this._tap("sync", options, fn);
|
||||
}
|
||||
|
||||
tapAsync(options, fn) {
|
||||
this._tap("async", options, fn);
|
||||
}
|
||||
|
||||
tapPromise(options, fn) {
|
||||
this._tap("promise", options, fn);
|
||||
}
|
||||
|
||||
_runRegisterInterceptors(options) {
|
||||
for (const interceptor of this.interceptors) {
|
||||
if (interceptor.register) {
|
||||
const newOptions = interceptor.register(options);
|
||||
if (newOptions !== undefined) {
|
||||
options = newOptions;
|
||||
}
|
||||
}
|
||||
}
|
||||
return options;
|
||||
}
|
||||
|
||||
withOptions(options) {
|
||||
const mergeOptions = opt =>
|
||||
Object.assign({}, options, typeof opt === "string" ? { name: opt } : opt);
|
||||
|
||||
return {
|
||||
name: this.name,
|
||||
tap: (opt, fn) => this.tap(mergeOptions(opt), fn),
|
||||
tapAsync: (opt, fn) => this.tapAsync(mergeOptions(opt), fn),
|
||||
tapPromise: (opt, fn) => this.tapPromise(mergeOptions(opt), fn),
|
||||
intercept: interceptor => this.intercept(interceptor),
|
||||
isUsed: () => this.isUsed(),
|
||||
withOptions: opt => this.withOptions(mergeOptions(opt))
|
||||
};
|
||||
}
|
||||
|
||||
isUsed() {
|
||||
return this.taps.length > 0 || this.interceptors.length > 0;
|
||||
}
|
||||
|
||||
intercept(interceptor) {
|
||||
this._resetCompilation();
|
||||
this.interceptors.push(Object.assign({}, interceptor));
|
||||
if (interceptor.register) {
|
||||
for (let i = 0; i < this.taps.length; i++) {
|
||||
this.taps[i] = interceptor.register(this.taps[i]);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
_resetCompilation() {
|
||||
this.call = this._call;
|
||||
this.callAsync = this._callAsync;
|
||||
this.promise = this._promise;
|
||||
}
|
||||
|
||||
_insert(item) {
|
||||
this._resetCompilation();
|
||||
let before;
|
||||
if (typeof item.before === "string") {
|
||||
before = new Set([item.before]);
|
||||
} else if (Array.isArray(item.before)) {
|
||||
before = new Set(item.before);
|
||||
}
|
||||
let stage = 0;
|
||||
if (typeof item.stage === "number") {
|
||||
stage = item.stage;
|
||||
}
|
||||
let i = this.taps.length;
|
||||
while (i > 0) {
|
||||
i--;
|
||||
const x = this.taps[i];
|
||||
this.taps[i + 1] = x;
|
||||
const xStage = x.stage || 0;
|
||||
if (before) {
|
||||
if (before.has(x.name)) {
|
||||
before.delete(x.name);
|
||||
continue;
|
||||
}
|
||||
if (before.size > 0) {
|
||||
continue;
|
||||
}
|
||||
}
|
||||
if (xStage > stage) {
|
||||
continue;
|
||||
}
|
||||
i++;
|
||||
break;
|
||||
}
|
||||
this.taps[i] = item;
|
||||
}
|
||||
}
|
||||
|
||||
Object.setPrototypeOf(Hook.prototype, null);
|
||||
|
||||
module.exports = Hook;
|
||||
|
|
@ -1,407 +0,0 @@
|
|||
/*
|
||||
MIT License http://www.opensource.org/licenses/mit-license.php
|
||||
Author Tobias Koppers @sokra
|
||||
*/
|
||||
"use strict";
|
||||
|
||||
class HookCodeFactory {
|
||||
constructor(config) {
|
||||
this.config = config;
|
||||
this.options = undefined;
|
||||
this._args = undefined;
|
||||
}
|
||||
|
||||
create(options) {
|
||||
this.init(options);
|
||||
let fn;
|
||||
switch (this.options.type) {
|
||||
case "sync":
|
||||
fn = new Function(
|
||||
this.args(),
|
||||
'"use strict";\n' +
|
||||
this.header() +
|
||||
this.content({
|
||||
onError: err => `throw ${err};\n`,
|
||||
onResult: result => `return ${result};\n`,
|
||||
resultReturns: true,
|
||||
onDone: () => "",
|
||||
rethrowIfPossible: true
|
||||
})
|
||||
);
|
||||
break;
|
||||
case "async":
|
||||
fn = new Function(
|
||||
this.args({
|
||||
after: "_callback"
|
||||
}),
|
||||
'"use strict";\n' +
|
||||
this.header() +
|
||||
this.content({
|
||||
onError: err => `_callback(${err});\n`,
|
||||
onResult: result => `_callback(null, ${result});\n`,
|
||||
onDone: () => "_callback();\n"
|
||||
})
|
||||
);
|
||||
break;
|
||||
case "promise":
|
||||
let errorHelperUsed = false;
|
||||
const content = this.content({
|
||||
onError: err => {
|
||||
errorHelperUsed = true;
|
||||
return `_error(${err});\n`;
|
||||
},
|
||||
onResult: result => `_resolve(${result});\n`,
|
||||
onDone: () => "_resolve();\n"
|
||||
});
|
||||
let code = "";
|
||||
code += '"use strict";\n';
|
||||
code += "return new Promise((_resolve, _reject) => {\n";
|
||||
if (errorHelperUsed) {
|
||||
code += "var _sync = true;\n";
|
||||
code += "function _error(_err) {\n";
|
||||
code += "if(_sync)\n";
|
||||
code += "_resolve(Promise.resolve().then(() => { throw _err; }));\n";
|
||||
code += "else\n";
|
||||
code += "_reject(_err);\n";
|
||||
code += "};\n";
|
||||
}
|
||||
code += this.header();
|
||||
code += content;
|
||||
if (errorHelperUsed) {
|
||||
code += "_sync = false;\n";
|
||||
}
|
||||
code += "});\n";
|
||||
fn = new Function(this.args(), code);
|
||||
break;
|
||||
}
|
||||
this.deinit();
|
||||
return fn;
|
||||
}
|
||||
|
||||
setup(instance, options) {
|
||||
instance._x = options.taps.map(t => t.fn);
|
||||
}
|
||||
|
||||
/**
|
||||
* @param {{ type: "sync" | "promise" | "async", taps: Array<Tap>, interceptors: Array<Interceptor> }} options
|
||||
*/
|
||||
init(options) {
|
||||
this.options = options;
|
||||
this._args = options.args.slice();
|
||||
}
|
||||
|
||||
deinit() {
|
||||
this.options = undefined;
|
||||
this._args = undefined;
|
||||
}
|
||||
|
||||
header() {
|
||||
let code = "";
|
||||
if (this.needContext()) {
|
||||
code += "var _context = {};\n";
|
||||
} else {
|
||||
code += "var _context;\n";
|
||||
}
|
||||
code += "var _x = this._x;\n";
|
||||
if (this.options.interceptors.length > 0) {
|
||||
code += "var _taps = this.taps;\n";
|
||||
code += "var _interceptors = this.interceptors;\n";
|
||||
}
|
||||
for (let i = 0; i < this.options.interceptors.length; i++) {
|
||||
const interceptor = this.options.interceptors[i];
|
||||
if (interceptor.call) {
|
||||
code += `${this.getInterceptor(i)}.call(${this.args({
|
||||
before: interceptor.context ? "_context" : undefined
|
||||
})});\n`;
|
||||
}
|
||||
}
|
||||
return code;
|
||||
}
|
||||
|
||||
needContext() {
|
||||
for (const tap of this.options.taps) if (tap.context) return true;
|
||||
return false;
|
||||
}
|
||||
|
||||
callTap(tapIndex, { onError, onResult, onDone, rethrowIfPossible }) {
|
||||
let code = "";
|
||||
let hasTapCached = false;
|
||||
for (let i = 0; i < this.options.interceptors.length; i++) {
|
||||
const interceptor = this.options.interceptors[i];
|
||||
if (interceptor.tap) {
|
||||
if (!hasTapCached) {
|
||||
code += `var _tap${tapIndex} = ${this.getTap(tapIndex)};\n`;
|
||||
hasTapCached = true;
|
||||
}
|
||||
code += `${this.getInterceptor(i)}.tap(${
|
||||
interceptor.context ? "_context, " : ""
|
||||
}_tap${tapIndex});\n`;
|
||||
}
|
||||
}
|
||||
code += `var _fn${tapIndex} = ${this.getTapFn(tapIndex)};\n`;
|
||||
const tap = this.options.taps[tapIndex];
|
||||
switch (tap.type) {
|
||||
case "sync":
|
||||
if (!rethrowIfPossible) {
|
||||
code += `var _hasError${tapIndex} = false;\n`;
|
||||
code += "try {\n";
|
||||
}
|
||||
if (onResult) {
|
||||
code += `var _result${tapIndex} = _fn${tapIndex}(${this.args({
|
||||
before: tap.context ? "_context" : undefined
|
||||
})});\n`;
|
||||
} else {
|
||||
code += `_fn${tapIndex}(${this.args({
|
||||
before: tap.context ? "_context" : undefined
|
||||
})});\n`;
|
||||
}
|
||||
if (!rethrowIfPossible) {
|
||||
code += "} catch(_err) {\n";
|
||||
code += `_hasError${tapIndex} = true;\n`;
|
||||
code += onError("_err");
|
||||
code += "}\n";
|
||||
code += `if(!_hasError${tapIndex}) {\n`;
|
||||
}
|
||||
if (onResult) {
|
||||
code += onResult(`_result${tapIndex}`);
|
||||
}
|
||||
if (onDone) {
|
||||
code += onDone();
|
||||
}
|
||||
if (!rethrowIfPossible) {
|
||||
code += "}\n";
|
||||
}
|
||||
break;
|
||||
case "async":
|
||||
let cbCode = "";
|
||||
if (onResult) cbCode += `(_err${tapIndex}, _result${tapIndex}) => {\n`;
|
||||
else cbCode += `_err${tapIndex} => {\n`;
|
||||
cbCode += `if(_err${tapIndex}) {\n`;
|
||||
cbCode += onError(`_err${tapIndex}`);
|
||||
cbCode += "} else {\n";
|
||||
if (onResult) {
|
||||
cbCode += onResult(`_result${tapIndex}`);
|
||||
}
|
||||
if (onDone) {
|
||||
cbCode += onDone();
|
||||
}
|
||||
cbCode += "}\n";
|
||||
cbCode += "}";
|
||||
code += `_fn${tapIndex}(${this.args({
|
||||
before: tap.context ? "_context" : undefined,
|
||||
after: cbCode
|
||||
})});\n`;
|
||||
break;
|
||||
case "promise":
|
||||
code += `var _hasResult${tapIndex} = false;\n`;
|
||||
code += `var _promise${tapIndex} = _fn${tapIndex}(${this.args({
|
||||
before: tap.context ? "_context" : undefined
|
||||
})});\n`;
|
||||
code += `if (!_promise${tapIndex} || !_promise${tapIndex}.then)\n`;
|
||||
code += ` throw new Error('Tap function (tapPromise) did not return promise (returned ' + _promise${tapIndex} + ')');\n`;
|
||||
code += `_promise${tapIndex}.then(_result${tapIndex} => {\n`;
|
||||
code += `_hasResult${tapIndex} = true;\n`;
|
||||
if (onResult) {
|
||||
code += onResult(`_result${tapIndex}`);
|
||||
}
|
||||
if (onDone) {
|
||||
code += onDone();
|
||||
}
|
||||
code += `}, _err${tapIndex} => {\n`;
|
||||
code += `if(_hasResult${tapIndex}) throw _err${tapIndex};\n`;
|
||||
code += onError(`_err${tapIndex}`);
|
||||
code += "});\n";
|
||||
break;
|
||||
}
|
||||
return code;
|
||||
}
|
||||
|
||||
callTapsSeries({
|
||||
onError,
|
||||
onResult,
|
||||
resultReturns,
|
||||
onDone,
|
||||
doneReturns,
|
||||
rethrowIfPossible
|
||||
}) {
|
||||
if (this.options.taps.length === 0) return onDone();
|
||||
const firstAsync = this.options.taps.findIndex(t => t.type !== "sync");
|
||||
const somethingReturns = resultReturns || doneReturns || false;
|
||||
let code = "";
|
||||
let current = onDone;
|
||||
for (let j = this.options.taps.length - 1; j >= 0; j--) {
|
||||
const i = j;
|
||||
const unroll = current !== onDone && this.options.taps[i].type !== "sync";
|
||||
if (unroll) {
|
||||
code += `function _next${i}() {\n`;
|
||||
code += current();
|
||||
code += `}\n`;
|
||||
current = () => `${somethingReturns ? "return " : ""}_next${i}();\n`;
|
||||
}
|
||||
const done = current;
|
||||
const doneBreak = skipDone => {
|
||||
if (skipDone) return "";
|
||||
return onDone();
|
||||
};
|
||||
const content = this.callTap(i, {
|
||||
onError: error => onError(i, error, done, doneBreak),
|
||||
onResult:
|
||||
onResult &&
|
||||
(result => {
|
||||
return onResult(i, result, done, doneBreak);
|
||||
}),
|
||||
onDone: !onResult && done,
|
||||
rethrowIfPossible:
|
||||
rethrowIfPossible && (firstAsync < 0 || i < firstAsync)
|
||||
});
|
||||
current = () => content;
|
||||
}
|
||||
code += current();
|
||||
return code;
|
||||
}
|
||||
|
||||
callTapsLooping({ onError, onDone, rethrowIfPossible }) {
|
||||
if (this.options.taps.length === 0) return onDone();
|
||||
const syncOnly = this.options.taps.every(t => t.type === "sync");
|
||||
let code = "";
|
||||
if (!syncOnly) {
|
||||
code += "var _looper = () => {\n";
|
||||
code += "var _loopAsync = false;\n";
|
||||
}
|
||||
code += "var _loop;\n";
|
||||
code += "do {\n";
|
||||
code += "_loop = false;\n";
|
||||
for (let i = 0; i < this.options.interceptors.length; i++) {
|
||||
const interceptor = this.options.interceptors[i];
|
||||
if (interceptor.loop) {
|
||||
code += `${this.getInterceptor(i)}.loop(${this.args({
|
||||
before: interceptor.context ? "_context" : undefined
|
||||
})});\n`;
|
||||
}
|
||||
}
|
||||
code += this.callTapsSeries({
|
||||
onError,
|
||||
onResult: (i, result, next, doneBreak) => {
|
||||
let code = "";
|
||||
code += `if(${result} !== undefined) {\n`;
|
||||
code += "_loop = true;\n";
|
||||
if (!syncOnly) code += "if(_loopAsync) _looper();\n";
|
||||
code += doneBreak(true);
|
||||
code += `} else {\n`;
|
||||
code += next();
|
||||
code += `}\n`;
|
||||
return code;
|
||||
},
|
||||
onDone:
|
||||
onDone &&
|
||||
(() => {
|
||||
let code = "";
|
||||
code += "if(!_loop) {\n";
|
||||
code += onDone();
|
||||
code += "}\n";
|
||||
return code;
|
||||
}),
|
||||
rethrowIfPossible: rethrowIfPossible && syncOnly
|
||||
});
|
||||
code += "} while(_loop);\n";
|
||||
if (!syncOnly) {
|
||||
code += "_loopAsync = true;\n";
|
||||
code += "};\n";
|
||||
code += "_looper();\n";
|
||||
}
|
||||
return code;
|
||||
}
|
||||
|
||||
callTapsParallel({
|
||||
onError,
|
||||
onResult,
|
||||
onDone,
|
||||
rethrowIfPossible,
|
||||
onTap = (i, run) => run()
|
||||
}) {
|
||||
if (this.options.taps.length <= 1) {
|
||||
return this.callTapsSeries({
|
||||
onError,
|
||||
onResult,
|
||||
onDone,
|
||||
rethrowIfPossible
|
||||
});
|
||||
}
|
||||
let code = "";
|
||||
code += "do {\n";
|
||||
code += `var _counter = ${this.options.taps.length};\n`;
|
||||
if (onDone) {
|
||||
code += "var _done = () => {\n";
|
||||
code += onDone();
|
||||
code += "};\n";
|
||||
}
|
||||
for (let i = 0; i < this.options.taps.length; i++) {
|
||||
const done = () => {
|
||||
if (onDone) return "if(--_counter === 0) _done();\n";
|
||||
else return "--_counter;";
|
||||
};
|
||||
const doneBreak = skipDone => {
|
||||
if (skipDone || !onDone) return "_counter = 0;\n";
|
||||
else return "_counter = 0;\n_done();\n";
|
||||
};
|
||||
code += "if(_counter <= 0) break;\n";
|
||||
code += onTap(
|
||||
i,
|
||||
() =>
|
||||
this.callTap(i, {
|
||||
onError: error => {
|
||||
let code = "";
|
||||
code += "if(_counter > 0) {\n";
|
||||
code += onError(i, error, done, doneBreak);
|
||||
code += "}\n";
|
||||
return code;
|
||||
},
|
||||
onResult:
|
||||
onResult &&
|
||||
(result => {
|
||||
let code = "";
|
||||
code += "if(_counter > 0) {\n";
|
||||
code += onResult(i, result, done, doneBreak);
|
||||
code += "}\n";
|
||||
return code;
|
||||
}),
|
||||
onDone:
|
||||
!onResult &&
|
||||
(() => {
|
||||
return done();
|
||||
}),
|
||||
rethrowIfPossible
|
||||
}),
|
||||
done,
|
||||
doneBreak
|
||||
);
|
||||
}
|
||||
code += "} while(false);\n";
|
||||
return code;
|
||||
}
|
||||
|
||||
args({ before, after } = {}) {
|
||||
let allArgs = this._args;
|
||||
if (before) allArgs = [before].concat(allArgs);
|
||||
if (after) allArgs = allArgs.concat(after);
|
||||
if (allArgs.length === 0) {
|
||||
return "";
|
||||
} else {
|
||||
return allArgs.join(", ");
|
||||
}
|
||||
}
|
||||
|
||||
getTapFn(idx) {
|
||||
return `_x[${idx}]`;
|
||||
}
|
||||
|
||||
getTap(idx) {
|
||||
return `_taps[${idx}]`;
|
||||
}
|
||||
|
||||
getInterceptor(idx) {
|
||||
return `_interceptors[${idx}]`;
|
||||
}
|
||||
}
|
||||
|
||||
module.exports = HookCodeFactory;
|
||||
|
|
@ -1,61 +0,0 @@
|
|||
/*
|
||||
MIT License http://www.opensource.org/licenses/mit-license.php
|
||||
Author Tobias Koppers @sokra
|
||||
*/
|
||||
"use strict";
|
||||
|
||||
const util = require("util");
|
||||
|
||||
const defaultFactory = (key, hook) => hook;
|
||||
|
||||
class HookMap {
|
||||
constructor(factory, name = undefined) {
|
||||
this._map = new Map();
|
||||
this.name = name;
|
||||
this._factory = factory;
|
||||
this._interceptors = [];
|
||||
}
|
||||
|
||||
get(key) {
|
||||
return this._map.get(key);
|
||||
}
|
||||
|
||||
for(key) {
|
||||
const hook = this.get(key);
|
||||
if (hook !== undefined) {
|
||||
return hook;
|
||||
}
|
||||
let newHook = this._factory(key);
|
||||
const interceptors = this._interceptors;
|
||||
for (let i = 0; i < interceptors.length; i++) {
|
||||
newHook = interceptors[i].factory(key, newHook);
|
||||
}
|
||||
this._map.set(key, newHook);
|
||||
return newHook;
|
||||
}
|
||||
|
||||
intercept(interceptor) {
|
||||
this._interceptors.push(
|
||||
Object.assign(
|
||||
{
|
||||
factory: defaultFactory
|
||||
},
|
||||
interceptor
|
||||
)
|
||||
);
|
||||
}
|
||||
}
|
||||
|
||||
HookMap.prototype.tap = util.deprecate(function(key, options, fn) {
|
||||
return this.for(key).tap(options, fn);
|
||||
}, "HookMap#tap(key,…) is deprecated. Use HookMap#for(key).tap(…) instead.");
|
||||
|
||||
HookMap.prototype.tapAsync = util.deprecate(function(key, options, fn) {
|
||||
return this.for(key).tapAsync(options, fn);
|
||||
}, "HookMap#tapAsync(key,…) is deprecated. Use HookMap#for(key).tapAsync(…) instead.");
|
||||
|
||||
HookMap.prototype.tapPromise = util.deprecate(function(key, options, fn) {
|
||||
return this.for(key).tapPromise(options, fn);
|
||||
}, "HookMap#tapPromise(key,…) is deprecated. Use HookMap#for(key).tapPromise(…) instead.");
|
||||
|
||||
module.exports = HookMap;
|
||||
|
|
@ -1,54 +0,0 @@
|
|||
/*
|
||||
MIT License http://www.opensource.org/licenses/mit-license.php
|
||||
Author Tobias Koppers @sokra
|
||||
*/
|
||||
"use strict";
|
||||
|
||||
const Hook = require("./Hook");
|
||||
|
||||
class MultiHook {
|
||||
constructor(hooks, name = undefined) {
|
||||
this.hooks = hooks;
|
||||
this.name = name;
|
||||
}
|
||||
|
||||
tap(options, fn) {
|
||||
for (const hook of this.hooks) {
|
||||
hook.tap(options, fn);
|
||||
}
|
||||
}
|
||||
|
||||
tapAsync(options, fn) {
|
||||
for (const hook of this.hooks) {
|
||||
hook.tapAsync(options, fn);
|
||||
}
|
||||
}
|
||||
|
||||
tapPromise(options, fn) {
|
||||
for (const hook of this.hooks) {
|
||||
hook.tapPromise(options, fn);
|
||||
}
|
||||
}
|
||||
|
||||
isUsed() {
|
||||
for (const hook of this.hooks) {
|
||||
if (hook.isUsed()) return true;
|
||||
}
|
||||
return false;
|
||||
}
|
||||
|
||||
intercept(interceptor) {
|
||||
for (const hook of this.hooks) {
|
||||
hook.intercept(interceptor);
|
||||
}
|
||||
}
|
||||
|
||||
withOptions(options) {
|
||||
return new MultiHook(
|
||||
this.hooks.map(h => h.withOptions(options)),
|
||||
this.name
|
||||
);
|
||||
}
|
||||
}
|
||||
|
||||
module.exports = MultiHook;
|
||||
|
|
@ -1,51 +0,0 @@
|
|||
/*
|
||||
MIT License http://www.opensource.org/licenses/mit-license.php
|
||||
Author Tobias Koppers @sokra
|
||||
*/
|
||||
"use strict";
|
||||
|
||||
const Hook = require("./Hook");
|
||||
const HookCodeFactory = require("./HookCodeFactory");
|
||||
|
||||
class SyncBailHookCodeFactory extends HookCodeFactory {
|
||||
content({ onError, onResult, resultReturns, onDone, rethrowIfPossible }) {
|
||||
return this.callTapsSeries({
|
||||
onError: (i, err) => onError(err),
|
||||
onResult: (i, result, next) =>
|
||||
`if(${result} !== undefined) {\n${onResult(
|
||||
result
|
||||
)};\n} else {\n${next()}}\n`,
|
||||
resultReturns,
|
||||
onDone,
|
||||
rethrowIfPossible
|
||||
});
|
||||
}
|
||||
}
|
||||
|
||||
const factory = new SyncBailHookCodeFactory();
|
||||
|
||||
const TAP_ASYNC = () => {
|
||||
throw new Error("tapAsync is not supported on a SyncBailHook");
|
||||
};
|
||||
|
||||
const TAP_PROMISE = () => {
|
||||
throw new Error("tapPromise is not supported on a SyncBailHook");
|
||||
};
|
||||
|
||||
const COMPILE = function(options) {
|
||||
factory.setup(this, options);
|
||||
return factory.create(options);
|
||||
};
|
||||
|
||||
function SyncBailHook(args = [], name = undefined) {
|
||||
const hook = new Hook(args, name);
|
||||
hook.constructor = SyncBailHook;
|
||||
hook.tapAsync = TAP_ASYNC;
|
||||
hook.tapPromise = TAP_PROMISE;
|
||||
hook.compile = COMPILE;
|
||||
return hook;
|
||||
}
|
||||
|
||||
SyncBailHook.prototype = null;
|
||||
|
||||
module.exports = SyncBailHook;
|
||||
|
|
@ -1,46 +0,0 @@
|
|||
/*
|
||||
MIT License http://www.opensource.org/licenses/mit-license.php
|
||||
Author Tobias Koppers @sokra
|
||||
*/
|
||||
"use strict";
|
||||
|
||||
const Hook = require("./Hook");
|
||||
const HookCodeFactory = require("./HookCodeFactory");
|
||||
|
||||
class SyncHookCodeFactory extends HookCodeFactory {
|
||||
content({ onError, onDone, rethrowIfPossible }) {
|
||||
return this.callTapsSeries({
|
||||
onError: (i, err) => onError(err),
|
||||
onDone,
|
||||
rethrowIfPossible
|
||||
});
|
||||
}
|
||||
}
|
||||
|
||||
const factory = new SyncHookCodeFactory();
|
||||
|
||||
const TAP_ASYNC = () => {
|
||||
throw new Error("tapAsync is not supported on a SyncHook");
|
||||
};
|
||||
|
||||
const TAP_PROMISE = () => {
|
||||
throw new Error("tapPromise is not supported on a SyncHook");
|
||||
};
|
||||
|
||||
const COMPILE = function(options) {
|
||||
factory.setup(this, options);
|
||||
return factory.create(options);
|
||||
};
|
||||
|
||||
function SyncHook(args = [], name = undefined) {
|
||||
const hook = new Hook(args, name);
|
||||
hook.constructor = SyncHook;
|
||||
hook.tapAsync = TAP_ASYNC;
|
||||
hook.tapPromise = TAP_PROMISE;
|
||||
hook.compile = COMPILE;
|
||||
return hook;
|
||||
}
|
||||
|
||||
SyncHook.prototype = null;
|
||||
|
||||
module.exports = SyncHook;
|
||||
|
|
@ -1,46 +0,0 @@
|
|||
/*
|
||||
MIT License http://www.opensource.org/licenses/mit-license.php
|
||||
Author Tobias Koppers @sokra
|
||||
*/
|
||||
"use strict";
|
||||
|
||||
const Hook = require("./Hook");
|
||||
const HookCodeFactory = require("./HookCodeFactory");
|
||||
|
||||
class SyncLoopHookCodeFactory extends HookCodeFactory {
|
||||
content({ onError, onDone, rethrowIfPossible }) {
|
||||
return this.callTapsLooping({
|
||||
onError: (i, err) => onError(err),
|
||||
onDone,
|
||||
rethrowIfPossible
|
||||
});
|
||||
}
|
||||
}
|
||||
|
||||
const factory = new SyncLoopHookCodeFactory();
|
||||
|
||||
const TAP_ASYNC = () => {
|
||||
throw new Error("tapAsync is not supported on a SyncLoopHook");
|
||||
};
|
||||
|
||||
const TAP_PROMISE = () => {
|
||||
throw new Error("tapPromise is not supported on a SyncLoopHook");
|
||||
};
|
||||
|
||||
const COMPILE = function(options) {
|
||||
factory.setup(this, options);
|
||||
return factory.create(options);
|
||||
};
|
||||
|
||||
function SyncLoopHook(args = [], name = undefined) {
|
||||
const hook = new Hook(args, name);
|
||||
hook.constructor = SyncLoopHook;
|
||||
hook.tapAsync = TAP_ASYNC;
|
||||
hook.tapPromise = TAP_PROMISE;
|
||||
hook.compile = COMPILE;
|
||||
return hook;
|
||||
}
|
||||
|
||||
SyncLoopHook.prototype = null;
|
||||
|
||||
module.exports = SyncLoopHook;
|
||||
|
|
@ -1,57 +0,0 @@
|
|||
/*
|
||||
MIT License http://www.opensource.org/licenses/mit-license.php
|
||||
Author Tobias Koppers @sokra
|
||||
*/
|
||||
"use strict";
|
||||
|
||||
const Hook = require("./Hook");
|
||||
const HookCodeFactory = require("./HookCodeFactory");
|
||||
|
||||
class SyncWaterfallHookCodeFactory extends HookCodeFactory {
|
||||
content({ onError, onResult, resultReturns, rethrowIfPossible }) {
|
||||
return this.callTapsSeries({
|
||||
onError: (i, err) => onError(err),
|
||||
onResult: (i, result, next) => {
|
||||
let code = "";
|
||||
code += `if(${result} !== undefined) {\n`;
|
||||
code += `${this._args[0]} = ${result};\n`;
|
||||
code += `}\n`;
|
||||
code += next();
|
||||
return code;
|
||||
},
|
||||
onDone: () => onResult(this._args[0]),
|
||||
doneReturns: resultReturns,
|
||||
rethrowIfPossible
|
||||
});
|
||||
}
|
||||
}
|
||||
|
||||
const factory = new SyncWaterfallHookCodeFactory();
|
||||
|
||||
const TAP_ASYNC = () => {
|
||||
throw new Error("tapAsync is not supported on a SyncWaterfallHook");
|
||||
};
|
||||
|
||||
const TAP_PROMISE = () => {
|
||||
throw new Error("tapPromise is not supported on a SyncWaterfallHook");
|
||||
};
|
||||
|
||||
const COMPILE = function(options) {
|
||||
factory.setup(this, options);
|
||||
return factory.create(options);
|
||||
};
|
||||
|
||||
function SyncWaterfallHook(args = [], name = undefined) {
|
||||
if (args.length < 1)
|
||||
throw new Error("Waterfall hooks must have at least one argument");
|
||||
const hook = new Hook(args, name);
|
||||
hook.constructor = SyncWaterfallHook;
|
||||
hook.tapAsync = TAP_ASYNC;
|
||||
hook.tapPromise = TAP_PROMISE;
|
||||
hook.compile = COMPILE;
|
||||
return hook;
|
||||
}
|
||||
|
||||
SyncWaterfallHook.prototype = null;
|
||||
|
||||
module.exports = SyncWaterfallHook;
|
||||
|
|
@ -1,19 +0,0 @@
|
|||
/*
|
||||
MIT License http://www.opensource.org/licenses/mit-license.php
|
||||
Author Tobias Koppers @sokra
|
||||
*/
|
||||
"use strict";
|
||||
|
||||
exports.__esModule = true;
|
||||
exports.SyncHook = require("./SyncHook");
|
||||
exports.SyncBailHook = require("./SyncBailHook");
|
||||
exports.SyncWaterfallHook = require("./SyncWaterfallHook");
|
||||
exports.SyncLoopHook = require("./SyncLoopHook");
|
||||
exports.AsyncParallelHook = require("./AsyncParallelHook");
|
||||
exports.AsyncParallelBailHook = require("./AsyncParallelBailHook");
|
||||
exports.AsyncSeriesHook = require("./AsyncSeriesHook");
|
||||
exports.AsyncSeriesBailHook = require("./AsyncSeriesBailHook");
|
||||
exports.AsyncSeriesLoopHook = require("./AsyncSeriesLoopHook");
|
||||
exports.AsyncSeriesWaterfallHook = require("./AsyncSeriesWaterfallHook");
|
||||
exports.HookMap = require("./HookMap");
|
||||
exports.MultiHook = require("./MultiHook");
|
||||
|
|
@ -1,41 +0,0 @@
|
|||
{
|
||||
"name": "tapable",
|
||||
"version": "2.0.0-beta.8",
|
||||
"author": "Tobias Koppers @sokra",
|
||||
"description": "Just a little module for plugins.",
|
||||
"license": "MIT",
|
||||
"homepage": "https://github.com/webpack/tapable",
|
||||
"repository": {
|
||||
"type": "git",
|
||||
"url": "http://github.com/webpack/tapable.git"
|
||||
},
|
||||
"devDependencies": {
|
||||
"@babel/core": "^7.4.4",
|
||||
"@babel/preset-env": "^7.4.4",
|
||||
"babel-jest": "^24.8.0",
|
||||
"codecov": "^3.5.0",
|
||||
"jest": "^24.8.0",
|
||||
"prettier": "^1.17.1"
|
||||
},
|
||||
"engines": {
|
||||
"node": ">=6"
|
||||
},
|
||||
"files": [
|
||||
"lib",
|
||||
"!lib/__tests__",
|
||||
"tapable.d.ts"
|
||||
],
|
||||
"main": "lib/index.js",
|
||||
"types": "./tapable.d.ts",
|
||||
"scripts": {
|
||||
"test": "jest",
|
||||
"travis": "yarn pretty-lint && jest --coverage && codecov",
|
||||
"pretty-lint": "prettier --check lib/*.js lib/__tests__/*.js",
|
||||
"pretty": "prettier --loglevel warn --write lib/*.js lib/__tests__/*.js"
|
||||
},
|
||||
"jest": {
|
||||
"transform": {
|
||||
"__tests__[\\\\/].+\\.js$": "babel-jest"
|
||||
}
|
||||
}
|
||||
}
|
||||
|
|
@ -1,101 +0,0 @@
|
|||
type FixedSizeArray<T extends number, U> = T extends 0
|
||||
? void[]
|
||||
: ReadonlyArray<U> & {
|
||||
0: U;
|
||||
length: T;
|
||||
};
|
||||
type Measure<T extends number> = T extends 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8
|
||||
? T
|
||||
: never;
|
||||
type Append<T extends any[], U> = {
|
||||
0: [U];
|
||||
1: [T[0], U];
|
||||
2: [T[0], T[1], U];
|
||||
3: [T[0], T[1], T[2], U];
|
||||
4: [T[0], T[1], T[2], T[3], U];
|
||||
5: [T[0], T[1], T[2], T[3], T[4], U];
|
||||
6: [T[0], T[1], T[2], T[3], T[4], T[5], U];
|
||||
7: [T[0], T[1], T[2], T[3], T[4], T[5], T[6], U];
|
||||
8: [T[0], T[1], T[2], T[3], T[4], T[5], T[6], T[7], U];
|
||||
}[Measure<T["length"]>];
|
||||
type AsArray<T> = T extends any[] ? T : [T];
|
||||
|
||||
type Callback<E, T> = (error?: E, result?: T) => void;
|
||||
|
||||
type Tap = TapOptions & {
|
||||
name: string;
|
||||
};
|
||||
|
||||
type TapOptions = {
|
||||
before?: string;
|
||||
stage?: number;
|
||||
};
|
||||
|
||||
interface HookInterceptor<H> {
|
||||
name?: string;
|
||||
tap?: (tap: Tap) => void;
|
||||
call?: (...args: any[]) => void;
|
||||
loop?: (...args: any[]) => void;
|
||||
register?: (hook: H) => H;
|
||||
}
|
||||
|
||||
type ArgumentNames<T extends any[]> = FixedSizeArray<T["length"], string>;
|
||||
|
||||
declare class Hook<T, R> {
|
||||
constructor(args?: ArgumentNames<AsArray<T>>, name?: string);
|
||||
name: string | undefined;
|
||||
intercept(interceptor: HookInterceptor<Hook<T, R>>): void;
|
||||
isUsed(): boolean;
|
||||
callAsync(...args: Append<AsArray<T>, Callback<Error, R>>): void;
|
||||
promise(...args: AsArray<T>): Promise<R>;
|
||||
tap(options: string | Tap, fn: (...args: AsArray<T>) => R): void;
|
||||
withOptions(options: TapOptions): Hook<T, R>;
|
||||
}
|
||||
|
||||
export class SyncHook<T, R = void> extends Hook<T, R> {
|
||||
call(...args: AsArray<T>): R;
|
||||
}
|
||||
|
||||
export class SyncBailHook<T, R> extends SyncHook<T, R> {}
|
||||
export class SyncLoopHook<T> extends SyncHook<T, void> {}
|
||||
export class SyncWaterfallHook<T> extends SyncHook<T, AsArray<T>[0]> {}
|
||||
|
||||
declare class AsyncHook<T, R> extends Hook<T, R> {
|
||||
tapAsync(
|
||||
options: string | Tap,
|
||||
fn: (...args: Append<AsArray<T>, Callback<Error, R>>) => void
|
||||
): void;
|
||||
tapPromise(
|
||||
options: string | Tap,
|
||||
fn: (...args: AsArray<T>) => Promise<R>
|
||||
): void;
|
||||
}
|
||||
|
||||
export class AsyncParallelHook<T> extends AsyncHook<T, void> {}
|
||||
export class AsyncParallelBailHook<T, R> extends AsyncHook<T, R> {}
|
||||
export class AsyncSeriesHook<T> extends AsyncHook<T, void> {}
|
||||
export class AsyncSeriesBailHook<T, R> extends AsyncHook<T, R> {}
|
||||
export class AsyncSeriesLoopHook<T> extends AsyncHook<T, void> {}
|
||||
export class AsyncSeriesWaterfallHook<T> extends AsyncHook<T, AsArray<T>[0]> {}
|
||||
|
||||
type HookFactory<H> = (key: any, hook?: H) => H;
|
||||
|
||||
interface HookMapInterceptor<H> {
|
||||
factory?: HookFactory<H>;
|
||||
}
|
||||
|
||||
export class HookMap<H> {
|
||||
constructor(factory: HookFactory<H>, name?: string);
|
||||
name: string | undefined;
|
||||
get(key: any): H | undefined;
|
||||
for(key: any): H;
|
||||
intercept(interceptor: HookMapInterceptor<H>): void;
|
||||
}
|
||||
|
||||
export class MultiHook<H> {
|
||||
constructor(hooks: H[], name?: string);
|
||||
name: string | undefined;
|
||||
tap(options: string | Tap, fn?: Function): void;
|
||||
tapAsync(options: string | Tap, fn?: Function): void;
|
||||
tapPromise(options: string | Tap, fn?: Function): void;
|
||||
}
|
||||
|
|
@ -1 +0,0 @@
|
|||
../../../../node_modules/d3-dsv/bin/dsv2json
|
||||
|
|
@ -1 +0,0 @@
|
|||
../../../../node_modules/d3-dsv/bin/dsv2dsv
|
||||
|
|
@ -1 +0,0 @@
|
|||
../../../../node_modules/d3-dsv/bin/dsv2dsv
|
||||
|
|
@ -1 +0,0 @@
|
|||
../../../../node_modules/d3-dsv/bin/dsv2json
|
||||
|
|
@ -1 +0,0 @@
|
|||
../../../../node_modules/@mapbox/geojson-rewind/geojson-rewind
|
||||
|
|
@ -1 +0,0 @@
|
|||
../../../../node_modules/d3-dsv/bin/json2dsv
|
||||
|
|
@ -1 +0,0 @@
|
|||
../../../../node_modules/d3-dsv/bin/json2dsv
|
||||
|
|
@ -1 +0,0 @@
|
|||
../../../../node_modules/d3-dsv/bin/json2dsv
|
||||
|
|
@ -1 +0,0 @@
|
|||
../../../../node_modules/d3-dsv/bin/dsv2dsv
|
||||
|
|
@ -1 +0,0 @@
|
|||
../../../../node_modules/d3-dsv/bin/dsv2json
|
||||
|
|
@ -1,21 +0,0 @@
|
|||
The MIT License
|
||||
|
||||
Copyright JS Foundation and other contributors
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
of this software and associated documentation files (the "Software"), to deal
|
||||
in the Software without restriction, including without limitation the rights
|
||||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||
copies of the Software, and to permit persons to whom the Software is
|
||||
furnished to do so, subject to the following conditions:
|
||||
|
||||
The above copyright notice and this permission notice shall be included in
|
||||
all copies or substantial portions of the Software.
|
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
|
||||
THE SOFTWARE.
|
||||
|
|
@ -1,298 +0,0 @@
|
|||
# Tapable
|
||||
|
||||
The tapable package expose many Hook classes, which can be used to create hooks for plugins.
|
||||
|
||||
``` javascript
|
||||
const {
|
||||
SyncHook,
|
||||
SyncBailHook,
|
||||
SyncWaterfallHook,
|
||||
SyncLoopHook,
|
||||
AsyncParallelHook,
|
||||
AsyncParallelBailHook,
|
||||
AsyncSeriesHook,
|
||||
AsyncSeriesBailHook,
|
||||
AsyncSeriesWaterfallHook
|
||||
} = require("tapable");
|
||||
```
|
||||
|
||||
## Installation
|
||||
|
||||
``` shell
|
||||
npm install --save tapable
|
||||
```
|
||||
|
||||
## Usage
|
||||
|
||||
All Hook constructors take one optional argument, which is a list of argument names as strings.
|
||||
|
||||
``` js
|
||||
const hook = new SyncHook(["arg1", "arg2", "arg3"]);
|
||||
```
|
||||
|
||||
The best practice is to expose all hooks of a class in a `hooks` property:
|
||||
|
||||
``` js
|
||||
class Car {
|
||||
constructor() {
|
||||
this.hooks = {
|
||||
accelerate: new SyncHook(["newSpeed"]),
|
||||
brake: new SyncHook(),
|
||||
calculateRoutes: new AsyncParallelHook(["source", "target", "routesList"])
|
||||
};
|
||||
}
|
||||
|
||||
/* ... */
|
||||
}
|
||||
```
|
||||
|
||||
Other people can now use these hooks:
|
||||
|
||||
``` js
|
||||
const myCar = new Car();
|
||||
|
||||
// Use the tap method to add a consument
|
||||
myCar.hooks.brake.tap("WarningLampPlugin", () => warningLamp.on());
|
||||
```
|
||||
|
||||
It's required to pass a name to identify the plugin/reason.
|
||||
|
||||
You may receive arguments:
|
||||
|
||||
``` js
|
||||
myCar.hooks.accelerate.tap("LoggerPlugin", newSpeed => console.log(`Accelerating to ${newSpeed}`));
|
||||
```
|
||||
|
||||
For sync hooks, `tap` is the only valid method to add a plugin. Async hooks also support async plugins:
|
||||
|
||||
``` js
|
||||
myCar.hooks.calculateRoutes.tapPromise("GoogleMapsPlugin", (source, target, routesList) => {
|
||||
// return a promise
|
||||
return google.maps.findRoute(source, target).then(route => {
|
||||
routesList.add(route);
|
||||
});
|
||||
});
|
||||
myCar.hooks.calculateRoutes.tapAsync("BingMapsPlugin", (source, target, routesList, callback) => {
|
||||
bing.findRoute(source, target, (err, route) => {
|
||||
if(err) return callback(err);
|
||||
routesList.add(route);
|
||||
// call the callback
|
||||
callback();
|
||||
});
|
||||
});
|
||||
|
||||
// You can still use sync plugins
|
||||
myCar.hooks.calculateRoutes.tap("CachedRoutesPlugin", (source, target, routesList) => {
|
||||
const cachedRoute = cache.get(source, target);
|
||||
if(cachedRoute)
|
||||
routesList.add(cachedRoute);
|
||||
})
|
||||
```
|
||||
The class declaring these hooks need to call them:
|
||||
|
||||
``` js
|
||||
class Car {
|
||||
/**
|
||||
* You won't get returned value from SyncHook or AsyncParallelHook,
|
||||
* to do that, use SyncWaterfallHook and AsyncSeriesWaterfallHook respectively
|
||||
**/
|
||||
|
||||
setSpeed(newSpeed) {
|
||||
// following call returns undefined even when you returned values
|
||||
this.hooks.accelerate.call(newSpeed);
|
||||
}
|
||||
|
||||
useNavigationSystemPromise(source, target) {
|
||||
const routesList = new List();
|
||||
return this.hooks.calculateRoutes.promise(source, target, routesList).then((res) => {
|
||||
// res is undefined for AsyncParallelHook
|
||||
return routesList.getRoutes();
|
||||
});
|
||||
}
|
||||
|
||||
useNavigationSystemAsync(source, target, callback) {
|
||||
const routesList = new List();
|
||||
this.hooks.calculateRoutes.callAsync(source, target, routesList, err => {
|
||||
if(err) return callback(err);
|
||||
callback(null, routesList.getRoutes());
|
||||
});
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
The Hook will compile a method with the most efficient way of running your plugins. It generates code depending on:
|
||||
* The number of registered plugins (none, one, many)
|
||||
* The kind of registered plugins (sync, async, promise)
|
||||
* The used call method (sync, async, promise)
|
||||
* The number of arguments
|
||||
* Whether interception is used
|
||||
|
||||
This ensures fastest possible execution.
|
||||
|
||||
## Hook types
|
||||
|
||||
Each hook can be tapped with one or several functions. How they are executed depends on the hook type:
|
||||
|
||||
* Basic hook (without “Waterfall”, “Bail” or “Loop” in its name). This hook simply calls every function it tapped in a row.
|
||||
|
||||
* __Waterfall__. A waterfall hook also calls each tapped function in a row. Unlike the basic hook, it passes a return value from each function to the next function.
|
||||
|
||||
* __Bail__. A bail hook allows exiting early. When any of the tapped function returns anything, the bail hook will stop executing the remaining ones.
|
||||
|
||||
* __Loop__. TODO
|
||||
|
||||
Additionally, hooks can be synchronous or asynchronous. To reflect this, there’re “Sync”, “AsyncSeries”, and “AsyncParallel” hook classes:
|
||||
|
||||
* __Sync__. A sync hook can only be tapped with synchronous functions (using `myHook.tap()`).
|
||||
|
||||
* __AsyncSeries__. An async-series hook can be tapped with synchronous, callback-based and promise-based functions (using `myHook.tap()`, `myHook.tapAsync()` and `myHook.tapPromise()`). They call each async method in a row.
|
||||
|
||||
* __AsyncParallel__. An async-parallel hook can also be tapped with synchronous, callback-based and promise-based functions (using `myHook.tap()`, `myHook.tapAsync()` and `myHook.tapPromise()`). However, they run each async method in parallel.
|
||||
|
||||
The hook type is reflected in its class name. E.g., `AsyncSeriesWaterfallHook` allows asynchronous functions and runs them in series, passing each function’s return value into the next function.
|
||||
|
||||
|
||||
## Interception
|
||||
|
||||
All Hooks offer an additional interception API:
|
||||
|
||||
``` js
|
||||
myCar.hooks.calculateRoutes.intercept({
|
||||
call: (source, target, routesList) => {
|
||||
console.log("Starting to calculate routes");
|
||||
},
|
||||
register: (tapInfo) => {
|
||||
// tapInfo = { type: "promise", name: "GoogleMapsPlugin", fn: ... }
|
||||
console.log(`${tapInfo.name} is doing its job`);
|
||||
return tapInfo; // may return a new tapInfo object
|
||||
}
|
||||
})
|
||||
```
|
||||
|
||||
**call**: `(...args) => void` Adding `call` to your interceptor will trigger when hooks are triggered. You have access to the hooks arguments.
|
||||
|
||||
**tap**: `(tap: Tap) => void` Adding `tap` to your interceptor will trigger when a plugin taps into a hook. Provided is the `Tap` object. `Tap` object can't be changed.
|
||||
|
||||
**loop**: `(...args) => void` Adding `loop` to your interceptor will trigger for each loop of a looping hook.
|
||||
|
||||
**register**: `(tap: Tap) => Tap | undefined` Adding `register` to your interceptor will trigger for each added `Tap` and allows to modify it.
|
||||
|
||||
## Context
|
||||
|
||||
Plugins and interceptors can opt-in to access an optional `context` object, which can be used to pass arbitrary values to subsequent plugins and interceptors.
|
||||
|
||||
``` js
|
||||
myCar.hooks.accelerate.intercept({
|
||||
context: true,
|
||||
tap: (context, tapInfo) => {
|
||||
// tapInfo = { type: "sync", name: "NoisePlugin", fn: ... }
|
||||
console.log(`${tapInfo.name} is doing it's job`);
|
||||
|
||||
// `context` starts as an empty object if at least one plugin uses `context: true`.
|
||||
// If no plugins use `context: true`, then `context` is undefined.
|
||||
if (context) {
|
||||
// Arbitrary properties can be added to `context`, which plugins can then access.
|
||||
context.hasMuffler = true;
|
||||
}
|
||||
}
|
||||
});
|
||||
|
||||
myCar.hooks.accelerate.tap({
|
||||
name: "NoisePlugin",
|
||||
context: true
|
||||
}, (context, newSpeed) => {
|
||||
if (context && context.hasMuffler) {
|
||||
console.log("Silence...");
|
||||
} else {
|
||||
console.log("Vroom!");
|
||||
}
|
||||
});
|
||||
```
|
||||
|
||||
## HookMap
|
||||
|
||||
A HookMap is a helper class for a Map with Hooks
|
||||
|
||||
``` js
|
||||
const keyedHook = new HookMap(key => new SyncHook(["arg"]))
|
||||
```
|
||||
|
||||
``` js
|
||||
keyedHook.tap("some-key", "MyPlugin", (arg) => { /* ... */ });
|
||||
keyedHook.tapAsync("some-key", "MyPlugin", (arg, callback) => { /* ... */ });
|
||||
keyedHook.tapPromise("some-key", "MyPlugin", (arg) => { /* ... */ });
|
||||
```
|
||||
|
||||
``` js
|
||||
const hook = keyedHook.get("some-key");
|
||||
if(hook !== undefined) {
|
||||
hook.callAsync("arg", err => { /* ... */ });
|
||||
}
|
||||
```
|
||||
|
||||
## Hook/HookMap interface
|
||||
|
||||
Public:
|
||||
|
||||
``` ts
|
||||
interface Hook {
|
||||
tap: (name: string | Tap, fn: (context?, ...args) => Result) => void,
|
||||
tapAsync: (name: string | Tap, fn: (context?, ...args, callback: (err, result: Result) => void) => void) => void,
|
||||
tapPromise: (name: string | Tap, fn: (context?, ...args) => Promise<Result>) => void,
|
||||
intercept: (interceptor: HookInterceptor) => void
|
||||
}
|
||||
|
||||
interface HookInterceptor {
|
||||
call: (context?, ...args) => void,
|
||||
loop: (context?, ...args) => void,
|
||||
tap: (context?, tap: Tap) => void,
|
||||
register: (tap: Tap) => Tap,
|
||||
context: boolean
|
||||
}
|
||||
|
||||
interface HookMap {
|
||||
for: (key: any) => Hook,
|
||||
tap: (key: any, name: string | Tap, fn: (context?, ...args) => Result) => void,
|
||||
tapAsync: (key: any, name: string | Tap, fn: (context?, ...args, callback: (err, result: Result) => void) => void) => void,
|
||||
tapPromise: (key: any, name: string | Tap, fn: (context?, ...args) => Promise<Result>) => void,
|
||||
intercept: (interceptor: HookMapInterceptor) => void
|
||||
}
|
||||
|
||||
interface HookMapInterceptor {
|
||||
factory: (key: any, hook: Hook) => Hook
|
||||
}
|
||||
|
||||
interface Tap {
|
||||
name: string,
|
||||
type: string
|
||||
fn: Function,
|
||||
stage: number,
|
||||
context: boolean
|
||||
}
|
||||
```
|
||||
|
||||
Protected (only for the class containing the hook):
|
||||
|
||||
``` ts
|
||||
interface Hook {
|
||||
isUsed: () => boolean,
|
||||
call: (...args) => Result,
|
||||
promise: (...args) => Promise<Result>,
|
||||
callAsync: (...args, callback: (err, result: Result) => void) => void,
|
||||
}
|
||||
|
||||
interface HookMap {
|
||||
get: (key: any) => Hook | undefined,
|
||||
for: (key: any) => Hook
|
||||
}
|
||||
```
|
||||
|
||||
## MultiHook
|
||||
|
||||
A helper Hook-like class to redirect taps to multiple other hooks:
|
||||
|
||||
``` js
|
||||
const { MultiHook } = require("tapable");
|
||||
|
||||
this.hooks.allHooks = new MultiHook([this.hooks.hookA, this.hooks.hookB]);
|
||||
```
|
||||
|
|
@ -1,85 +0,0 @@
|
|||
/*
|
||||
MIT License http://www.opensource.org/licenses/mit-license.php
|
||||
Author Tobias Koppers @sokra
|
||||
*/
|
||||
"use strict";
|
||||
|
||||
const Hook = require("./Hook");
|
||||
const HookCodeFactory = require("./HookCodeFactory");
|
||||
|
||||
class AsyncParallelBailHookCodeFactory extends HookCodeFactory {
|
||||
content({ onError, onResult, onDone }) {
|
||||
let code = "";
|
||||
code += `var _results = new Array(${this.options.taps.length});\n`;
|
||||
code += "var _checkDone = () => {\n";
|
||||
code += "for(var i = 0; i < _results.length; i++) {\n";
|
||||
code += "var item = _results[i];\n";
|
||||
code += "if(item === undefined) return false;\n";
|
||||
code += "if(item.result !== undefined) {\n";
|
||||
code += onResult("item.result");
|
||||
code += "return true;\n";
|
||||
code += "}\n";
|
||||
code += "if(item.error) {\n";
|
||||
code += onError("item.error");
|
||||
code += "return true;\n";
|
||||
code += "}\n";
|
||||
code += "}\n";
|
||||
code += "return false;\n";
|
||||
code += "}\n";
|
||||
code += this.callTapsParallel({
|
||||
onError: (i, err, done, doneBreak) => {
|
||||
let code = "";
|
||||
code += `if(${i} < _results.length && ((_results.length = ${i +
|
||||
1}), (_results[${i}] = { error: ${err} }), _checkDone())) {\n`;
|
||||
code += doneBreak(true);
|
||||
code += "} else {\n";
|
||||
code += done();
|
||||
code += "}\n";
|
||||
return code;
|
||||
},
|
||||
onResult: (i, result, done, doneBreak) => {
|
||||
let code = "";
|
||||
code += `if(${i} < _results.length && (${result} !== undefined && (_results.length = ${i +
|
||||
1}), (_results[${i}] = { result: ${result} }), _checkDone())) {\n`;
|
||||
code += doneBreak(true);
|
||||
code += "} else {\n";
|
||||
code += done();
|
||||
code += "}\n";
|
||||
return code;
|
||||
},
|
||||
onTap: (i, run, done, doneBreak) => {
|
||||
let code = "";
|
||||
if (i > 0) {
|
||||
code += `if(${i} >= _results.length) {\n`;
|
||||
code += done();
|
||||
code += "} else {\n";
|
||||
}
|
||||
code += run();
|
||||
if (i > 0) code += "}\n";
|
||||
return code;
|
||||
},
|
||||
onDone
|
||||
});
|
||||
return code;
|
||||
}
|
||||
}
|
||||
|
||||
const factory = new AsyncParallelBailHookCodeFactory();
|
||||
|
||||
const COMPILE = function(options) {
|
||||
factory.setup(this, options);
|
||||
return factory.create(options);
|
||||
};
|
||||
|
||||
function AsyncParallelBailHook(args = [], name = undefined) {
|
||||
const hook = new Hook(args, name);
|
||||
hook.constructor = AsyncParallelBailHook;
|
||||
hook.compile = COMPILE;
|
||||
hook._call = undefined;
|
||||
hook.call = undefined;
|
||||
return hook;
|
||||
}
|
||||
|
||||
AsyncParallelBailHook.prototype = null;
|
||||
|
||||
module.exports = AsyncParallelBailHook;
|
||||
|
|
@ -1,37 +0,0 @@
|
|||
/*
|
||||
MIT License http://www.opensource.org/licenses/mit-license.php
|
||||
Author Tobias Koppers @sokra
|
||||
*/
|
||||
"use strict";
|
||||
|
||||
const Hook = require("./Hook");
|
||||
const HookCodeFactory = require("./HookCodeFactory");
|
||||
|
||||
class AsyncParallelHookCodeFactory extends HookCodeFactory {
|
||||
content({ onError, onDone }) {
|
||||
return this.callTapsParallel({
|
||||
onError: (i, err, done, doneBreak) => onError(err) + doneBreak(true),
|
||||
onDone
|
||||
});
|
||||
}
|
||||
}
|
||||
|
||||
const factory = new AsyncParallelHookCodeFactory();
|
||||
|
||||
const COMPILE = function(options) {
|
||||
factory.setup(this, options);
|
||||
return factory.create(options);
|
||||
};
|
||||
|
||||
function AsyncParallelHook(args = [], name = undefined) {
|
||||
const hook = new Hook(args, name);
|
||||
hook.constructor = AsyncParallelHook;
|
||||
hook.compile = COMPILE;
|
||||
hook._call = undefined;
|
||||
hook.call = undefined;
|
||||
return hook;
|
||||
}
|
||||
|
||||
AsyncParallelHook.prototype = null;
|
||||
|
||||
module.exports = AsyncParallelHook;
|
||||
|
|
@ -1,42 +0,0 @@
|
|||
/*
|
||||
MIT License http://www.opensource.org/licenses/mit-license.php
|
||||
Author Tobias Koppers @sokra
|
||||
*/
|
||||
"use strict";
|
||||
|
||||
const Hook = require("./Hook");
|
||||
const HookCodeFactory = require("./HookCodeFactory");
|
||||
|
||||
class AsyncSeriesBailHookCodeFactory extends HookCodeFactory {
|
||||
content({ onError, onResult, resultReturns, onDone }) {
|
||||
return this.callTapsSeries({
|
||||
onError: (i, err, next, doneBreak) => onError(err) + doneBreak(true),
|
||||
onResult: (i, result, next) =>
|
||||
`if(${result} !== undefined) {\n${onResult(
|
||||
result
|
||||
)};\n} else {\n${next()}}\n`,
|
||||
resultReturns,
|
||||
onDone
|
||||
});
|
||||
}
|
||||
}
|
||||
|
||||
const factory = new AsyncSeriesBailHookCodeFactory();
|
||||
|
||||
const COMPILE = function(options) {
|
||||
factory.setup(this, options);
|
||||
return factory.create(options);
|
||||
};
|
||||
|
||||
function AsyncSeriesBailHook(args = [], name = undefined) {
|
||||
const hook = new Hook(args, name);
|
||||
hook.constructor = AsyncSeriesBailHook;
|
||||
hook.compile = COMPILE;
|
||||
hook._call = undefined;
|
||||
hook.call = undefined;
|
||||
return hook;
|
||||
}
|
||||
|
||||
AsyncSeriesBailHook.prototype = null;
|
||||
|
||||
module.exports = AsyncSeriesBailHook;
|
||||
|
|
@ -1,37 +0,0 @@
|
|||
/*
|
||||
MIT License http://www.opensource.org/licenses/mit-license.php
|
||||
Author Tobias Koppers @sokra
|
||||
*/
|
||||
"use strict";
|
||||
|
||||
const Hook = require("./Hook");
|
||||
const HookCodeFactory = require("./HookCodeFactory");
|
||||
|
||||
class AsyncSeriesHookCodeFactory extends HookCodeFactory {
|
||||
content({ onError, onDone }) {
|
||||
return this.callTapsSeries({
|
||||
onError: (i, err, next, doneBreak) => onError(err) + doneBreak(true),
|
||||
onDone
|
||||
});
|
||||
}
|
||||
}
|
||||
|
||||
const factory = new AsyncSeriesHookCodeFactory();
|
||||
|
||||
const COMPILE = function(options) {
|
||||
factory.setup(this, options);
|
||||
return factory.create(options);
|
||||
};
|
||||
|
||||
function AsyncSeriesHook(args = [], name = undefined) {
|
||||
const hook = new Hook(args, name);
|
||||
hook.constructor = AsyncSeriesHook;
|
||||
hook.compile = COMPILE;
|
||||
hook._call = undefined;
|
||||
hook.call = undefined;
|
||||
return hook;
|
||||
}
|
||||
|
||||
AsyncSeriesHook.prototype = null;
|
||||
|
||||
module.exports = AsyncSeriesHook;
|
||||
|
|
@ -1,37 +0,0 @@
|
|||
/*
|
||||
MIT License http://www.opensource.org/licenses/mit-license.php
|
||||
Author Tobias Koppers @sokra
|
||||
*/
|
||||
"use strict";
|
||||
|
||||
const Hook = require("./Hook");
|
||||
const HookCodeFactory = require("./HookCodeFactory");
|
||||
|
||||
class AsyncSeriesLoopHookCodeFactory extends HookCodeFactory {
|
||||
content({ onError, onDone }) {
|
||||
return this.callTapsLooping({
|
||||
onError: (i, err, next, doneBreak) => onError(err) + doneBreak(true),
|
||||
onDone
|
||||
});
|
||||
}
|
||||
}
|
||||
|
||||
const factory = new AsyncSeriesLoopHookCodeFactory();
|
||||
|
||||
const COMPILE = function(options) {
|
||||
factory.setup(this, options);
|
||||
return factory.create(options);
|
||||
};
|
||||
|
||||
function AsyncSeriesLoopHook(args = [], name = undefined) {
|
||||
const hook = new Hook(args, name);
|
||||
hook.constructor = AsyncSeriesLoopHook;
|
||||
hook.compile = COMPILE;
|
||||
hook._call = undefined;
|
||||
hook.call = undefined;
|
||||
return hook;
|
||||
}
|
||||
|
||||
AsyncSeriesLoopHook.prototype = null;
|
||||
|
||||
module.exports = AsyncSeriesLoopHook;
|
||||
|
|
@ -1,47 +0,0 @@
|
|||
/*
|
||||
MIT License http://www.opensource.org/licenses/mit-license.php
|
||||
Author Tobias Koppers @sokra
|
||||
*/
|
||||
"use strict";
|
||||
|
||||
const Hook = require("./Hook");
|
||||
const HookCodeFactory = require("./HookCodeFactory");
|
||||
|
||||
class AsyncSeriesWaterfallHookCodeFactory extends HookCodeFactory {
|
||||
content({ onError, onResult, onDone }) {
|
||||
return this.callTapsSeries({
|
||||
onError: (i, err, next, doneBreak) => onError(err) + doneBreak(true),
|
||||
onResult: (i, result, next) => {
|
||||
let code = "";
|
||||
code += `if(${result} !== undefined) {\n`;
|
||||
code += `${this._args[0]} = ${result};\n`;
|
||||
code += `}\n`;
|
||||
code += next();
|
||||
return code;
|
||||
},
|
||||
onDone: () => onResult(this._args[0])
|
||||
});
|
||||
}
|
||||
}
|
||||
|
||||
const factory = new AsyncSeriesWaterfallHookCodeFactory();
|
||||
|
||||
const COMPILE = function(options) {
|
||||
factory.setup(this, options);
|
||||
return factory.create(options);
|
||||
};
|
||||
|
||||
function AsyncSeriesWaterfallHook(args = [], name = undefined) {
|
||||
if (args.length < 1)
|
||||
throw new Error("Waterfall hooks must have at least one argument");
|
||||
const hook = new Hook(args, name);
|
||||
hook.constructor = AsyncSeriesWaterfallHook;
|
||||
hook.compile = COMPILE;
|
||||
hook._call = undefined;
|
||||
hook.call = undefined;
|
||||
return hook;
|
||||
}
|
||||
|
||||
AsyncSeriesWaterfallHook.prototype = null;
|
||||
|
||||
module.exports = AsyncSeriesWaterfallHook;
|
||||
|
|
@ -1,175 +0,0 @@
|
|||
/*
|
||||
MIT License http://www.opensource.org/licenses/mit-license.php
|
||||
Author Tobias Koppers @sokra
|
||||
*/
|
||||
"use strict";
|
||||
|
||||
const util = require("util");
|
||||
|
||||
const deprecateContext = util.deprecate(() => {},
|
||||
"Hook.context is deprecated and will be removed");
|
||||
|
||||
const CALL_DELEGATE = function(...args) {
|
||||
this.call = this._createCall("sync");
|
||||
return this.call(...args);
|
||||
};
|
||||
const CALL_ASYNC_DELEGATE = function(...args) {
|
||||
this.callAsync = this._createCall("async");
|
||||
return this.callAsync(...args);
|
||||
};
|
||||
const PROMISE_DELEGATE = function(...args) {
|
||||
this.promise = this._createCall("promise");
|
||||
return this.promise(...args);
|
||||
};
|
||||
|
||||
class Hook {
|
||||
constructor(args = [], name = undefined) {
|
||||
this._args = args;
|
||||
this.name = name;
|
||||
this.taps = [];
|
||||
this.interceptors = [];
|
||||
this._call = CALL_DELEGATE;
|
||||
this.call = CALL_DELEGATE;
|
||||
this._callAsync = CALL_ASYNC_DELEGATE;
|
||||
this.callAsync = CALL_ASYNC_DELEGATE;
|
||||
this._promise = PROMISE_DELEGATE;
|
||||
this.promise = PROMISE_DELEGATE;
|
||||
this._x = undefined;
|
||||
|
||||
this.compile = this.compile;
|
||||
this.tap = this.tap;
|
||||
this.tapAsync = this.tapAsync;
|
||||
this.tapPromise = this.tapPromise;
|
||||
}
|
||||
|
||||
compile(options) {
|
||||
throw new Error("Abstract: should be overridden");
|
||||
}
|
||||
|
||||
_createCall(type) {
|
||||
return this.compile({
|
||||
taps: this.taps,
|
||||
interceptors: this.interceptors,
|
||||
args: this._args,
|
||||
type: type
|
||||
});
|
||||
}
|
||||
|
||||
_tap(type, options, fn) {
|
||||
if (typeof options === "string") {
|
||||
options = {
|
||||
name: options
|
||||
};
|
||||
} else if (typeof options !== "object" || options === null) {
|
||||
throw new Error("Invalid tap options");
|
||||
}
|
||||
if (typeof options.name !== "string" || options.name === "") {
|
||||
throw new Error("Missing name for tap");
|
||||
}
|
||||
if (typeof options.context !== "undefined") {
|
||||
deprecateContext();
|
||||
}
|
||||
options = Object.assign({ type, fn }, options);
|
||||
options = this._runRegisterInterceptors(options);
|
||||
this._insert(options);
|
||||
}
|
||||
|
||||
tap(options, fn) {
|
||||
this._tap("sync", options, fn);
|
||||
}
|
||||
|
||||
tapAsync(options, fn) {
|
||||
this._tap("async", options, fn);
|
||||
}
|
||||
|
||||
tapPromise(options, fn) {
|
||||
this._tap("promise", options, fn);
|
||||
}
|
||||
|
||||
_runRegisterInterceptors(options) {
|
||||
for (const interceptor of this.interceptors) {
|
||||
if (interceptor.register) {
|
||||
const newOptions = interceptor.register(options);
|
||||
if (newOptions !== undefined) {
|
||||
options = newOptions;
|
||||
}
|
||||
}
|
||||
}
|
||||
return options;
|
||||
}
|
||||
|
||||
withOptions(options) {
|
||||
const mergeOptions = opt =>
|
||||
Object.assign({}, options, typeof opt === "string" ? { name: opt } : opt);
|
||||
|
||||
return {
|
||||
name: this.name,
|
||||
tap: (opt, fn) => this.tap(mergeOptions(opt), fn),
|
||||
tapAsync: (opt, fn) => this.tapAsync(mergeOptions(opt), fn),
|
||||
tapPromise: (opt, fn) => this.tapPromise(mergeOptions(opt), fn),
|
||||
intercept: interceptor => this.intercept(interceptor),
|
||||
isUsed: () => this.isUsed(),
|
||||
withOptions: opt => this.withOptions(mergeOptions(opt))
|
||||
};
|
||||
}
|
||||
|
||||
isUsed() {
|
||||
return this.taps.length > 0 || this.interceptors.length > 0;
|
||||
}
|
||||
|
||||
intercept(interceptor) {
|
||||
this._resetCompilation();
|
||||
this.interceptors.push(Object.assign({}, interceptor));
|
||||
if (interceptor.register) {
|
||||
for (let i = 0; i < this.taps.length; i++) {
|
||||
this.taps[i] = interceptor.register(this.taps[i]);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
_resetCompilation() {
|
||||
this.call = this._call;
|
||||
this.callAsync = this._callAsync;
|
||||
this.promise = this._promise;
|
||||
}
|
||||
|
||||
_insert(item) {
|
||||
this._resetCompilation();
|
||||
let before;
|
||||
if (typeof item.before === "string") {
|
||||
before = new Set([item.before]);
|
||||
} else if (Array.isArray(item.before)) {
|
||||
before = new Set(item.before);
|
||||
}
|
||||
let stage = 0;
|
||||
if (typeof item.stage === "number") {
|
||||
stage = item.stage;
|
||||
}
|
||||
let i = this.taps.length;
|
||||
while (i > 0) {
|
||||
i--;
|
||||
const x = this.taps[i];
|
||||
this.taps[i + 1] = x;
|
||||
const xStage = x.stage || 0;
|
||||
if (before) {
|
||||
if (before.has(x.name)) {
|
||||
before.delete(x.name);
|
||||
continue;
|
||||
}
|
||||
if (before.size > 0) {
|
||||
continue;
|
||||
}
|
||||
}
|
||||
if (xStage > stage) {
|
||||
continue;
|
||||
}
|
||||
i++;
|
||||
break;
|
||||
}
|
||||
this.taps[i] = item;
|
||||
}
|
||||
}
|
||||
|
||||
Object.setPrototypeOf(Hook.prototype, null);
|
||||
|
||||
module.exports = Hook;
|
||||
|
|
@ -1,407 +0,0 @@
|
|||
/*
|
||||
MIT License http://www.opensource.org/licenses/mit-license.php
|
||||
Author Tobias Koppers @sokra
|
||||
*/
|
||||
"use strict";
|
||||
|
||||
class HookCodeFactory {
|
||||
constructor(config) {
|
||||
this.config = config;
|
||||
this.options = undefined;
|
||||
this._args = undefined;
|
||||
}
|
||||
|
||||
create(options) {
|
||||
this.init(options);
|
||||
let fn;
|
||||
switch (this.options.type) {
|
||||
case "sync":
|
||||
fn = new Function(
|
||||
this.args(),
|
||||
'"use strict";\n' +
|
||||
this.header() +
|
||||
this.content({
|
||||
onError: err => `throw ${err};\n`,
|
||||
onResult: result => `return ${result};\n`,
|
||||
resultReturns: true,
|
||||
onDone: () => "",
|
||||
rethrowIfPossible: true
|
||||
})
|
||||
);
|
||||
break;
|
||||
case "async":
|
||||
fn = new Function(
|
||||
this.args({
|
||||
after: "_callback"
|
||||
}),
|
||||
'"use strict";\n' +
|
||||
this.header() +
|
||||
this.content({
|
||||
onError: err => `_callback(${err});\n`,
|
||||
onResult: result => `_callback(null, ${result});\n`,
|
||||
onDone: () => "_callback();\n"
|
||||
})
|
||||
);
|
||||
break;
|
||||
case "promise":
|
||||
let errorHelperUsed = false;
|
||||
const content = this.content({
|
||||
onError: err => {
|
||||
errorHelperUsed = true;
|
||||
return `_error(${err});\n`;
|
||||
},
|
||||
onResult: result => `_resolve(${result});\n`,
|
||||
onDone: () => "_resolve();\n"
|
||||
});
|
||||
let code = "";
|
||||
code += '"use strict";\n';
|
||||
code += "return new Promise((_resolve, _reject) => {\n";
|
||||
if (errorHelperUsed) {
|
||||
code += "var _sync = true;\n";
|
||||
code += "function _error(_err) {\n";
|
||||
code += "if(_sync)\n";
|
||||
code += "_resolve(Promise.resolve().then(() => { throw _err; }));\n";
|
||||
code += "else\n";
|
||||
code += "_reject(_err);\n";
|
||||
code += "};\n";
|
||||
}
|
||||
code += this.header();
|
||||
code += content;
|
||||
if (errorHelperUsed) {
|
||||
code += "_sync = false;\n";
|
||||
}
|
||||
code += "});\n";
|
||||
fn = new Function(this.args(), code);
|
||||
break;
|
||||
}
|
||||
this.deinit();
|
||||
return fn;
|
||||
}
|
||||
|
||||
setup(instance, options) {
|
||||
instance._x = options.taps.map(t => t.fn);
|
||||
}
|
||||
|
||||
/**
|
||||
* @param {{ type: "sync" | "promise" | "async", taps: Array<Tap>, interceptors: Array<Interceptor> }} options
|
||||
*/
|
||||
init(options) {
|
||||
this.options = options;
|
||||
this._args = options.args.slice();
|
||||
}
|
||||
|
||||
deinit() {
|
||||
this.options = undefined;
|
||||
this._args = undefined;
|
||||
}
|
||||
|
||||
header() {
|
||||
let code = "";
|
||||
if (this.needContext()) {
|
||||
code += "var _context = {};\n";
|
||||
} else {
|
||||
code += "var _context;\n";
|
||||
}
|
||||
code += "var _x = this._x;\n";
|
||||
if (this.options.interceptors.length > 0) {
|
||||
code += "var _taps = this.taps;\n";
|
||||
code += "var _interceptors = this.interceptors;\n";
|
||||
}
|
||||
for (let i = 0; i < this.options.interceptors.length; i++) {
|
||||
const interceptor = this.options.interceptors[i];
|
||||
if (interceptor.call) {
|
||||
code += `${this.getInterceptor(i)}.call(${this.args({
|
||||
before: interceptor.context ? "_context" : undefined
|
||||
})});\n`;
|
||||
}
|
||||
}
|
||||
return code;
|
||||
}
|
||||
|
||||
needContext() {
|
||||
for (const tap of this.options.taps) if (tap.context) return true;
|
||||
return false;
|
||||
}
|
||||
|
||||
callTap(tapIndex, { onError, onResult, onDone, rethrowIfPossible }) {
|
||||
let code = "";
|
||||
let hasTapCached = false;
|
||||
for (let i = 0; i < this.options.interceptors.length; i++) {
|
||||
const interceptor = this.options.interceptors[i];
|
||||
if (interceptor.tap) {
|
||||
if (!hasTapCached) {
|
||||
code += `var _tap${tapIndex} = ${this.getTap(tapIndex)};\n`;
|
||||
hasTapCached = true;
|
||||
}
|
||||
code += `${this.getInterceptor(i)}.tap(${
|
||||
interceptor.context ? "_context, " : ""
|
||||
}_tap${tapIndex});\n`;
|
||||
}
|
||||
}
|
||||
code += `var _fn${tapIndex} = ${this.getTapFn(tapIndex)};\n`;
|
||||
const tap = this.options.taps[tapIndex];
|
||||
switch (tap.type) {
|
||||
case "sync":
|
||||
if (!rethrowIfPossible) {
|
||||
code += `var _hasError${tapIndex} = false;\n`;
|
||||
code += "try {\n";
|
||||
}
|
||||
if (onResult) {
|
||||
code += `var _result${tapIndex} = _fn${tapIndex}(${this.args({
|
||||
before: tap.context ? "_context" : undefined
|
||||
})});\n`;
|
||||
} else {
|
||||
code += `_fn${tapIndex}(${this.args({
|
||||
before: tap.context ? "_context" : undefined
|
||||
})});\n`;
|
||||
}
|
||||
if (!rethrowIfPossible) {
|
||||
code += "} catch(_err) {\n";
|
||||
code += `_hasError${tapIndex} = true;\n`;
|
||||
code += onError("_err");
|
||||
code += "}\n";
|
||||
code += `if(!_hasError${tapIndex}) {\n`;
|
||||
}
|
||||
if (onResult) {
|
||||
code += onResult(`_result${tapIndex}`);
|
||||
}
|
||||
if (onDone) {
|
||||
code += onDone();
|
||||
}
|
||||
if (!rethrowIfPossible) {
|
||||
code += "}\n";
|
||||
}
|
||||
break;
|
||||
case "async":
|
||||
let cbCode = "";
|
||||
if (onResult) cbCode += `(_err${tapIndex}, _result${tapIndex}) => {\n`;
|
||||
else cbCode += `_err${tapIndex} => {\n`;
|
||||
cbCode += `if(_err${tapIndex}) {\n`;
|
||||
cbCode += onError(`_err${tapIndex}`);
|
||||
cbCode += "} else {\n";
|
||||
if (onResult) {
|
||||
cbCode += onResult(`_result${tapIndex}`);
|
||||
}
|
||||
if (onDone) {
|
||||
cbCode += onDone();
|
||||
}
|
||||
cbCode += "}\n";
|
||||
cbCode += "}";
|
||||
code += `_fn${tapIndex}(${this.args({
|
||||
before: tap.context ? "_context" : undefined,
|
||||
after: cbCode
|
||||
})});\n`;
|
||||
break;
|
||||
case "promise":
|
||||
code += `var _hasResult${tapIndex} = false;\n`;
|
||||
code += `var _promise${tapIndex} = _fn${tapIndex}(${this.args({
|
||||
before: tap.context ? "_context" : undefined
|
||||
})});\n`;
|
||||
code += `if (!_promise${tapIndex} || !_promise${tapIndex}.then)\n`;
|
||||
code += ` throw new Error('Tap function (tapPromise) did not return promise (returned ' + _promise${tapIndex} + ')');\n`;
|
||||
code += `_promise${tapIndex}.then(_result${tapIndex} => {\n`;
|
||||
code += `_hasResult${tapIndex} = true;\n`;
|
||||
if (onResult) {
|
||||
code += onResult(`_result${tapIndex}`);
|
||||
}
|
||||
if (onDone) {
|
||||
code += onDone();
|
||||
}
|
||||
code += `}, _err${tapIndex} => {\n`;
|
||||
code += `if(_hasResult${tapIndex}) throw _err${tapIndex};\n`;
|
||||
code += onError(`_err${tapIndex}`);
|
||||
code += "});\n";
|
||||
break;
|
||||
}
|
||||
return code;
|
||||
}
|
||||
|
||||
callTapsSeries({
|
||||
onError,
|
||||
onResult,
|
||||
resultReturns,
|
||||
onDone,
|
||||
doneReturns,
|
||||
rethrowIfPossible
|
||||
}) {
|
||||
if (this.options.taps.length === 0) return onDone();
|
||||
const firstAsync = this.options.taps.findIndex(t => t.type !== "sync");
|
||||
const somethingReturns = resultReturns || doneReturns || false;
|
||||
let code = "";
|
||||
let current = onDone;
|
||||
for (let j = this.options.taps.length - 1; j >= 0; j--) {
|
||||
const i = j;
|
||||
const unroll = current !== onDone && this.options.taps[i].type !== "sync";
|
||||
if (unroll) {
|
||||
code += `function _next${i}() {\n`;
|
||||
code += current();
|
||||
code += `}\n`;
|
||||
current = () => `${somethingReturns ? "return " : ""}_next${i}();\n`;
|
||||
}
|
||||
const done = current;
|
||||
const doneBreak = skipDone => {
|
||||
if (skipDone) return "";
|
||||
return onDone();
|
||||
};
|
||||
const content = this.callTap(i, {
|
||||
onError: error => onError(i, error, done, doneBreak),
|
||||
onResult:
|
||||
onResult &&
|
||||
(result => {
|
||||
return onResult(i, result, done, doneBreak);
|
||||
}),
|
||||
onDone: !onResult && done,
|
||||
rethrowIfPossible:
|
||||
rethrowIfPossible && (firstAsync < 0 || i < firstAsync)
|
||||
});
|
||||
current = () => content;
|
||||
}
|
||||
code += current();
|
||||
return code;
|
||||
}
|
||||
|
||||
callTapsLooping({ onError, onDone, rethrowIfPossible }) {
|
||||
if (this.options.taps.length === 0) return onDone();
|
||||
const syncOnly = this.options.taps.every(t => t.type === "sync");
|
||||
let code = "";
|
||||
if (!syncOnly) {
|
||||
code += "var _looper = () => {\n";
|
||||
code += "var _loopAsync = false;\n";
|
||||
}
|
||||
code += "var _loop;\n";
|
||||
code += "do {\n";
|
||||
code += "_loop = false;\n";
|
||||
for (let i = 0; i < this.options.interceptors.length; i++) {
|
||||
const interceptor = this.options.interceptors[i];
|
||||
if (interceptor.loop) {
|
||||
code += `${this.getInterceptor(i)}.loop(${this.args({
|
||||
before: interceptor.context ? "_context" : undefined
|
||||
})});\n`;
|
||||
}
|
||||
}
|
||||
code += this.callTapsSeries({
|
||||
onError,
|
||||
onResult: (i, result, next, doneBreak) => {
|
||||
let code = "";
|
||||
code += `if(${result} !== undefined) {\n`;
|
||||
code += "_loop = true;\n";
|
||||
if (!syncOnly) code += "if(_loopAsync) _looper();\n";
|
||||
code += doneBreak(true);
|
||||
code += `} else {\n`;
|
||||
code += next();
|
||||
code += `}\n`;
|
||||
return code;
|
||||
},
|
||||
onDone:
|
||||
onDone &&
|
||||
(() => {
|
||||
let code = "";
|
||||
code += "if(!_loop) {\n";
|
||||
code += onDone();
|
||||
code += "}\n";
|
||||
return code;
|
||||
}),
|
||||
rethrowIfPossible: rethrowIfPossible && syncOnly
|
||||
});
|
||||
code += "} while(_loop);\n";
|
||||
if (!syncOnly) {
|
||||
code += "_loopAsync = true;\n";
|
||||
code += "};\n";
|
||||
code += "_looper();\n";
|
||||
}
|
||||
return code;
|
||||
}
|
||||
|
||||
callTapsParallel({
|
||||
onError,
|
||||
onResult,
|
||||
onDone,
|
||||
rethrowIfPossible,
|
||||
onTap = (i, run) => run()
|
||||
}) {
|
||||
if (this.options.taps.length <= 1) {
|
||||
return this.callTapsSeries({
|
||||
onError,
|
||||
onResult,
|
||||
onDone,
|
||||
rethrowIfPossible
|
||||
});
|
||||
}
|
||||
let code = "";
|
||||
code += "do {\n";
|
||||
code += `var _counter = ${this.options.taps.length};\n`;
|
||||
if (onDone) {
|
||||
code += "var _done = () => {\n";
|
||||
code += onDone();
|
||||
code += "};\n";
|
||||
}
|
||||
for (let i = 0; i < this.options.taps.length; i++) {
|
||||
const done = () => {
|
||||
if (onDone) return "if(--_counter === 0) _done();\n";
|
||||
else return "--_counter;";
|
||||
};
|
||||
const doneBreak = skipDone => {
|
||||
if (skipDone || !onDone) return "_counter = 0;\n";
|
||||
else return "_counter = 0;\n_done();\n";
|
||||
};
|
||||
code += "if(_counter <= 0) break;\n";
|
||||
code += onTap(
|
||||
i,
|
||||
() =>
|
||||
this.callTap(i, {
|
||||
onError: error => {
|
||||
let code = "";
|
||||
code += "if(_counter > 0) {\n";
|
||||
code += onError(i, error, done, doneBreak);
|
||||
code += "}\n";
|
||||
return code;
|
||||
},
|
||||
onResult:
|
||||
onResult &&
|
||||
(result => {
|
||||
let code = "";
|
||||
code += "if(_counter > 0) {\n";
|
||||
code += onResult(i, result, done, doneBreak);
|
||||
code += "}\n";
|
||||
return code;
|
||||
}),
|
||||
onDone:
|
||||
!onResult &&
|
||||
(() => {
|
||||
return done();
|
||||
}),
|
||||
rethrowIfPossible
|
||||
}),
|
||||
done,
|
||||
doneBreak
|
||||
);
|
||||
}
|
||||
code += "} while(false);\n";
|
||||
return code;
|
||||
}
|
||||
|
||||
args({ before, after } = {}) {
|
||||
let allArgs = this._args;
|
||||
if (before) allArgs = [before].concat(allArgs);
|
||||
if (after) allArgs = allArgs.concat(after);
|
||||
if (allArgs.length === 0) {
|
||||
return "";
|
||||
} else {
|
||||
return allArgs.join(", ");
|
||||
}
|
||||
}
|
||||
|
||||
getTapFn(idx) {
|
||||
return `_x[${idx}]`;
|
||||
}
|
||||
|
||||
getTap(idx) {
|
||||
return `_taps[${idx}]`;
|
||||
}
|
||||
|
||||
getInterceptor(idx) {
|
||||
return `_interceptors[${idx}]`;
|
||||
}
|
||||
}
|
||||
|
||||
module.exports = HookCodeFactory;
|
||||
|
|
@ -1,61 +0,0 @@
|
|||
/*
|
||||
MIT License http://www.opensource.org/licenses/mit-license.php
|
||||
Author Tobias Koppers @sokra
|
||||
*/
|
||||
"use strict";
|
||||
|
||||
const util = require("util");
|
||||
|
||||
const defaultFactory = (key, hook) => hook;
|
||||
|
||||
class HookMap {
|
||||
constructor(factory, name = undefined) {
|
||||
this._map = new Map();
|
||||
this.name = name;
|
||||
this._factory = factory;
|
||||
this._interceptors = [];
|
||||
}
|
||||
|
||||
get(key) {
|
||||
return this._map.get(key);
|
||||
}
|
||||
|
||||
for(key) {
|
||||
const hook = this.get(key);
|
||||
if (hook !== undefined) {
|
||||
return hook;
|
||||
}
|
||||
let newHook = this._factory(key);
|
||||
const interceptors = this._interceptors;
|
||||
for (let i = 0; i < interceptors.length; i++) {
|
||||
newHook = interceptors[i].factory(key, newHook);
|
||||
}
|
||||
this._map.set(key, newHook);
|
||||
return newHook;
|
||||
}
|
||||
|
||||
intercept(interceptor) {
|
||||
this._interceptors.push(
|
||||
Object.assign(
|
||||
{
|
||||
factory: defaultFactory
|
||||
},
|
||||
interceptor
|
||||
)
|
||||
);
|
||||
}
|
||||
}
|
||||
|
||||
HookMap.prototype.tap = util.deprecate(function(key, options, fn) {
|
||||
return this.for(key).tap(options, fn);
|
||||
}, "HookMap#tap(key,…) is deprecated. Use HookMap#for(key).tap(…) instead.");
|
||||
|
||||
HookMap.prototype.tapAsync = util.deprecate(function(key, options, fn) {
|
||||
return this.for(key).tapAsync(options, fn);
|
||||
}, "HookMap#tapAsync(key,…) is deprecated. Use HookMap#for(key).tapAsync(…) instead.");
|
||||
|
||||
HookMap.prototype.tapPromise = util.deprecate(function(key, options, fn) {
|
||||
return this.for(key).tapPromise(options, fn);
|
||||
}, "HookMap#tapPromise(key,…) is deprecated. Use HookMap#for(key).tapPromise(…) instead.");
|
||||
|
||||
module.exports = HookMap;
|
||||
|
|
@ -1,54 +0,0 @@
|
|||
/*
|
||||
MIT License http://www.opensource.org/licenses/mit-license.php
|
||||
Author Tobias Koppers @sokra
|
||||
*/
|
||||
"use strict";
|
||||
|
||||
const Hook = require("./Hook");
|
||||
|
||||
class MultiHook {
|
||||
constructor(hooks, name = undefined) {
|
||||
this.hooks = hooks;
|
||||
this.name = name;
|
||||
}
|
||||
|
||||
tap(options, fn) {
|
||||
for (const hook of this.hooks) {
|
||||
hook.tap(options, fn);
|
||||
}
|
||||
}
|
||||
|
||||
tapAsync(options, fn) {
|
||||
for (const hook of this.hooks) {
|
||||
hook.tapAsync(options, fn);
|
||||
}
|
||||
}
|
||||
|
||||
tapPromise(options, fn) {
|
||||
for (const hook of this.hooks) {
|
||||
hook.tapPromise(options, fn);
|
||||
}
|
||||
}
|
||||
|
||||
isUsed() {
|
||||
for (const hook of this.hooks) {
|
||||
if (hook.isUsed()) return true;
|
||||
}
|
||||
return false;
|
||||
}
|
||||
|
||||
intercept(interceptor) {
|
||||
for (const hook of this.hooks) {
|
||||
hook.intercept(interceptor);
|
||||
}
|
||||
}
|
||||
|
||||
withOptions(options) {
|
||||
return new MultiHook(
|
||||
this.hooks.map(h => h.withOptions(options)),
|
||||
this.name
|
||||
);
|
||||
}
|
||||
}
|
||||
|
||||
module.exports = MultiHook;
|
||||
|
|
@ -1,51 +0,0 @@
|
|||
/*
|
||||
MIT License http://www.opensource.org/licenses/mit-license.php
|
||||
Author Tobias Koppers @sokra
|
||||
*/
|
||||
"use strict";
|
||||
|
||||
const Hook = require("./Hook");
|
||||
const HookCodeFactory = require("./HookCodeFactory");
|
||||
|
||||
class SyncBailHookCodeFactory extends HookCodeFactory {
|
||||
content({ onError, onResult, resultReturns, onDone, rethrowIfPossible }) {
|
||||
return this.callTapsSeries({
|
||||
onError: (i, err) => onError(err),
|
||||
onResult: (i, result, next) =>
|
||||
`if(${result} !== undefined) {\n${onResult(
|
||||
result
|
||||
)};\n} else {\n${next()}}\n`,
|
||||
resultReturns,
|
||||
onDone,
|
||||
rethrowIfPossible
|
||||
});
|
||||
}
|
||||
}
|
||||
|
||||
const factory = new SyncBailHookCodeFactory();
|
||||
|
||||
const TAP_ASYNC = () => {
|
||||
throw new Error("tapAsync is not supported on a SyncBailHook");
|
||||
};
|
||||
|
||||
const TAP_PROMISE = () => {
|
||||
throw new Error("tapPromise is not supported on a SyncBailHook");
|
||||
};
|
||||
|
||||
const COMPILE = function(options) {
|
||||
factory.setup(this, options);
|
||||
return factory.create(options);
|
||||
};
|
||||
|
||||
function SyncBailHook(args = [], name = undefined) {
|
||||
const hook = new Hook(args, name);
|
||||
hook.constructor = SyncBailHook;
|
||||
hook.tapAsync = TAP_ASYNC;
|
||||
hook.tapPromise = TAP_PROMISE;
|
||||
hook.compile = COMPILE;
|
||||
return hook;
|
||||
}
|
||||
|
||||
SyncBailHook.prototype = null;
|
||||
|
||||
module.exports = SyncBailHook;
|
||||
|
|
@ -1,46 +0,0 @@
|
|||
/*
|
||||
MIT License http://www.opensource.org/licenses/mit-license.php
|
||||
Author Tobias Koppers @sokra
|
||||
*/
|
||||
"use strict";
|
||||
|
||||
const Hook = require("./Hook");
|
||||
const HookCodeFactory = require("./HookCodeFactory");
|
||||
|
||||
class SyncHookCodeFactory extends HookCodeFactory {
|
||||
content({ onError, onDone, rethrowIfPossible }) {
|
||||
return this.callTapsSeries({
|
||||
onError: (i, err) => onError(err),
|
||||
onDone,
|
||||
rethrowIfPossible
|
||||
});
|
||||
}
|
||||
}
|
||||
|
||||
const factory = new SyncHookCodeFactory();
|
||||
|
||||
const TAP_ASYNC = () => {
|
||||
throw new Error("tapAsync is not supported on a SyncHook");
|
||||
};
|
||||
|
||||
const TAP_PROMISE = () => {
|
||||
throw new Error("tapPromise is not supported on a SyncHook");
|
||||
};
|
||||
|
||||
const COMPILE = function(options) {
|
||||
factory.setup(this, options);
|
||||
return factory.create(options);
|
||||
};
|
||||
|
||||
function SyncHook(args = [], name = undefined) {
|
||||
const hook = new Hook(args, name);
|
||||
hook.constructor = SyncHook;
|
||||
hook.tapAsync = TAP_ASYNC;
|
||||
hook.tapPromise = TAP_PROMISE;
|
||||
hook.compile = COMPILE;
|
||||
return hook;
|
||||
}
|
||||
|
||||
SyncHook.prototype = null;
|
||||
|
||||
module.exports = SyncHook;
|
||||
|
|
@ -1,46 +0,0 @@
|
|||
/*
|
||||
MIT License http://www.opensource.org/licenses/mit-license.php
|
||||
Author Tobias Koppers @sokra
|
||||
*/
|
||||
"use strict";
|
||||
|
||||
const Hook = require("./Hook");
|
||||
const HookCodeFactory = require("./HookCodeFactory");
|
||||
|
||||
class SyncLoopHookCodeFactory extends HookCodeFactory {
|
||||
content({ onError, onDone, rethrowIfPossible }) {
|
||||
return this.callTapsLooping({
|
||||
onError: (i, err) => onError(err),
|
||||
onDone,
|
||||
rethrowIfPossible
|
||||
});
|
||||
}
|
||||
}
|
||||
|
||||
const factory = new SyncLoopHookCodeFactory();
|
||||
|
||||
const TAP_ASYNC = () => {
|
||||
throw new Error("tapAsync is not supported on a SyncLoopHook");
|
||||
};
|
||||
|
||||
const TAP_PROMISE = () => {
|
||||
throw new Error("tapPromise is not supported on a SyncLoopHook");
|
||||
};
|
||||
|
||||
const COMPILE = function(options) {
|
||||
factory.setup(this, options);
|
||||
return factory.create(options);
|
||||
};
|
||||
|
||||
function SyncLoopHook(args = [], name = undefined) {
|
||||
const hook = new Hook(args, name);
|
||||
hook.constructor = SyncLoopHook;
|
||||
hook.tapAsync = TAP_ASYNC;
|
||||
hook.tapPromise = TAP_PROMISE;
|
||||
hook.compile = COMPILE;
|
||||
return hook;
|
||||
}
|
||||
|
||||
SyncLoopHook.prototype = null;
|
||||
|
||||
module.exports = SyncLoopHook;
|
||||
|
|
@ -1,57 +0,0 @@
|
|||
/*
|
||||
MIT License http://www.opensource.org/licenses/mit-license.php
|
||||
Author Tobias Koppers @sokra
|
||||
*/
|
||||
"use strict";
|
||||
|
||||
const Hook = require("./Hook");
|
||||
const HookCodeFactory = require("./HookCodeFactory");
|
||||
|
||||
class SyncWaterfallHookCodeFactory extends HookCodeFactory {
|
||||
content({ onError, onResult, resultReturns, rethrowIfPossible }) {
|
||||
return this.callTapsSeries({
|
||||
onError: (i, err) => onError(err),
|
||||
onResult: (i, result, next) => {
|
||||
let code = "";
|
||||
code += `if(${result} !== undefined) {\n`;
|
||||
code += `${this._args[0]} = ${result};\n`;
|
||||
code += `}\n`;
|
||||
code += next();
|
||||
return code;
|
||||
},
|
||||
onDone: () => onResult(this._args[0]),
|
||||
doneReturns: resultReturns,
|
||||
rethrowIfPossible
|
||||
});
|
||||
}
|
||||
}
|
||||
|
||||
const factory = new SyncWaterfallHookCodeFactory();
|
||||
|
||||
const TAP_ASYNC = () => {
|
||||
throw new Error("tapAsync is not supported on a SyncWaterfallHook");
|
||||
};
|
||||
|
||||
const TAP_PROMISE = () => {
|
||||
throw new Error("tapPromise is not supported on a SyncWaterfallHook");
|
||||
};
|
||||
|
||||
const COMPILE = function(options) {
|
||||
factory.setup(this, options);
|
||||
return factory.create(options);
|
||||
};
|
||||
|
||||
function SyncWaterfallHook(args = [], name = undefined) {
|
||||
if (args.length < 1)
|
||||
throw new Error("Waterfall hooks must have at least one argument");
|
||||
const hook = new Hook(args, name);
|
||||
hook.constructor = SyncWaterfallHook;
|
||||
hook.tapAsync = TAP_ASYNC;
|
||||
hook.tapPromise = TAP_PROMISE;
|
||||
hook.compile = COMPILE;
|
||||
return hook;
|
||||
}
|
||||
|
||||
SyncWaterfallHook.prototype = null;
|
||||
|
||||
module.exports = SyncWaterfallHook;
|
||||
|
|
@ -1,19 +0,0 @@
|
|||
/*
|
||||
MIT License http://www.opensource.org/licenses/mit-license.php
|
||||
Author Tobias Koppers @sokra
|
||||
*/
|
||||
"use strict";
|
||||
|
||||
exports.__esModule = true;
|
||||
exports.SyncHook = require("./SyncHook");
|
||||
exports.SyncBailHook = require("./SyncBailHook");
|
||||
exports.SyncWaterfallHook = require("./SyncWaterfallHook");
|
||||
exports.SyncLoopHook = require("./SyncLoopHook");
|
||||
exports.AsyncParallelHook = require("./AsyncParallelHook");
|
||||
exports.AsyncParallelBailHook = require("./AsyncParallelBailHook");
|
||||
exports.AsyncSeriesHook = require("./AsyncSeriesHook");
|
||||
exports.AsyncSeriesBailHook = require("./AsyncSeriesBailHook");
|
||||
exports.AsyncSeriesLoopHook = require("./AsyncSeriesLoopHook");
|
||||
exports.AsyncSeriesWaterfallHook = require("./AsyncSeriesWaterfallHook");
|
||||
exports.HookMap = require("./HookMap");
|
||||
exports.MultiHook = require("./MultiHook");
|
||||
|
|
@ -1,41 +0,0 @@
|
|||
{
|
||||
"name": "tapable",
|
||||
"version": "2.0.0-beta.8",
|
||||
"author": "Tobias Koppers @sokra",
|
||||
"description": "Just a little module for plugins.",
|
||||
"license": "MIT",
|
||||
"homepage": "https://github.com/webpack/tapable",
|
||||
"repository": {
|
||||
"type": "git",
|
||||
"url": "http://github.com/webpack/tapable.git"
|
||||
},
|
||||
"devDependencies": {
|
||||
"@babel/core": "^7.4.4",
|
||||
"@babel/preset-env": "^7.4.4",
|
||||
"babel-jest": "^24.8.0",
|
||||
"codecov": "^3.5.0",
|
||||
"jest": "^24.8.0",
|
||||
"prettier": "^1.17.1"
|
||||
},
|
||||
"engines": {
|
||||
"node": ">=6"
|
||||
},
|
||||
"files": [
|
||||
"lib",
|
||||
"!lib/__tests__",
|
||||
"tapable.d.ts"
|
||||
],
|
||||
"main": "lib/index.js",
|
||||
"types": "./tapable.d.ts",
|
||||
"scripts": {
|
||||
"test": "jest",
|
||||
"travis": "yarn pretty-lint && jest --coverage && codecov",
|
||||
"pretty-lint": "prettier --check lib/*.js lib/__tests__/*.js",
|
||||
"pretty": "prettier --loglevel warn --write lib/*.js lib/__tests__/*.js"
|
||||
},
|
||||
"jest": {
|
||||
"transform": {
|
||||
"__tests__[\\\\/].+\\.js$": "babel-jest"
|
||||
}
|
||||
}
|
||||
}
|
||||
|
|
@ -1,101 +0,0 @@
|
|||
type FixedSizeArray<T extends number, U> = T extends 0
|
||||
? void[]
|
||||
: ReadonlyArray<U> & {
|
||||
0: U;
|
||||
length: T;
|
||||
};
|
||||
type Measure<T extends number> = T extends 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8
|
||||
? T
|
||||
: never;
|
||||
type Append<T extends any[], U> = {
|
||||
0: [U];
|
||||
1: [T[0], U];
|
||||
2: [T[0], T[1], U];
|
||||
3: [T[0], T[1], T[2], U];
|
||||
4: [T[0], T[1], T[2], T[3], U];
|
||||
5: [T[0], T[1], T[2], T[3], T[4], U];
|
||||
6: [T[0], T[1], T[2], T[3], T[4], T[5], U];
|
||||
7: [T[0], T[1], T[2], T[3], T[4], T[5], T[6], U];
|
||||
8: [T[0], T[1], T[2], T[3], T[4], T[5], T[6], T[7], U];
|
||||
}[Measure<T["length"]>];
|
||||
type AsArray<T> = T extends any[] ? T : [T];
|
||||
|
||||
type Callback<E, T> = (error?: E, result?: T) => void;
|
||||
|
||||
type Tap = TapOptions & {
|
||||
name: string;
|
||||
};
|
||||
|
||||
type TapOptions = {
|
||||
before?: string;
|
||||
stage?: number;
|
||||
};
|
||||
|
||||
interface HookInterceptor<H> {
|
||||
name?: string;
|
||||
tap?: (tap: Tap) => void;
|
||||
call?: (...args: any[]) => void;
|
||||
loop?: (...args: any[]) => void;
|
||||
register?: (hook: H) => H;
|
||||
}
|
||||
|
||||
type ArgumentNames<T extends any[]> = FixedSizeArray<T["length"], string>;
|
||||
|
||||
declare class Hook<T, R> {
|
||||
constructor(args?: ArgumentNames<AsArray<T>>, name?: string);
|
||||
name: string | undefined;
|
||||
intercept(interceptor: HookInterceptor<Hook<T, R>>): void;
|
||||
isUsed(): boolean;
|
||||
callAsync(...args: Append<AsArray<T>, Callback<Error, R>>): void;
|
||||
promise(...args: AsArray<T>): Promise<R>;
|
||||
tap(options: string | Tap, fn: (...args: AsArray<T>) => R): void;
|
||||
withOptions(options: TapOptions): Hook<T, R>;
|
||||
}
|
||||
|
||||
export class SyncHook<T, R = void> extends Hook<T, R> {
|
||||
call(...args: AsArray<T>): R;
|
||||
}
|
||||
|
||||
export class SyncBailHook<T, R> extends SyncHook<T, R> {}
|
||||
export class SyncLoopHook<T> extends SyncHook<T, void> {}
|
||||
export class SyncWaterfallHook<T> extends SyncHook<T, AsArray<T>[0]> {}
|
||||
|
||||
declare class AsyncHook<T, R> extends Hook<T, R> {
|
||||
tapAsync(
|
||||
options: string | Tap,
|
||||
fn: (...args: Append<AsArray<T>, Callback<Error, R>>) => void
|
||||
): void;
|
||||
tapPromise(
|
||||
options: string | Tap,
|
||||
fn: (...args: AsArray<T>) => Promise<R>
|
||||
): void;
|
||||
}
|
||||
|
||||
export class AsyncParallelHook<T> extends AsyncHook<T, void> {}
|
||||
export class AsyncParallelBailHook<T, R> extends AsyncHook<T, R> {}
|
||||
export class AsyncSeriesHook<T> extends AsyncHook<T, void> {}
|
||||
export class AsyncSeriesBailHook<T, R> extends AsyncHook<T, R> {}
|
||||
export class AsyncSeriesLoopHook<T> extends AsyncHook<T, void> {}
|
||||
export class AsyncSeriesWaterfallHook<T> extends AsyncHook<T, AsArray<T>[0]> {}
|
||||
|
||||
type HookFactory<H> = (key: any, hook?: H) => H;
|
||||
|
||||
interface HookMapInterceptor<H> {
|
||||
factory?: HookFactory<H>;
|
||||
}
|
||||
|
||||
export class HookMap<H> {
|
||||
constructor(factory: HookFactory<H>, name?: string);
|
||||
name: string | undefined;
|
||||
get(key: any): H | undefined;
|
||||
for(key: any): H;
|
||||
intercept(interceptor: HookMapInterceptor<H>): void;
|
||||
}
|
||||
|
||||
export class MultiHook<H> {
|
||||
constructor(hooks: H[], name?: string);
|
||||
name: string | undefined;
|
||||
tap(options: string | Tap, fn?: Function): void;
|
||||
tapAsync(options: string | Tap, fn?: Function): void;
|
||||
tapPromise(options: string | Tap, fn?: Function): void;
|
||||
}
|
||||
|
|
@ -1,21 +0,0 @@
|
|||
The MIT License
|
||||
|
||||
Copyright JS Foundation and other contributors
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
of this software and associated documentation files (the "Software"), to deal
|
||||
in the Software without restriction, including without limitation the rights
|
||||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||
copies of the Software, and to permit persons to whom the Software is
|
||||
furnished to do so, subject to the following conditions:
|
||||
|
||||
The above copyright notice and this permission notice shall be included in
|
||||
all copies or substantial portions of the Software.
|
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
|
||||
THE SOFTWARE.
|
||||
|
|
@ -1,298 +0,0 @@
|
|||
# Tapable
|
||||
|
||||
The tapable package expose many Hook classes, which can be used to create hooks for plugins.
|
||||
|
||||
``` javascript
|
||||
const {
|
||||
SyncHook,
|
||||
SyncBailHook,
|
||||
SyncWaterfallHook,
|
||||
SyncLoopHook,
|
||||
AsyncParallelHook,
|
||||
AsyncParallelBailHook,
|
||||
AsyncSeriesHook,
|
||||
AsyncSeriesBailHook,
|
||||
AsyncSeriesWaterfallHook
|
||||
} = require("tapable");
|
||||
```
|
||||
|
||||
## Installation
|
||||
|
||||
``` shell
|
||||
npm install --save tapable
|
||||
```
|
||||
|
||||
## Usage
|
||||
|
||||
All Hook constructors take one optional argument, which is a list of argument names as strings.
|
||||
|
||||
``` js
|
||||
const hook = new SyncHook(["arg1", "arg2", "arg3"]);
|
||||
```
|
||||
|
||||
The best practice is to expose all hooks of a class in a `hooks` property:
|
||||
|
||||
``` js
|
||||
class Car {
|
||||
constructor() {
|
||||
this.hooks = {
|
||||
accelerate: new SyncHook(["newSpeed"]),
|
||||
brake: new SyncHook(),
|
||||
calculateRoutes: new AsyncParallelHook(["source", "target", "routesList"])
|
||||
};
|
||||
}
|
||||
|
||||
/* ... */
|
||||
}
|
||||
```
|
||||
|
||||
Other people can now use these hooks:
|
||||
|
||||
``` js
|
||||
const myCar = new Car();
|
||||
|
||||
// Use the tap method to add a consument
|
||||
myCar.hooks.brake.tap("WarningLampPlugin", () => warningLamp.on());
|
||||
```
|
||||
|
||||
It's required to pass a name to identify the plugin/reason.
|
||||
|
||||
You may receive arguments:
|
||||
|
||||
``` js
|
||||
myCar.hooks.accelerate.tap("LoggerPlugin", newSpeed => console.log(`Accelerating to ${newSpeed}`));
|
||||
```
|
||||
|
||||
For sync hooks, `tap` is the only valid method to add a plugin. Async hooks also support async plugins:
|
||||
|
||||
``` js
|
||||
myCar.hooks.calculateRoutes.tapPromise("GoogleMapsPlugin", (source, target, routesList) => {
|
||||
// return a promise
|
||||
return google.maps.findRoute(source, target).then(route => {
|
||||
routesList.add(route);
|
||||
});
|
||||
});
|
||||
myCar.hooks.calculateRoutes.tapAsync("BingMapsPlugin", (source, target, routesList, callback) => {
|
||||
bing.findRoute(source, target, (err, route) => {
|
||||
if(err) return callback(err);
|
||||
routesList.add(route);
|
||||
// call the callback
|
||||
callback();
|
||||
});
|
||||
});
|
||||
|
||||
// You can still use sync plugins
|
||||
myCar.hooks.calculateRoutes.tap("CachedRoutesPlugin", (source, target, routesList) => {
|
||||
const cachedRoute = cache.get(source, target);
|
||||
if(cachedRoute)
|
||||
routesList.add(cachedRoute);
|
||||
})
|
||||
```
|
||||
The class declaring these hooks need to call them:
|
||||
|
||||
``` js
|
||||
class Car {
|
||||
/**
|
||||
* You won't get returned value from SyncHook or AsyncParallelHook,
|
||||
* to do that, use SyncWaterfallHook and AsyncSeriesWaterfallHook respectively
|
||||
**/
|
||||
|
||||
setSpeed(newSpeed) {
|
||||
// following call returns undefined even when you returned values
|
||||
this.hooks.accelerate.call(newSpeed);
|
||||
}
|
||||
|
||||
useNavigationSystemPromise(source, target) {
|
||||
const routesList = new List();
|
||||
return this.hooks.calculateRoutes.promise(source, target, routesList).then((res) => {
|
||||
// res is undefined for AsyncParallelHook
|
||||
return routesList.getRoutes();
|
||||
});
|
||||
}
|
||||
|
||||
useNavigationSystemAsync(source, target, callback) {
|
||||
const routesList = new List();
|
||||
this.hooks.calculateRoutes.callAsync(source, target, routesList, err => {
|
||||
if(err) return callback(err);
|
||||
callback(null, routesList.getRoutes());
|
||||
});
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
The Hook will compile a method with the most efficient way of running your plugins. It generates code depending on:
|
||||
* The number of registered plugins (none, one, many)
|
||||
* The kind of registered plugins (sync, async, promise)
|
||||
* The used call method (sync, async, promise)
|
||||
* The number of arguments
|
||||
* Whether interception is used
|
||||
|
||||
This ensures fastest possible execution.
|
||||
|
||||
## Hook types
|
||||
|
||||
Each hook can be tapped with one or several functions. How they are executed depends on the hook type:
|
||||
|
||||
* Basic hook (without “Waterfall”, “Bail” or “Loop” in its name). This hook simply calls every function it tapped in a row.
|
||||
|
||||
* __Waterfall__. A waterfall hook also calls each tapped function in a row. Unlike the basic hook, it passes a return value from each function to the next function.
|
||||
|
||||
* __Bail__. A bail hook allows exiting early. When any of the tapped function returns anything, the bail hook will stop executing the remaining ones.
|
||||
|
||||
* __Loop__. TODO
|
||||
|
||||
Additionally, hooks can be synchronous or asynchronous. To reflect this, there’re “Sync”, “AsyncSeries”, and “AsyncParallel” hook classes:
|
||||
|
||||
* __Sync__. A sync hook can only be tapped with synchronous functions (using `myHook.tap()`).
|
||||
|
||||
* __AsyncSeries__. An async-series hook can be tapped with synchronous, callback-based and promise-based functions (using `myHook.tap()`, `myHook.tapAsync()` and `myHook.tapPromise()`). They call each async method in a row.
|
||||
|
||||
* __AsyncParallel__. An async-parallel hook can also be tapped with synchronous, callback-based and promise-based functions (using `myHook.tap()`, `myHook.tapAsync()` and `myHook.tapPromise()`). However, they run each async method in parallel.
|
||||
|
||||
The hook type is reflected in its class name. E.g., `AsyncSeriesWaterfallHook` allows asynchronous functions and runs them in series, passing each function’s return value into the next function.
|
||||
|
||||
|
||||
## Interception
|
||||
|
||||
All Hooks offer an additional interception API:
|
||||
|
||||
``` js
|
||||
myCar.hooks.calculateRoutes.intercept({
|
||||
call: (source, target, routesList) => {
|
||||
console.log("Starting to calculate routes");
|
||||
},
|
||||
register: (tapInfo) => {
|
||||
// tapInfo = { type: "promise", name: "GoogleMapsPlugin", fn: ... }
|
||||
console.log(`${tapInfo.name} is doing its job`);
|
||||
return tapInfo; // may return a new tapInfo object
|
||||
}
|
||||
})
|
||||
```
|
||||
|
||||
**call**: `(...args) => void` Adding `call` to your interceptor will trigger when hooks are triggered. You have access to the hooks arguments.
|
||||
|
||||
**tap**: `(tap: Tap) => void` Adding `tap` to your interceptor will trigger when a plugin taps into a hook. Provided is the `Tap` object. `Tap` object can't be changed.
|
||||
|
||||
**loop**: `(...args) => void` Adding `loop` to your interceptor will trigger for each loop of a looping hook.
|
||||
|
||||
**register**: `(tap: Tap) => Tap | undefined` Adding `register` to your interceptor will trigger for each added `Tap` and allows to modify it.
|
||||
|
||||
## Context
|
||||
|
||||
Plugins and interceptors can opt-in to access an optional `context` object, which can be used to pass arbitrary values to subsequent plugins and interceptors.
|
||||
|
||||
``` js
|
||||
myCar.hooks.accelerate.intercept({
|
||||
context: true,
|
||||
tap: (context, tapInfo) => {
|
||||
// tapInfo = { type: "sync", name: "NoisePlugin", fn: ... }
|
||||
console.log(`${tapInfo.name} is doing it's job`);
|
||||
|
||||
// `context` starts as an empty object if at least one plugin uses `context: true`.
|
||||
// If no plugins use `context: true`, then `context` is undefined.
|
||||
if (context) {
|
||||
// Arbitrary properties can be added to `context`, which plugins can then access.
|
||||
context.hasMuffler = true;
|
||||
}
|
||||
}
|
||||
});
|
||||
|
||||
myCar.hooks.accelerate.tap({
|
||||
name: "NoisePlugin",
|
||||
context: true
|
||||
}, (context, newSpeed) => {
|
||||
if (context && context.hasMuffler) {
|
||||
console.log("Silence...");
|
||||
} else {
|
||||
console.log("Vroom!");
|
||||
}
|
||||
});
|
||||
```
|
||||
|
||||
## HookMap
|
||||
|
||||
A HookMap is a helper class for a Map with Hooks
|
||||
|
||||
``` js
|
||||
const keyedHook = new HookMap(key => new SyncHook(["arg"]))
|
||||
```
|
||||
|
||||
``` js
|
||||
keyedHook.tap("some-key", "MyPlugin", (arg) => { /* ... */ });
|
||||
keyedHook.tapAsync("some-key", "MyPlugin", (arg, callback) => { /* ... */ });
|
||||
keyedHook.tapPromise("some-key", "MyPlugin", (arg) => { /* ... */ });
|
||||
```
|
||||
|
||||
``` js
|
||||
const hook = keyedHook.get("some-key");
|
||||
if(hook !== undefined) {
|
||||
hook.callAsync("arg", err => { /* ... */ });
|
||||
}
|
||||
```
|
||||
|
||||
## Hook/HookMap interface
|
||||
|
||||
Public:
|
||||
|
||||
``` ts
|
||||
interface Hook {
|
||||
tap: (name: string | Tap, fn: (context?, ...args) => Result) => void,
|
||||
tapAsync: (name: string | Tap, fn: (context?, ...args, callback: (err, result: Result) => void) => void) => void,
|
||||
tapPromise: (name: string | Tap, fn: (context?, ...args) => Promise<Result>) => void,
|
||||
intercept: (interceptor: HookInterceptor) => void
|
||||
}
|
||||
|
||||
interface HookInterceptor {
|
||||
call: (context?, ...args) => void,
|
||||
loop: (context?, ...args) => void,
|
||||
tap: (context?, tap: Tap) => void,
|
||||
register: (tap: Tap) => Tap,
|
||||
context: boolean
|
||||
}
|
||||
|
||||
interface HookMap {
|
||||
for: (key: any) => Hook,
|
||||
tap: (key: any, name: string | Tap, fn: (context?, ...args) => Result) => void,
|
||||
tapAsync: (key: any, name: string | Tap, fn: (context?, ...args, callback: (err, result: Result) => void) => void) => void,
|
||||
tapPromise: (key: any, name: string | Tap, fn: (context?, ...args) => Promise<Result>) => void,
|
||||
intercept: (interceptor: HookMapInterceptor) => void
|
||||
}
|
||||
|
||||
interface HookMapInterceptor {
|
||||
factory: (key: any, hook: Hook) => Hook
|
||||
}
|
||||
|
||||
interface Tap {
|
||||
name: string,
|
||||
type: string
|
||||
fn: Function,
|
||||
stage: number,
|
||||
context: boolean
|
||||
}
|
||||
```
|
||||
|
||||
Protected (only for the class containing the hook):
|
||||
|
||||
``` ts
|
||||
interface Hook {
|
||||
isUsed: () => boolean,
|
||||
call: (...args) => Result,
|
||||
promise: (...args) => Promise<Result>,
|
||||
callAsync: (...args, callback: (err, result: Result) => void) => void,
|
||||
}
|
||||
|
||||
interface HookMap {
|
||||
get: (key: any) => Hook | undefined,
|
||||
for: (key: any) => Hook
|
||||
}
|
||||
```
|
||||
|
||||
## MultiHook
|
||||
|
||||
A helper Hook-like class to redirect taps to multiple other hooks:
|
||||
|
||||
``` js
|
||||
const { MultiHook } = require("tapable");
|
||||
|
||||
this.hooks.allHooks = new MultiHook([this.hooks.hookA, this.hooks.hookB]);
|
||||
```
|
||||
|
|
@ -1,85 +0,0 @@
|
|||
/*
|
||||
MIT License http://www.opensource.org/licenses/mit-license.php
|
||||
Author Tobias Koppers @sokra
|
||||
*/
|
||||
"use strict";
|
||||
|
||||
const Hook = require("./Hook");
|
||||
const HookCodeFactory = require("./HookCodeFactory");
|
||||
|
||||
class AsyncParallelBailHookCodeFactory extends HookCodeFactory {
|
||||
content({ onError, onResult, onDone }) {
|
||||
let code = "";
|
||||
code += `var _results = new Array(${this.options.taps.length});\n`;
|
||||
code += "var _checkDone = () => {\n";
|
||||
code += "for(var i = 0; i < _results.length; i++) {\n";
|
||||
code += "var item = _results[i];\n";
|
||||
code += "if(item === undefined) return false;\n";
|
||||
code += "if(item.result !== undefined) {\n";
|
||||
code += onResult("item.result");
|
||||
code += "return true;\n";
|
||||
code += "}\n";
|
||||
code += "if(item.error) {\n";
|
||||
code += onError("item.error");
|
||||
code += "return true;\n";
|
||||
code += "}\n";
|
||||
code += "}\n";
|
||||
code += "return false;\n";
|
||||
code += "}\n";
|
||||
code += this.callTapsParallel({
|
||||
onError: (i, err, done, doneBreak) => {
|
||||
let code = "";
|
||||
code += `if(${i} < _results.length && ((_results.length = ${i +
|
||||
1}), (_results[${i}] = { error: ${err} }), _checkDone())) {\n`;
|
||||
code += doneBreak(true);
|
||||
code += "} else {\n";
|
||||
code += done();
|
||||
code += "}\n";
|
||||
return code;
|
||||
},
|
||||
onResult: (i, result, done, doneBreak) => {
|
||||
let code = "";
|
||||
code += `if(${i} < _results.length && (${result} !== undefined && (_results.length = ${i +
|
||||
1}), (_results[${i}] = { result: ${result} }), _checkDone())) {\n`;
|
||||
code += doneBreak(true);
|
||||
code += "} else {\n";
|
||||
code += done();
|
||||
code += "}\n";
|
||||
return code;
|
||||
},
|
||||
onTap: (i, run, done, doneBreak) => {
|
||||
let code = "";
|
||||
if (i > 0) {
|
||||
code += `if(${i} >= _results.length) {\n`;
|
||||
code += done();
|
||||
code += "} else {\n";
|
||||
}
|
||||
code += run();
|
||||
if (i > 0) code += "}\n";
|
||||
return code;
|
||||
},
|
||||
onDone
|
||||
});
|
||||
return code;
|
||||
}
|
||||
}
|
||||
|
||||
const factory = new AsyncParallelBailHookCodeFactory();
|
||||
|
||||
const COMPILE = function(options) {
|
||||
factory.setup(this, options);
|
||||
return factory.create(options);
|
||||
};
|
||||
|
||||
function AsyncParallelBailHook(args = [], name = undefined) {
|
||||
const hook = new Hook(args, name);
|
||||
hook.constructor = AsyncParallelBailHook;
|
||||
hook.compile = COMPILE;
|
||||
hook._call = undefined;
|
||||
hook.call = undefined;
|
||||
return hook;
|
||||
}
|
||||
|
||||
AsyncParallelBailHook.prototype = null;
|
||||
|
||||
module.exports = AsyncParallelBailHook;
|
||||
|
|
@ -1,37 +0,0 @@
|
|||
/*
|
||||
MIT License http://www.opensource.org/licenses/mit-license.php
|
||||
Author Tobias Koppers @sokra
|
||||
*/
|
||||
"use strict";
|
||||
|
||||
const Hook = require("./Hook");
|
||||
const HookCodeFactory = require("./HookCodeFactory");
|
||||
|
||||
class AsyncParallelHookCodeFactory extends HookCodeFactory {
|
||||
content({ onError, onDone }) {
|
||||
return this.callTapsParallel({
|
||||
onError: (i, err, done, doneBreak) => onError(err) + doneBreak(true),
|
||||
onDone
|
||||
});
|
||||
}
|
||||
}
|
||||
|
||||
const factory = new AsyncParallelHookCodeFactory();
|
||||
|
||||
const COMPILE = function(options) {
|
||||
factory.setup(this, options);
|
||||
return factory.create(options);
|
||||
};
|
||||
|
||||
function AsyncParallelHook(args = [], name = undefined) {
|
||||
const hook = new Hook(args, name);
|
||||
hook.constructor = AsyncParallelHook;
|
||||
hook.compile = COMPILE;
|
||||
hook._call = undefined;
|
||||
hook.call = undefined;
|
||||
return hook;
|
||||
}
|
||||
|
||||
AsyncParallelHook.prototype = null;
|
||||
|
||||
module.exports = AsyncParallelHook;
|
||||
|
|
@ -1,42 +0,0 @@
|
|||
/*
|
||||
MIT License http://www.opensource.org/licenses/mit-license.php
|
||||
Author Tobias Koppers @sokra
|
||||
*/
|
||||
"use strict";
|
||||
|
||||
const Hook = require("./Hook");
|
||||
const HookCodeFactory = require("./HookCodeFactory");
|
||||
|
||||
class AsyncSeriesBailHookCodeFactory extends HookCodeFactory {
|
||||
content({ onError, onResult, resultReturns, onDone }) {
|
||||
return this.callTapsSeries({
|
||||
onError: (i, err, next, doneBreak) => onError(err) + doneBreak(true),
|
||||
onResult: (i, result, next) =>
|
||||
`if(${result} !== undefined) {\n${onResult(
|
||||
result
|
||||
)};\n} else {\n${next()}}\n`,
|
||||
resultReturns,
|
||||
onDone
|
||||
});
|
||||
}
|
||||
}
|
||||
|
||||
const factory = new AsyncSeriesBailHookCodeFactory();
|
||||
|
||||
const COMPILE = function(options) {
|
||||
factory.setup(this, options);
|
||||
return factory.create(options);
|
||||
};
|
||||
|
||||
function AsyncSeriesBailHook(args = [], name = undefined) {
|
||||
const hook = new Hook(args, name);
|
||||
hook.constructor = AsyncSeriesBailHook;
|
||||
hook.compile = COMPILE;
|
||||
hook._call = undefined;
|
||||
hook.call = undefined;
|
||||
return hook;
|
||||
}
|
||||
|
||||
AsyncSeriesBailHook.prototype = null;
|
||||
|
||||
module.exports = AsyncSeriesBailHook;
|
||||
|
|
@ -1,37 +0,0 @@
|
|||
/*
|
||||
MIT License http://www.opensource.org/licenses/mit-license.php
|
||||
Author Tobias Koppers @sokra
|
||||
*/
|
||||
"use strict";
|
||||
|
||||
const Hook = require("./Hook");
|
||||
const HookCodeFactory = require("./HookCodeFactory");
|
||||
|
||||
class AsyncSeriesHookCodeFactory extends HookCodeFactory {
|
||||
content({ onError, onDone }) {
|
||||
return this.callTapsSeries({
|
||||
onError: (i, err, next, doneBreak) => onError(err) + doneBreak(true),
|
||||
onDone
|
||||
});
|
||||
}
|
||||
}
|
||||
|
||||
const factory = new AsyncSeriesHookCodeFactory();
|
||||
|
||||
const COMPILE = function(options) {
|
||||
factory.setup(this, options);
|
||||
return factory.create(options);
|
||||
};
|
||||
|
||||
function AsyncSeriesHook(args = [], name = undefined) {
|
||||
const hook = new Hook(args, name);
|
||||
hook.constructor = AsyncSeriesHook;
|
||||
hook.compile = COMPILE;
|
||||
hook._call = undefined;
|
||||
hook.call = undefined;
|
||||
return hook;
|
||||
}
|
||||
|
||||
AsyncSeriesHook.prototype = null;
|
||||
|
||||
module.exports = AsyncSeriesHook;
|
||||
|
|
@ -1,37 +0,0 @@
|
|||
/*
|
||||
MIT License http://www.opensource.org/licenses/mit-license.php
|
||||
Author Tobias Koppers @sokra
|
||||
*/
|
||||
"use strict";
|
||||
|
||||
const Hook = require("./Hook");
|
||||
const HookCodeFactory = require("./HookCodeFactory");
|
||||
|
||||
class AsyncSeriesLoopHookCodeFactory extends HookCodeFactory {
|
||||
content({ onError, onDone }) {
|
||||
return this.callTapsLooping({
|
||||
onError: (i, err, next, doneBreak) => onError(err) + doneBreak(true),
|
||||
onDone
|
||||
});
|
||||
}
|
||||
}
|
||||
|
||||
const factory = new AsyncSeriesLoopHookCodeFactory();
|
||||
|
||||
const COMPILE = function(options) {
|
||||
factory.setup(this, options);
|
||||
return factory.create(options);
|
||||
};
|
||||
|
||||
function AsyncSeriesLoopHook(args = [], name = undefined) {
|
||||
const hook = new Hook(args, name);
|
||||
hook.constructor = AsyncSeriesLoopHook;
|
||||
hook.compile = COMPILE;
|
||||
hook._call = undefined;
|
||||
hook.call = undefined;
|
||||
return hook;
|
||||
}
|
||||
|
||||
AsyncSeriesLoopHook.prototype = null;
|
||||
|
||||
module.exports = AsyncSeriesLoopHook;
|
||||
|
|
@ -1,47 +0,0 @@
|
|||
/*
|
||||
MIT License http://www.opensource.org/licenses/mit-license.php
|
||||
Author Tobias Koppers @sokra
|
||||
*/
|
||||
"use strict";
|
||||
|
||||
const Hook = require("./Hook");
|
||||
const HookCodeFactory = require("./HookCodeFactory");
|
||||
|
||||
class AsyncSeriesWaterfallHookCodeFactory extends HookCodeFactory {
|
||||
content({ onError, onResult, onDone }) {
|
||||
return this.callTapsSeries({
|
||||
onError: (i, err, next, doneBreak) => onError(err) + doneBreak(true),
|
||||
onResult: (i, result, next) => {
|
||||
let code = "";
|
||||
code += `if(${result} !== undefined) {\n`;
|
||||
code += `${this._args[0]} = ${result};\n`;
|
||||
code += `}\n`;
|
||||
code += next();
|
||||
return code;
|
||||
},
|
||||
onDone: () => onResult(this._args[0])
|
||||
});
|
||||
}
|
||||
}
|
||||
|
||||
const factory = new AsyncSeriesWaterfallHookCodeFactory();
|
||||
|
||||
const COMPILE = function(options) {
|
||||
factory.setup(this, options);
|
||||
return factory.create(options);
|
||||
};
|
||||
|
||||
function AsyncSeriesWaterfallHook(args = [], name = undefined) {
|
||||
if (args.length < 1)
|
||||
throw new Error("Waterfall hooks must have at least one argument");
|
||||
const hook = new Hook(args, name);
|
||||
hook.constructor = AsyncSeriesWaterfallHook;
|
||||
hook.compile = COMPILE;
|
||||
hook._call = undefined;
|
||||
hook.call = undefined;
|
||||
return hook;
|
||||
}
|
||||
|
||||
AsyncSeriesWaterfallHook.prototype = null;
|
||||
|
||||
module.exports = AsyncSeriesWaterfallHook;
|
||||
|
|
@ -1,175 +0,0 @@
|
|||
/*
|
||||
MIT License http://www.opensource.org/licenses/mit-license.php
|
||||
Author Tobias Koppers @sokra
|
||||
*/
|
||||
"use strict";
|
||||
|
||||
const util = require("util");
|
||||
|
||||
const deprecateContext = util.deprecate(() => {},
|
||||
"Hook.context is deprecated and will be removed");
|
||||
|
||||
const CALL_DELEGATE = function(...args) {
|
||||
this.call = this._createCall("sync");
|
||||
return this.call(...args);
|
||||
};
|
||||
const CALL_ASYNC_DELEGATE = function(...args) {
|
||||
this.callAsync = this._createCall("async");
|
||||
return this.callAsync(...args);
|
||||
};
|
||||
const PROMISE_DELEGATE = function(...args) {
|
||||
this.promise = this._createCall("promise");
|
||||
return this.promise(...args);
|
||||
};
|
||||
|
||||
class Hook {
|
||||
constructor(args = [], name = undefined) {
|
||||
this._args = args;
|
||||
this.name = name;
|
||||
this.taps = [];
|
||||
this.interceptors = [];
|
||||
this._call = CALL_DELEGATE;
|
||||
this.call = CALL_DELEGATE;
|
||||
this._callAsync = CALL_ASYNC_DELEGATE;
|
||||
this.callAsync = CALL_ASYNC_DELEGATE;
|
||||
this._promise = PROMISE_DELEGATE;
|
||||
this.promise = PROMISE_DELEGATE;
|
||||
this._x = undefined;
|
||||
|
||||
this.compile = this.compile;
|
||||
this.tap = this.tap;
|
||||
this.tapAsync = this.tapAsync;
|
||||
this.tapPromise = this.tapPromise;
|
||||
}
|
||||
|
||||
compile(options) {
|
||||
throw new Error("Abstract: should be overridden");
|
||||
}
|
||||
|
||||
_createCall(type) {
|
||||
return this.compile({
|
||||
taps: this.taps,
|
||||
interceptors: this.interceptors,
|
||||
args: this._args,
|
||||
type: type
|
||||
});
|
||||
}
|
||||
|
||||
_tap(type, options, fn) {
|
||||
if (typeof options === "string") {
|
||||
options = {
|
||||
name: options
|
||||
};
|
||||
} else if (typeof options !== "object" || options === null) {
|
||||
throw new Error("Invalid tap options");
|
||||
}
|
||||
if (typeof options.name !== "string" || options.name === "") {
|
||||
throw new Error("Missing name for tap");
|
||||
}
|
||||
if (typeof options.context !== "undefined") {
|
||||
deprecateContext();
|
||||
}
|
||||
options = Object.assign({ type, fn }, options);
|
||||
options = this._runRegisterInterceptors(options);
|
||||
this._insert(options);
|
||||
}
|
||||
|
||||
tap(options, fn) {
|
||||
this._tap("sync", options, fn);
|
||||
}
|
||||
|
||||
tapAsync(options, fn) {
|
||||
this._tap("async", options, fn);
|
||||
}
|
||||
|
||||
tapPromise(options, fn) {
|
||||
this._tap("promise", options, fn);
|
||||
}
|
||||
|
||||
_runRegisterInterceptors(options) {
|
||||
for (const interceptor of this.interceptors) {
|
||||
if (interceptor.register) {
|
||||
const newOptions = interceptor.register(options);
|
||||
if (newOptions !== undefined) {
|
||||
options = newOptions;
|
||||
}
|
||||
}
|
||||
}
|
||||
return options;
|
||||
}
|
||||
|
||||
withOptions(options) {
|
||||
const mergeOptions = opt =>
|
||||
Object.assign({}, options, typeof opt === "string" ? { name: opt } : opt);
|
||||
|
||||
return {
|
||||
name: this.name,
|
||||
tap: (opt, fn) => this.tap(mergeOptions(opt), fn),
|
||||
tapAsync: (opt, fn) => this.tapAsync(mergeOptions(opt), fn),
|
||||
tapPromise: (opt, fn) => this.tapPromise(mergeOptions(opt), fn),
|
||||
intercept: interceptor => this.intercept(interceptor),
|
||||
isUsed: () => this.isUsed(),
|
||||
withOptions: opt => this.withOptions(mergeOptions(opt))
|
||||
};
|
||||
}
|
||||
|
||||
isUsed() {
|
||||
return this.taps.length > 0 || this.interceptors.length > 0;
|
||||
}
|
||||
|
||||
intercept(interceptor) {
|
||||
this._resetCompilation();
|
||||
this.interceptors.push(Object.assign({}, interceptor));
|
||||
if (interceptor.register) {
|
||||
for (let i = 0; i < this.taps.length; i++) {
|
||||
this.taps[i] = interceptor.register(this.taps[i]);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
_resetCompilation() {
|
||||
this.call = this._call;
|
||||
this.callAsync = this._callAsync;
|
||||
this.promise = this._promise;
|
||||
}
|
||||
|
||||
_insert(item) {
|
||||
this._resetCompilation();
|
||||
let before;
|
||||
if (typeof item.before === "string") {
|
||||
before = new Set([item.before]);
|
||||
} else if (Array.isArray(item.before)) {
|
||||
before = new Set(item.before);
|
||||
}
|
||||
let stage = 0;
|
||||
if (typeof item.stage === "number") {
|
||||
stage = item.stage;
|
||||
}
|
||||
let i = this.taps.length;
|
||||
while (i > 0) {
|
||||
i--;
|
||||
const x = this.taps[i];
|
||||
this.taps[i + 1] = x;
|
||||
const xStage = x.stage || 0;
|
||||
if (before) {
|
||||
if (before.has(x.name)) {
|
||||
before.delete(x.name);
|
||||
continue;
|
||||
}
|
||||
if (before.size > 0) {
|
||||
continue;
|
||||
}
|
||||
}
|
||||
if (xStage > stage) {
|
||||
continue;
|
||||
}
|
||||
i++;
|
||||
break;
|
||||
}
|
||||
this.taps[i] = item;
|
||||
}
|
||||
}
|
||||
|
||||
Object.setPrototypeOf(Hook.prototype, null);
|
||||
|
||||
module.exports = Hook;
|
||||
|
|
@ -1,407 +0,0 @@
|
|||
/*
|
||||
MIT License http://www.opensource.org/licenses/mit-license.php
|
||||
Author Tobias Koppers @sokra
|
||||
*/
|
||||
"use strict";
|
||||
|
||||
class HookCodeFactory {
|
||||
constructor(config) {
|
||||
this.config = config;
|
||||
this.options = undefined;
|
||||
this._args = undefined;
|
||||
}
|
||||
|
||||
create(options) {
|
||||
this.init(options);
|
||||
let fn;
|
||||
switch (this.options.type) {
|
||||
case "sync":
|
||||
fn = new Function(
|
||||
this.args(),
|
||||
'"use strict";\n' +
|
||||
this.header() +
|
||||
this.content({
|
||||
onError: err => `throw ${err};\n`,
|
||||
onResult: result => `return ${result};\n`,
|
||||
resultReturns: true,
|
||||
onDone: () => "",
|
||||
rethrowIfPossible: true
|
||||
})
|
||||
);
|
||||
break;
|
||||
case "async":
|
||||
fn = new Function(
|
||||
this.args({
|
||||
after: "_callback"
|
||||
}),
|
||||
'"use strict";\n' +
|
||||
this.header() +
|
||||
this.content({
|
||||
onError: err => `_callback(${err});\n`,
|
||||
onResult: result => `_callback(null, ${result});\n`,
|
||||
onDone: () => "_callback();\n"
|
||||
})
|
||||
);
|
||||
break;
|
||||
case "promise":
|
||||
let errorHelperUsed = false;
|
||||
const content = this.content({
|
||||
onError: err => {
|
||||
errorHelperUsed = true;
|
||||
return `_error(${err});\n`;
|
||||
},
|
||||
onResult: result => `_resolve(${result});\n`,
|
||||
onDone: () => "_resolve();\n"
|
||||
});
|
||||
let code = "";
|
||||
code += '"use strict";\n';
|
||||
code += "return new Promise((_resolve, _reject) => {\n";
|
||||
if (errorHelperUsed) {
|
||||
code += "var _sync = true;\n";
|
||||
code += "function _error(_err) {\n";
|
||||
code += "if(_sync)\n";
|
||||
code += "_resolve(Promise.resolve().then(() => { throw _err; }));\n";
|
||||
code += "else\n";
|
||||
code += "_reject(_err);\n";
|
||||
code += "};\n";
|
||||
}
|
||||
code += this.header();
|
||||
code += content;
|
||||
if (errorHelperUsed) {
|
||||
code += "_sync = false;\n";
|
||||
}
|
||||
code += "});\n";
|
||||
fn = new Function(this.args(), code);
|
||||
break;
|
||||
}
|
||||
this.deinit();
|
||||
return fn;
|
||||
}
|
||||
|
||||
setup(instance, options) {
|
||||
instance._x = options.taps.map(t => t.fn);
|
||||
}
|
||||
|
||||
/**
|
||||
* @param {{ type: "sync" | "promise" | "async", taps: Array<Tap>, interceptors: Array<Interceptor> }} options
|
||||
*/
|
||||
init(options) {
|
||||
this.options = options;
|
||||
this._args = options.args.slice();
|
||||
}
|
||||
|
||||
deinit() {
|
||||
this.options = undefined;
|
||||
this._args = undefined;
|
||||
}
|
||||
|
||||
header() {
|
||||
let code = "";
|
||||
if (this.needContext()) {
|
||||
code += "var _context = {};\n";
|
||||
} else {
|
||||
code += "var _context;\n";
|
||||
}
|
||||
code += "var _x = this._x;\n";
|
||||
if (this.options.interceptors.length > 0) {
|
||||
code += "var _taps = this.taps;\n";
|
||||
code += "var _interceptors = this.interceptors;\n";
|
||||
}
|
||||
for (let i = 0; i < this.options.interceptors.length; i++) {
|
||||
const interceptor = this.options.interceptors[i];
|
||||
if (interceptor.call) {
|
||||
code += `${this.getInterceptor(i)}.call(${this.args({
|
||||
before: interceptor.context ? "_context" : undefined
|
||||
})});\n`;
|
||||
}
|
||||
}
|
||||
return code;
|
||||
}
|
||||
|
||||
needContext() {
|
||||
for (const tap of this.options.taps) if (tap.context) return true;
|
||||
return false;
|
||||
}
|
||||
|
||||
callTap(tapIndex, { onError, onResult, onDone, rethrowIfPossible }) {
|
||||
let code = "";
|
||||
let hasTapCached = false;
|
||||
for (let i = 0; i < this.options.interceptors.length; i++) {
|
||||
const interceptor = this.options.interceptors[i];
|
||||
if (interceptor.tap) {
|
||||
if (!hasTapCached) {
|
||||
code += `var _tap${tapIndex} = ${this.getTap(tapIndex)};\n`;
|
||||
hasTapCached = true;
|
||||
}
|
||||
code += `${this.getInterceptor(i)}.tap(${
|
||||
interceptor.context ? "_context, " : ""
|
||||
}_tap${tapIndex});\n`;
|
||||
}
|
||||
}
|
||||
code += `var _fn${tapIndex} = ${this.getTapFn(tapIndex)};\n`;
|
||||
const tap = this.options.taps[tapIndex];
|
||||
switch (tap.type) {
|
||||
case "sync":
|
||||
if (!rethrowIfPossible) {
|
||||
code += `var _hasError${tapIndex} = false;\n`;
|
||||
code += "try {\n";
|
||||
}
|
||||
if (onResult) {
|
||||
code += `var _result${tapIndex} = _fn${tapIndex}(${this.args({
|
||||
before: tap.context ? "_context" : undefined
|
||||
})});\n`;
|
||||
} else {
|
||||
code += `_fn${tapIndex}(${this.args({
|
||||
before: tap.context ? "_context" : undefined
|
||||
})});\n`;
|
||||
}
|
||||
if (!rethrowIfPossible) {
|
||||
code += "} catch(_err) {\n";
|
||||
code += `_hasError${tapIndex} = true;\n`;
|
||||
code += onError("_err");
|
||||
code += "}\n";
|
||||
code += `if(!_hasError${tapIndex}) {\n`;
|
||||
}
|
||||
if (onResult) {
|
||||
code += onResult(`_result${tapIndex}`);
|
||||
}
|
||||
if (onDone) {
|
||||
code += onDone();
|
||||
}
|
||||
if (!rethrowIfPossible) {
|
||||
code += "}\n";
|
||||
}
|
||||
break;
|
||||
case "async":
|
||||
let cbCode = "";
|
||||
if (onResult) cbCode += `(_err${tapIndex}, _result${tapIndex}) => {\n`;
|
||||
else cbCode += `_err${tapIndex} => {\n`;
|
||||
cbCode += `if(_err${tapIndex}) {\n`;
|
||||
cbCode += onError(`_err${tapIndex}`);
|
||||
cbCode += "} else {\n";
|
||||
if (onResult) {
|
||||
cbCode += onResult(`_result${tapIndex}`);
|
||||
}
|
||||
if (onDone) {
|
||||
cbCode += onDone();
|
||||
}
|
||||
cbCode += "}\n";
|
||||
cbCode += "}";
|
||||
code += `_fn${tapIndex}(${this.args({
|
||||
before: tap.context ? "_context" : undefined,
|
||||
after: cbCode
|
||||
})});\n`;
|
||||
break;
|
||||
case "promise":
|
||||
code += `var _hasResult${tapIndex} = false;\n`;
|
||||
code += `var _promise${tapIndex} = _fn${tapIndex}(${this.args({
|
||||
before: tap.context ? "_context" : undefined
|
||||
})});\n`;
|
||||
code += `if (!_promise${tapIndex} || !_promise${tapIndex}.then)\n`;
|
||||
code += ` throw new Error('Tap function (tapPromise) did not return promise (returned ' + _promise${tapIndex} + ')');\n`;
|
||||
code += `_promise${tapIndex}.then(_result${tapIndex} => {\n`;
|
||||
code += `_hasResult${tapIndex} = true;\n`;
|
||||
if (onResult) {
|
||||
code += onResult(`_result${tapIndex}`);
|
||||
}
|
||||
if (onDone) {
|
||||
code += onDone();
|
||||
}
|
||||
code += `}, _err${tapIndex} => {\n`;
|
||||
code += `if(_hasResult${tapIndex}) throw _err${tapIndex};\n`;
|
||||
code += onError(`_err${tapIndex}`);
|
||||
code += "});\n";
|
||||
break;
|
||||
}
|
||||
return code;
|
||||
}
|
||||
|
||||
callTapsSeries({
|
||||
onError,
|
||||
onResult,
|
||||
resultReturns,
|
||||
onDone,
|
||||
doneReturns,
|
||||
rethrowIfPossible
|
||||
}) {
|
||||
if (this.options.taps.length === 0) return onDone();
|
||||
const firstAsync = this.options.taps.findIndex(t => t.type !== "sync");
|
||||
const somethingReturns = resultReturns || doneReturns || false;
|
||||
let code = "";
|
||||
let current = onDone;
|
||||
for (let j = this.options.taps.length - 1; j >= 0; j--) {
|
||||
const i = j;
|
||||
const unroll = current !== onDone && this.options.taps[i].type !== "sync";
|
||||
if (unroll) {
|
||||
code += `function _next${i}() {\n`;
|
||||
code += current();
|
||||
code += `}\n`;
|
||||
current = () => `${somethingReturns ? "return " : ""}_next${i}();\n`;
|
||||
}
|
||||
const done = current;
|
||||
const doneBreak = skipDone => {
|
||||
if (skipDone) return "";
|
||||
return onDone();
|
||||
};
|
||||
const content = this.callTap(i, {
|
||||
onError: error => onError(i, error, done, doneBreak),
|
||||
onResult:
|
||||
onResult &&
|
||||
(result => {
|
||||
return onResult(i, result, done, doneBreak);
|
||||
}),
|
||||
onDone: !onResult && done,
|
||||
rethrowIfPossible:
|
||||
rethrowIfPossible && (firstAsync < 0 || i < firstAsync)
|
||||
});
|
||||
current = () => content;
|
||||
}
|
||||
code += current();
|
||||
return code;
|
||||
}
|
||||
|
||||
callTapsLooping({ onError, onDone, rethrowIfPossible }) {
|
||||
if (this.options.taps.length === 0) return onDone();
|
||||
const syncOnly = this.options.taps.every(t => t.type === "sync");
|
||||
let code = "";
|
||||
if (!syncOnly) {
|
||||
code += "var _looper = () => {\n";
|
||||
code += "var _loopAsync = false;\n";
|
||||
}
|
||||
code += "var _loop;\n";
|
||||
code += "do {\n";
|
||||
code += "_loop = false;\n";
|
||||
for (let i = 0; i < this.options.interceptors.length; i++) {
|
||||
const interceptor = this.options.interceptors[i];
|
||||
if (interceptor.loop) {
|
||||
code += `${this.getInterceptor(i)}.loop(${this.args({
|
||||
before: interceptor.context ? "_context" : undefined
|
||||
})});\n`;
|
||||
}
|
||||
}
|
||||
code += this.callTapsSeries({
|
||||
onError,
|
||||
onResult: (i, result, next, doneBreak) => {
|
||||
let code = "";
|
||||
code += `if(${result} !== undefined) {\n`;
|
||||
code += "_loop = true;\n";
|
||||
if (!syncOnly) code += "if(_loopAsync) _looper();\n";
|
||||
code += doneBreak(true);
|
||||
code += `} else {\n`;
|
||||
code += next();
|
||||
code += `}\n`;
|
||||
return code;
|
||||
},
|
||||
onDone:
|
||||
onDone &&
|
||||
(() => {
|
||||
let code = "";
|
||||
code += "if(!_loop) {\n";
|
||||
code += onDone();
|
||||
code += "}\n";
|
||||
return code;
|
||||
}),
|
||||
rethrowIfPossible: rethrowIfPossible && syncOnly
|
||||
});
|
||||
code += "} while(_loop);\n";
|
||||
if (!syncOnly) {
|
||||
code += "_loopAsync = true;\n";
|
||||
code += "};\n";
|
||||
code += "_looper();\n";
|
||||
}
|
||||
return code;
|
||||
}
|
||||
|
||||
callTapsParallel({
|
||||
onError,
|
||||
onResult,
|
||||
onDone,
|
||||
rethrowIfPossible,
|
||||
onTap = (i, run) => run()
|
||||
}) {
|
||||
if (this.options.taps.length <= 1) {
|
||||
return this.callTapsSeries({
|
||||
onError,
|
||||
onResult,
|
||||
onDone,
|
||||
rethrowIfPossible
|
||||
});
|
||||
}
|
||||
let code = "";
|
||||
code += "do {\n";
|
||||
code += `var _counter = ${this.options.taps.length};\n`;
|
||||
if (onDone) {
|
||||
code += "var _done = () => {\n";
|
||||
code += onDone();
|
||||
code += "};\n";
|
||||
}
|
||||
for (let i = 0; i < this.options.taps.length; i++) {
|
||||
const done = () => {
|
||||
if (onDone) return "if(--_counter === 0) _done();\n";
|
||||
else return "--_counter;";
|
||||
};
|
||||
const doneBreak = skipDone => {
|
||||
if (skipDone || !onDone) return "_counter = 0;\n";
|
||||
else return "_counter = 0;\n_done();\n";
|
||||
};
|
||||
code += "if(_counter <= 0) break;\n";
|
||||
code += onTap(
|
||||
i,
|
||||
() =>
|
||||
this.callTap(i, {
|
||||
onError: error => {
|
||||
let code = "";
|
||||
code += "if(_counter > 0) {\n";
|
||||
code += onError(i, error, done, doneBreak);
|
||||
code += "}\n";
|
||||
return code;
|
||||
},
|
||||
onResult:
|
||||
onResult &&
|
||||
(result => {
|
||||
let code = "";
|
||||
code += "if(_counter > 0) {\n";
|
||||
code += onResult(i, result, done, doneBreak);
|
||||
code += "}\n";
|
||||
return code;
|
||||
}),
|
||||
onDone:
|
||||
!onResult &&
|
||||
(() => {
|
||||
return done();
|
||||
}),
|
||||
rethrowIfPossible
|
||||
}),
|
||||
done,
|
||||
doneBreak
|
||||
);
|
||||
}
|
||||
code += "} while(false);\n";
|
||||
return code;
|
||||
}
|
||||
|
||||
args({ before, after } = {}) {
|
||||
let allArgs = this._args;
|
||||
if (before) allArgs = [before].concat(allArgs);
|
||||
if (after) allArgs = allArgs.concat(after);
|
||||
if (allArgs.length === 0) {
|
||||
return "";
|
||||
} else {
|
||||
return allArgs.join(", ");
|
||||
}
|
||||
}
|
||||
|
||||
getTapFn(idx) {
|
||||
return `_x[${idx}]`;
|
||||
}
|
||||
|
||||
getTap(idx) {
|
||||
return `_taps[${idx}]`;
|
||||
}
|
||||
|
||||
getInterceptor(idx) {
|
||||
return `_interceptors[${idx}]`;
|
||||
}
|
||||
}
|
||||
|
||||
module.exports = HookCodeFactory;
|
||||
|
|
@ -1,61 +0,0 @@
|
|||
/*
|
||||
MIT License http://www.opensource.org/licenses/mit-license.php
|
||||
Author Tobias Koppers @sokra
|
||||
*/
|
||||
"use strict";
|
||||
|
||||
const util = require("util");
|
||||
|
||||
const defaultFactory = (key, hook) => hook;
|
||||
|
||||
class HookMap {
|
||||
constructor(factory, name = undefined) {
|
||||
this._map = new Map();
|
||||
this.name = name;
|
||||
this._factory = factory;
|
||||
this._interceptors = [];
|
||||
}
|
||||
|
||||
get(key) {
|
||||
return this._map.get(key);
|
||||
}
|
||||
|
||||
for(key) {
|
||||
const hook = this.get(key);
|
||||
if (hook !== undefined) {
|
||||
return hook;
|
||||
}
|
||||
let newHook = this._factory(key);
|
||||
const interceptors = this._interceptors;
|
||||
for (let i = 0; i < interceptors.length; i++) {
|
||||
newHook = interceptors[i].factory(key, newHook);
|
||||
}
|
||||
this._map.set(key, newHook);
|
||||
return newHook;
|
||||
}
|
||||
|
||||
intercept(interceptor) {
|
||||
this._interceptors.push(
|
||||
Object.assign(
|
||||
{
|
||||
factory: defaultFactory
|
||||
},
|
||||
interceptor
|
||||
)
|
||||
);
|
||||
}
|
||||
}
|
||||
|
||||
HookMap.prototype.tap = util.deprecate(function(key, options, fn) {
|
||||
return this.for(key).tap(options, fn);
|
||||
}, "HookMap#tap(key,…) is deprecated. Use HookMap#for(key).tap(…) instead.");
|
||||
|
||||
HookMap.prototype.tapAsync = util.deprecate(function(key, options, fn) {
|
||||
return this.for(key).tapAsync(options, fn);
|
||||
}, "HookMap#tapAsync(key,…) is deprecated. Use HookMap#for(key).tapAsync(…) instead.");
|
||||
|
||||
HookMap.prototype.tapPromise = util.deprecate(function(key, options, fn) {
|
||||
return this.for(key).tapPromise(options, fn);
|
||||
}, "HookMap#tapPromise(key,…) is deprecated. Use HookMap#for(key).tapPromise(…) instead.");
|
||||
|
||||
module.exports = HookMap;
|
||||
|
|
@ -1,54 +0,0 @@
|
|||
/*
|
||||
MIT License http://www.opensource.org/licenses/mit-license.php
|
||||
Author Tobias Koppers @sokra
|
||||
*/
|
||||
"use strict";
|
||||
|
||||
const Hook = require("./Hook");
|
||||
|
||||
class MultiHook {
|
||||
constructor(hooks, name = undefined) {
|
||||
this.hooks = hooks;
|
||||
this.name = name;
|
||||
}
|
||||
|
||||
tap(options, fn) {
|
||||
for (const hook of this.hooks) {
|
||||
hook.tap(options, fn);
|
||||
}
|
||||
}
|
||||
|
||||
tapAsync(options, fn) {
|
||||
for (const hook of this.hooks) {
|
||||
hook.tapAsync(options, fn);
|
||||
}
|
||||
}
|
||||
|
||||
tapPromise(options, fn) {
|
||||
for (const hook of this.hooks) {
|
||||
hook.tapPromise(options, fn);
|
||||
}
|
||||
}
|
||||
|
||||
isUsed() {
|
||||
for (const hook of this.hooks) {
|
||||
if (hook.isUsed()) return true;
|
||||
}
|
||||
return false;
|
||||
}
|
||||
|
||||
intercept(interceptor) {
|
||||
for (const hook of this.hooks) {
|
||||
hook.intercept(interceptor);
|
||||
}
|
||||
}
|
||||
|
||||
withOptions(options) {
|
||||
return new MultiHook(
|
||||
this.hooks.map(h => h.withOptions(options)),
|
||||
this.name
|
||||
);
|
||||
}
|
||||
}
|
||||
|
||||
module.exports = MultiHook;
|
||||
|
|
@ -1,51 +0,0 @@
|
|||
/*
|
||||
MIT License http://www.opensource.org/licenses/mit-license.php
|
||||
Author Tobias Koppers @sokra
|
||||
*/
|
||||
"use strict";
|
||||
|
||||
const Hook = require("./Hook");
|
||||
const HookCodeFactory = require("./HookCodeFactory");
|
||||
|
||||
class SyncBailHookCodeFactory extends HookCodeFactory {
|
||||
content({ onError, onResult, resultReturns, onDone, rethrowIfPossible }) {
|
||||
return this.callTapsSeries({
|
||||
onError: (i, err) => onError(err),
|
||||
onResult: (i, result, next) =>
|
||||
`if(${result} !== undefined) {\n${onResult(
|
||||
result
|
||||
)};\n} else {\n${next()}}\n`,
|
||||
resultReturns,
|
||||
onDone,
|
||||
rethrowIfPossible
|
||||
});
|
||||
}
|
||||
}
|
||||
|
||||
const factory = new SyncBailHookCodeFactory();
|
||||
|
||||
const TAP_ASYNC = () => {
|
||||
throw new Error("tapAsync is not supported on a SyncBailHook");
|
||||
};
|
||||
|
||||
const TAP_PROMISE = () => {
|
||||
throw new Error("tapPromise is not supported on a SyncBailHook");
|
||||
};
|
||||
|
||||
const COMPILE = function(options) {
|
||||
factory.setup(this, options);
|
||||
return factory.create(options);
|
||||
};
|
||||
|
||||
function SyncBailHook(args = [], name = undefined) {
|
||||
const hook = new Hook(args, name);
|
||||
hook.constructor = SyncBailHook;
|
||||
hook.tapAsync = TAP_ASYNC;
|
||||
hook.tapPromise = TAP_PROMISE;
|
||||
hook.compile = COMPILE;
|
||||
return hook;
|
||||
}
|
||||
|
||||
SyncBailHook.prototype = null;
|
||||
|
||||
module.exports = SyncBailHook;
|
||||
|
|
@ -1,46 +0,0 @@
|
|||
/*
|
||||
MIT License http://www.opensource.org/licenses/mit-license.php
|
||||
Author Tobias Koppers @sokra
|
||||
*/
|
||||
"use strict";
|
||||
|
||||
const Hook = require("./Hook");
|
||||
const HookCodeFactory = require("./HookCodeFactory");
|
||||
|
||||
class SyncHookCodeFactory extends HookCodeFactory {
|
||||
content({ onError, onDone, rethrowIfPossible }) {
|
||||
return this.callTapsSeries({
|
||||
onError: (i, err) => onError(err),
|
||||
onDone,
|
||||
rethrowIfPossible
|
||||
});
|
||||
}
|
||||
}
|
||||
|
||||
const factory = new SyncHookCodeFactory();
|
||||
|
||||
const TAP_ASYNC = () => {
|
||||
throw new Error("tapAsync is not supported on a SyncHook");
|
||||
};
|
||||
|
||||
const TAP_PROMISE = () => {
|
||||
throw new Error("tapPromise is not supported on a SyncHook");
|
||||
};
|
||||
|
||||
const COMPILE = function(options) {
|
||||
factory.setup(this, options);
|
||||
return factory.create(options);
|
||||
};
|
||||
|
||||
function SyncHook(args = [], name = undefined) {
|
||||
const hook = new Hook(args, name);
|
||||
hook.constructor = SyncHook;
|
||||
hook.tapAsync = TAP_ASYNC;
|
||||
hook.tapPromise = TAP_PROMISE;
|
||||
hook.compile = COMPILE;
|
||||
return hook;
|
||||
}
|
||||
|
||||
SyncHook.prototype = null;
|
||||
|
||||
module.exports = SyncHook;
|
||||
|
|
@ -1,46 +0,0 @@
|
|||
/*
|
||||
MIT License http://www.opensource.org/licenses/mit-license.php
|
||||
Author Tobias Koppers @sokra
|
||||
*/
|
||||
"use strict";
|
||||
|
||||
const Hook = require("./Hook");
|
||||
const HookCodeFactory = require("./HookCodeFactory");
|
||||
|
||||
class SyncLoopHookCodeFactory extends HookCodeFactory {
|
||||
content({ onError, onDone, rethrowIfPossible }) {
|
||||
return this.callTapsLooping({
|
||||
onError: (i, err) => onError(err),
|
||||
onDone,
|
||||
rethrowIfPossible
|
||||
});
|
||||
}
|
||||
}
|
||||
|
||||
const factory = new SyncLoopHookCodeFactory();
|
||||
|
||||
const TAP_ASYNC = () => {
|
||||
throw new Error("tapAsync is not supported on a SyncLoopHook");
|
||||
};
|
||||
|
||||
const TAP_PROMISE = () => {
|
||||
throw new Error("tapPromise is not supported on a SyncLoopHook");
|
||||
};
|
||||
|
||||
const COMPILE = function(options) {
|
||||
factory.setup(this, options);
|
||||
return factory.create(options);
|
||||
};
|
||||
|
||||
function SyncLoopHook(args = [], name = undefined) {
|
||||
const hook = new Hook(args, name);
|
||||
hook.constructor = SyncLoopHook;
|
||||
hook.tapAsync = TAP_ASYNC;
|
||||
hook.tapPromise = TAP_PROMISE;
|
||||
hook.compile = COMPILE;
|
||||
return hook;
|
||||
}
|
||||
|
||||
SyncLoopHook.prototype = null;
|
||||
|
||||
module.exports = SyncLoopHook;
|
||||
|
|
@ -1,57 +0,0 @@
|
|||
/*
|
||||
MIT License http://www.opensource.org/licenses/mit-license.php
|
||||
Author Tobias Koppers @sokra
|
||||
*/
|
||||
"use strict";
|
||||
|
||||
const Hook = require("./Hook");
|
||||
const HookCodeFactory = require("./HookCodeFactory");
|
||||
|
||||
class SyncWaterfallHookCodeFactory extends HookCodeFactory {
|
||||
content({ onError, onResult, resultReturns, rethrowIfPossible }) {
|
||||
return this.callTapsSeries({
|
||||
onError: (i, err) => onError(err),
|
||||
onResult: (i, result, next) => {
|
||||
let code = "";
|
||||
code += `if(${result} !== undefined) {\n`;
|
||||
code += `${this._args[0]} = ${result};\n`;
|
||||
code += `}\n`;
|
||||
code += next();
|
||||
return code;
|
||||
},
|
||||
onDone: () => onResult(this._args[0]),
|
||||
doneReturns: resultReturns,
|
||||
rethrowIfPossible
|
||||
});
|
||||
}
|
||||
}
|
||||
|
||||
const factory = new SyncWaterfallHookCodeFactory();
|
||||
|
||||
const TAP_ASYNC = () => {
|
||||
throw new Error("tapAsync is not supported on a SyncWaterfallHook");
|
||||
};
|
||||
|
||||
const TAP_PROMISE = () => {
|
||||
throw new Error("tapPromise is not supported on a SyncWaterfallHook");
|
||||
};
|
||||
|
||||
const COMPILE = function(options) {
|
||||
factory.setup(this, options);
|
||||
return factory.create(options);
|
||||
};
|
||||
|
||||
function SyncWaterfallHook(args = [], name = undefined) {
|
||||
if (args.length < 1)
|
||||
throw new Error("Waterfall hooks must have at least one argument");
|
||||
const hook = new Hook(args, name);
|
||||
hook.constructor = SyncWaterfallHook;
|
||||
hook.tapAsync = TAP_ASYNC;
|
||||
hook.tapPromise = TAP_PROMISE;
|
||||
hook.compile = COMPILE;
|
||||
return hook;
|
||||
}
|
||||
|
||||
SyncWaterfallHook.prototype = null;
|
||||
|
||||
module.exports = SyncWaterfallHook;
|
||||
|
|
@ -1,19 +0,0 @@
|
|||
/*
|
||||
MIT License http://www.opensource.org/licenses/mit-license.php
|
||||
Author Tobias Koppers @sokra
|
||||
*/
|
||||
"use strict";
|
||||
|
||||
exports.__esModule = true;
|
||||
exports.SyncHook = require("./SyncHook");
|
||||
exports.SyncBailHook = require("./SyncBailHook");
|
||||
exports.SyncWaterfallHook = require("./SyncWaterfallHook");
|
||||
exports.SyncLoopHook = require("./SyncLoopHook");
|
||||
exports.AsyncParallelHook = require("./AsyncParallelHook");
|
||||
exports.AsyncParallelBailHook = require("./AsyncParallelBailHook");
|
||||
exports.AsyncSeriesHook = require("./AsyncSeriesHook");
|
||||
exports.AsyncSeriesBailHook = require("./AsyncSeriesBailHook");
|
||||
exports.AsyncSeriesLoopHook = require("./AsyncSeriesLoopHook");
|
||||
exports.AsyncSeriesWaterfallHook = require("./AsyncSeriesWaterfallHook");
|
||||
exports.HookMap = require("./HookMap");
|
||||
exports.MultiHook = require("./MultiHook");
|
||||
|
|
@ -1,41 +0,0 @@
|
|||
{
|
||||
"name": "tapable",
|
||||
"version": "2.0.0-beta.8",
|
||||
"author": "Tobias Koppers @sokra",
|
||||
"description": "Just a little module for plugins.",
|
||||
"license": "MIT",
|
||||
"homepage": "https://github.com/webpack/tapable",
|
||||
"repository": {
|
||||
"type": "git",
|
||||
"url": "http://github.com/webpack/tapable.git"
|
||||
},
|
||||
"devDependencies": {
|
||||
"@babel/core": "^7.4.4",
|
||||
"@babel/preset-env": "^7.4.4",
|
||||
"babel-jest": "^24.8.0",
|
||||
"codecov": "^3.5.0",
|
||||
"jest": "^24.8.0",
|
||||
"prettier": "^1.17.1"
|
||||
},
|
||||
"engines": {
|
||||
"node": ">=6"
|
||||
},
|
||||
"files": [
|
||||
"lib",
|
||||
"!lib/__tests__",
|
||||
"tapable.d.ts"
|
||||
],
|
||||
"main": "lib/index.js",
|
||||
"types": "./tapable.d.ts",
|
||||
"scripts": {
|
||||
"test": "jest",
|
||||
"travis": "yarn pretty-lint && jest --coverage && codecov",
|
||||
"pretty-lint": "prettier --check lib/*.js lib/__tests__/*.js",
|
||||
"pretty": "prettier --loglevel warn --write lib/*.js lib/__tests__/*.js"
|
||||
},
|
||||
"jest": {
|
||||
"transform": {
|
||||
"__tests__[\\\\/].+\\.js$": "babel-jest"
|
||||
}
|
||||
}
|
||||
}
|
||||
|
|
@ -1,101 +0,0 @@
|
|||
type FixedSizeArray<T extends number, U> = T extends 0
|
||||
? void[]
|
||||
: ReadonlyArray<U> & {
|
||||
0: U;
|
||||
length: T;
|
||||
};
|
||||
type Measure<T extends number> = T extends 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8
|
||||
? T
|
||||
: never;
|
||||
type Append<T extends any[], U> = {
|
||||
0: [U];
|
||||
1: [T[0], U];
|
||||
2: [T[0], T[1], U];
|
||||
3: [T[0], T[1], T[2], U];
|
||||
4: [T[0], T[1], T[2], T[3], U];
|
||||
5: [T[0], T[1], T[2], T[3], T[4], U];
|
||||
6: [T[0], T[1], T[2], T[3], T[4], T[5], U];
|
||||
7: [T[0], T[1], T[2], T[3], T[4], T[5], T[6], U];
|
||||
8: [T[0], T[1], T[2], T[3], T[4], T[5], T[6], T[7], U];
|
||||
}[Measure<T["length"]>];
|
||||
type AsArray<T> = T extends any[] ? T : [T];
|
||||
|
||||
type Callback<E, T> = (error?: E, result?: T) => void;
|
||||
|
||||
type Tap = TapOptions & {
|
||||
name: string;
|
||||
};
|
||||
|
||||
type TapOptions = {
|
||||
before?: string;
|
||||
stage?: number;
|
||||
};
|
||||
|
||||
interface HookInterceptor<H> {
|
||||
name?: string;
|
||||
tap?: (tap: Tap) => void;
|
||||
call?: (...args: any[]) => void;
|
||||
loop?: (...args: any[]) => void;
|
||||
register?: (hook: H) => H;
|
||||
}
|
||||
|
||||
type ArgumentNames<T extends any[]> = FixedSizeArray<T["length"], string>;
|
||||
|
||||
declare class Hook<T, R> {
|
||||
constructor(args?: ArgumentNames<AsArray<T>>, name?: string);
|
||||
name: string | undefined;
|
||||
intercept(interceptor: HookInterceptor<Hook<T, R>>): void;
|
||||
isUsed(): boolean;
|
||||
callAsync(...args: Append<AsArray<T>, Callback<Error, R>>): void;
|
||||
promise(...args: AsArray<T>): Promise<R>;
|
||||
tap(options: string | Tap, fn: (...args: AsArray<T>) => R): void;
|
||||
withOptions(options: TapOptions): Hook<T, R>;
|
||||
}
|
||||
|
||||
export class SyncHook<T, R = void> extends Hook<T, R> {
|
||||
call(...args: AsArray<T>): R;
|
||||
}
|
||||
|
||||
export class SyncBailHook<T, R> extends SyncHook<T, R> {}
|
||||
export class SyncLoopHook<T> extends SyncHook<T, void> {}
|
||||
export class SyncWaterfallHook<T> extends SyncHook<T, AsArray<T>[0]> {}
|
||||
|
||||
declare class AsyncHook<T, R> extends Hook<T, R> {
|
||||
tapAsync(
|
||||
options: string | Tap,
|
||||
fn: (...args: Append<AsArray<T>, Callback<Error, R>>) => void
|
||||
): void;
|
||||
tapPromise(
|
||||
options: string | Tap,
|
||||
fn: (...args: AsArray<T>) => Promise<R>
|
||||
): void;
|
||||
}
|
||||
|
||||
export class AsyncParallelHook<T> extends AsyncHook<T, void> {}
|
||||
export class AsyncParallelBailHook<T, R> extends AsyncHook<T, R> {}
|
||||
export class AsyncSeriesHook<T> extends AsyncHook<T, void> {}
|
||||
export class AsyncSeriesBailHook<T, R> extends AsyncHook<T, R> {}
|
||||
export class AsyncSeriesLoopHook<T> extends AsyncHook<T, void> {}
|
||||
export class AsyncSeriesWaterfallHook<T> extends AsyncHook<T, AsArray<T>[0]> {}
|
||||
|
||||
type HookFactory<H> = (key: any, hook?: H) => H;
|
||||
|
||||
interface HookMapInterceptor<H> {
|
||||
factory?: HookFactory<H>;
|
||||
}
|
||||
|
||||
export class HookMap<H> {
|
||||
constructor(factory: HookFactory<H>, name?: string);
|
||||
name: string | undefined;
|
||||
get(key: any): H | undefined;
|
||||
for(key: any): H;
|
||||
intercept(interceptor: HookMapInterceptor<H>): void;
|
||||
}
|
||||
|
||||
export class MultiHook<H> {
|
||||
constructor(hooks: H[], name?: string);
|
||||
name: string | undefined;
|
||||
tap(options: string | Tap, fn?: Function): void;
|
||||
tapAsync(options: string | Tap, fn?: Function): void;
|
||||
tapPromise(options: string | Tap, fn?: Function): void;
|
||||
}
|
||||
Loading…
Reference in New Issue