Plugins: piscosour
piscosour plugin
Plugin to get information about piscosour configuration.
1. piscoConfig() addon
this.piscoConfig() a function that exposes piscosour configuration library.
It has no parameters.
Example:
run: function(resolve, reject) {
this.logger.info('config?', this.piscoConfig());
return true;
}
This functions are exposed
- this.piscoConfig().get() function
- this.piscoConfig().mergeObject(orig, added) function
- this.piscoConfig().getDir(name) function
- this.piscoConfig().allContexts() function
this.piscoConfig().get()
Return the entire configuration cooked for the execution.
this.piscoConfig().mergeObject(orig, added)
Function that merge recursively two object, always added overwrite orig. Returns the merged object.
string, array -> Overwrite all.
object -> Overwrite only same keys recursively.
this.piscoConfig().getDir(name)
Return the path of a recipe.
this.piscoConfig().allContexts()
Return an array with all contexts present in configuration.
2. piscoFile addon
this.piscoFile a value with the piscosour file name ('piscosour.json').
Example:
run: function(resolve, reject) {
this.logger.info('piscoFile?', this.piscoFile);
return true;
}
3. pkgFile addon
this.pkgFile a value the package file name ('package.json').
Example:
run: function(resolve, reject) {
this.logger.info('pkgFile?', this.pkgFile);
return true;
}
4. Waterfall() addon
this.Waterfall(config) a function that returns an Object to prepare the execution of a list of promises.
| Param | Type | Optional | Description |
|---|---|---|---|
| config | Object | No | An object with the configuration |
Where config object allows these properties:
| Property | Type | Description |
|---|---|---|
| logger | Object | reference to this.logger |
| promise-config | Array | list of promise configuration |
Where promise-config has the following properties:
| Property | Type | Description |
|---|---|---|
| fn | function | function that returns a promise |
| args | Array | The argurments of the function 'fn' |
| obj | Object | Reference to the object this |
Once the object this.Waterfall(config) is created, its function start() returns a promise to start the execution of the promises one after the other.
Example:
run: function(resolve, reject) {
let waterfall = new this.Waterfall({
promises: [{
fn: this.execute,
args: ['echo', 'exec1'],
obj: this
},{
fn: this.execute,
args: ['sleep', '5'],
obj: this
}],
logger: this.logger
});
return waterfall.start().then(resolve, reject);
}