expand-target

Expand target definitions in a declarative configuration.

Install

Install with npm:

$ npm install --save expand-target

Usage

var target = require('expand-target');

Write declarative "target" definitions similar in concept to those used by grunt and make. This is useful for shared configs or to dynamically build-up a configuration that can be passed to any build system (even gulp!).

Basic example

target({
  files: {
    'a/': ['*.js'],
    'b/': ['*.js'],
    'c/': ['*.js']
  }
});

results in

{
  files: [
    {
      src: ['examples.js', 'index.js'],
      dest: 'a/'
    },
    {
      src: ['examples.js', 'index.js'],
      dest: 'b/'
    },
    {
      src: ['examples.js', 'index.js'],
      dest: 'c/'
    }
  ]
}

the same example with expand: true defined on the options

target({
  options: { expand: true },
  files: {
    'a/': ['*.js'],
    'b/': ['*.js'],
    'c/': ['*.js']
  }
});

results in

{
  options: {
    expand: true
  },
  files: [
    {
      src: ['examples.js'],
      dest: 'a/examples.js'
    },
    {
      src: ['index.js'],
      dest: 'a/index.js'
    },
    {
      src: ['examples.js'],
      dest: 'b/examples.js'
    },
    {
      src: ['index.js'],
      dest: 'b/index.js'
    },
    {
      src: ['examples.js'],
      dest: 'c/examples.js'
    },
    {
      src: ['index.js'],
      dest: 'c/index.js'
    }
  ]
}

See more examples. Visit expand-files for the full range of options and documentation.

Plugins

Plugins must be registered before the configuration is expanded, which means you need to use the expand method instead of passing your config directly to the constructor.

var target = new Target({cwd: 'foo'});

target
  .use(foo)
  .use(bar)
  .use(baz);

target.expand({
  src: '*.js',
  dest: ''
});

Writing plugins

Plugins are just functions where the only parameter exposed is the current "context".

Examples

In the following plugin, config is the target instance:

target.use(function(config) {
  config.foo = 'bar';
});
console.log(target.foo);
//=> 'bar'

To have the plugin called in a "child" context, like for iterating over files nodes as they're expanded, just return the plugin function until you get the node you want:

target.use(function fn(config) {
  if (!config.node) return fn;
  console.log(config);
});

Contexts

To see all available contexts, just do the following:

target.use(function fn(config) {
  console.log('-----', config._name, '----');
  console.log(config);
  console.log('---------------------------');
  return fn;
});

Options

Any option from expand-files may be used. Please see that project for the full range of options and documentation.

options properties

The below "special" properties are fine to use either on an options object or on the root of the object passed to expand-files.

Either way they will be normalized onto the options object to ensure that globby and consuming libraries are passed the correct arguments.

special properties

• base
• cwd
• destBase
• expand
• ext
• extDot
• extend
• flatten
• rename
• process
• srcBase

example

Both of the following will result in expand being on the options object.

files({src: '*.js', dest: 'dist/', options: {expand: true}});
files({src: '*.js', dest: 'dist/', expand: true});

About

Related projects

• expand-config: Expand tasks, targets and files in a declarative configuration. | homepage
• expand-files: Expand glob patterns in a declarative configuration into src-dest mappings. | homepage
• expand-target: Expand target definitions in a declarative configuration. | homepage
• expand-task: Expand and normalize task definitions in a declarative configuration. | homepage
• files-objects: Expand files objects into src-dest mappings. | homepage

Contributing

Pull requests and stars are always welcome. For bugs and feature requests, please create an issue.

Building docs

(This document was generated by verb-generate-readme (a verb generator), please don't edit the readme directly. Any changes to the readme must be made in .verb.md.)

To generate the readme and API documentation with verb:

$ npm install -g verb verb-generate-readme && verb

Running tests

Install dev dependencies:

$ npm install -d && npm test

Author

Jon Schlinkert

• github/jonschlinkert
• twitter/jonschlinkert

License

Copyright © 2016, Jon Schlinkert. Released under the MIT license.

This file was generated by verb, v0.9.0, on July 19, 2016.