expand-task

expand-task

Expand task definitions in a declarative configuration.

Table of contents

• Install
• Usage
  • More info
• Options
  • options properties
• Related projects
• Running tests
• Contributing
• Author
• License

(Table of contents generated by verb)

Take a look at the examples

Install

Install with npm

$ npm i expand-task --save

Usage

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

Write declarative "task" definitions similar to the config-style used by grunt.

Basic example

task('assemble', {
  docs: {
    options: {
      expand: true
    },
    src: ['test/fixtures/a/**/*.txt'],
    dest: 'dest/'
  }
});

results in

{
  options: {},
  targets: {
    docs: {
      options: {
        expand: true
      },
      files: [
        {
          src: ['test/fixtures/a/a.txt'],
          dest: 'dest/test/fixtures/a/a.txt'
        },
        {
          src: ['test/fixtures/a/aa/aa.txt'],
          dest: 'dest/test/fixtures/a/aa/aa.txt'
        },
        {
          src: ['test/fixtures/a/aa/aaa/aaa.txt'],
          dest: 'dest/test/fixtures/a/aa/aaa/aaa.txt'
        }
      ]
    }
  }
}

flattens dest paths:

task('assemble', {
  site: {
    options: {
      expand: true,
      flatten: true
    },
    src: 'test/fixtures/a/**/*.txt',
    dest: 'dest'
  }
});

results in

{
  options: {},
  targets: {
    site: {
      options: {
        expand: true,
        flatten: true
      },
      files: [
        {
          src: ['test/fixtures/a/a.txt'],
          dest: 'dest/a.txt'
        },
        {
          src: ['test/fixtures/a/aa/aa.txt'],
          dest: 'dest/aa.txt'
        },
        {
          src: ['test/fixtures/a/aa/aaa/aaa.txt'],
          dest: 'dest/aaa.txt'
        }
      ]
    }
  }
}

More info

Take a look at examples.md, it shows lots of different ways to define tasks.

Also:

• Visit expand-target for the full range of target options and documentation.
• Visit [expand-files][] for the full range of files options and documentation.

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});

Related projects

• expand-config: Expand tasks, targets and options in a declarative configuraiton. | 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
• files-objects: Expand files objects into src-dest mappings. | homepage

Running tests

Install dev dependencies:

$ npm i -d && npm test

Contributing

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

Author

Jon Schlinkert

• github/jonschlinkert
• twitter/jonschlinkert

License

Copyright © 2015 Jon Schlinkert Released under the MIT license.

This file was generated by verb-cli on August 29, 2015.