Expand tasks, targets and files in a declarative configuration.
(TOC generated by verb using markdown-toc)
Install with npm:
$ npm i expand-config --save
Expand a declarative configuration with tasks, targets and files mappings. Optionally pass a name as the first argument.
var config = require('expand-config');
config({
site: {
src: 'templates/*.hbs',
dest: 'site/'
},
blog: {
src: 'content/*.md',
dest: 'site/blog/'
}
});
Expand a declarative configuration with tasks and targets. Create a new Config with the given options
Params
options {Object}Example
var config = new Config();
// example usage
config.expand({
jshint: {
src: ['*.js', 'lib/*.js']
}
});
Expand and normalize a declarative configuration into tasks, targets, and options.
Params
config {Object}: Config object with tasks and/or targets.returns {Object}Example
config.expand({
options: {},
assemble: {
site: {
mapDest: true,
src: 'templates/*.hbs',
dest: 'site/'
},
docs: {
src: 'content/*.md',
dest: 'site/docs/'
}
}
});
Add a task to the config, while also normalizing targets with src-dest mappings and expanding glob patterns in each target.
Params
name {String}: the task's nameconfig {Object}: Task object where each key is a target or options.returns {Object}Example
task.addTask('assemble', {
site: {src: '*.hbs', dest: 'templates/'},
docs: {src: '*.md', dest: 'content/'}
});
Add a target to the config, while also normalizing src-dest mappings and expanding glob patterns in the target.
Params
name {String}: The target's nametarget {Object}: Target object with a files property, or src and optionally a dest property.returns {Object}Example
config.addTarget({src: '*.hbs', dest: 'templates/'});
See the plugins documentation.
The unit tests have lots of good usage examples. You can visit the following libraries if you want to dive deeper into the API/features and options for each configuration type.
Visit expand-task to see the docs and full range of options for task expansion.
Visit expand-target to see the docs and full range of options for target expansion.
Visit expand-files to see the docs and full range of options for files expansion.
Install dev dependencies:
$ npm i -d && npm test
Pull requests and stars are always welcome. For bugs and feature requests, please create an issue.
Jon Schlinkert
Copyright © 2014-2016 Jon Schlinkert Released under the MIT license.
This file was generated by verb on January 06, 2016.