gulp-pilot-merger-preprocess-topo

Installation

Install gulp-pilot-merger-preprocess-topo as a development dependency:

npm install --save-dev gulp-pilot-merger-preprocess-topo

Usage

After you have installed this plugin you can utilize it in your .pilotrc.{js,json} assuming you use gulp-pilot and preprocess:

.pilotrc.js

module.exports = {
    init: {
        'preprocess': 'gulp-pilot-merger-preprocess-topo'
    },
    merger: {
        'preprocess': 'gulp-pilot-merger-preprocess-topo'
    }
};

Or as simple JSON:

.pilotrc.json

{
    "init": {
        "preprocess": "gulp-pilot-merger-preprocess-topo"
    },
    "merger": {
        "preprocess": "gulp-pilot-merger-preprocess-topo"
    }
}

API Documentation

Functions

preprocessTopoInitializor(config)

Initializes preprocess options and sorts dependencies. This function adds a new property called preprocessFeatures holding an array of first level preprocess option keys.

Note: Dependencies are read from preprocessDependencies property.

preprocessTopoMerger(config, defaultConfig)

Merges preprocess options through complementing with a default config file and sorts dependencies. This function adds a new property called preprocessFeatures holding an array of first level preprocess option keys.

Note: Dependencies are read from preprocessDependencies property.

hashToEdges(hash, preprocess) ⇒ Array

Turns a preprocessDependencies hash in an array of edges, consumable by toposort algorithm.

Note: This has also build in support for conditional dependencies.

Typedefs

DependenciesHash : Object.<string, Array.<(string|{condition: string, value: string})>>

A hash containing features and their respective dependencies.

Note: This has also build in support for conditional dependencies.

preprocessTopoInitializor(config)

Initializes preprocess options and sorts dependencies. This function adds a new property called preprocessFeatures holding an array of first level preprocess option keys.

Note: Dependencies are read from preprocessDependencies property.

Kind: global function

Param	Type	Description
config	Object	The default or custom config to be initialized.

preprocessTopoMerger(config, defaultConfig)

Merges preprocess options through complementing with a default config file and sorts dependencies. This function adds a new property called preprocessFeatures holding an array of first level preprocess option keys.

Note: Dependencies are read from preprocessDependencies property.

Kind: global function

Param	Type	Description
config	Object	The new config to be merged with defaultConfig.
defaultConfig	Object	The default config used to complement the new config.

hashToEdges(hash, preprocess) ⇒ Array

Turns a preprocessDependencies hash in an array of edges, consumable by toposort algorithm.

Note: This has also build in support for conditional dependencies.

Kind: global function

Param	Type	Description
hash	DependenciesHash	The preprocessDependencies hash.
preprocess	Object	The preprocess config object.

DependenciesHash : Object.<string, Array.<(string|{condition: string, value: string})>>

A hash containing features and their respective dependencies.

Note: This has also build in support for conditional dependencies.

Kind: global typedef

License

The MIT License (MIT)

Copyright (c) 2016 Andreas Deuschlinger

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.