expand-files

Expand glob patterns in a declarative configuration into src-dest mappings.

Install

Install with npm:

$ npm install --save expand-files

Examples

Expands src glob patterns and creates dest mappings:

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

// pass any "global" options to `files`
config = files({cwd: 'test/fixtures'});

// src, dest list
config.expand('*.txt', 'dist/');

// expand src-dest object 
config.expand({
  src: '*.txt',
  dest: 'dist/'
});

// expand src-dest mappings 
config.expand({
  'dist/': '*.txt'
});

// expand files objects
config.expand({
  files: {
    'dist/': '*.txt'
  }
});

// expand files arrays
config.expand({
  files: [
    {src: '*.txt', dest: 'dist/'}
    //...
  ]
});

Results

All of the above result in the following array:

[
  {src: ['test/fixtures/a.txt'], dest: 'dist/a.txt'},
  {src: ['test/fixtures/b.txt'], dest: 'dist/b.txt'},
  {src: ['test/fixtures/c.txt'], dest: 'dist/c.txt'},
  {src: ['test/fixtures/d.txt'], dest: 'dist/d.txt'}
]

See examples of possible configurations.

Table of contents

Install

Install with npm:

$ npm install --save expand-files

Usage

var files = require('expand-files');
var config = files(options);

// pass a list of arguments
config.expand('src', 'dest', options);

// or an object with `src`/`dest`
config.expand({
  options: options,
  src: ['src'], 
  dest: 'dest'
});

// or an object with a `files` object
config.expand({
  options: options,
  files: {
    src: 'src',
    dest: 'dest'
  }
});

// or an object with `files` mappings
config.expand({
  options: options,
  files: {
    'foo/': '*.js',
    'bar/': '*.js',
    'baz/': '*.js'
  }
});

// or an object with an array of `files` objects
config.expand({
  options: options,
  files: [
    {src: 'src', dest: 'dest'}
  ]
});

// or an object with an array of glob patterns
config.expand({
  options: options,
  files: ['*.js', '*.txt']
});

dest behavior

By default, src is appended to the defined dest. If flatten is true, then src basename is appended to dest.

Examples

config.expand({src: 'index.js', dest: 'dist/'});
//=> [ { src: [ 'index.js' ], dest: 'dist/' } ]

config.expand({src: 'index.js', dest: 'dist/', mapDest: true});
//=> [{ src: [ 'index.js' ], dest: 'dist/index.js' } ]

Plugins

Plugins can be used to modify to resulting object. A plugin is a function that takes config as its only parameter.

Example

var config = new Files();
function addFoo(config) {
  config.foo = 'bar';
}
config.use(addFoo);
console.log(config.expand({src: '*.js'}).files);

Results in an object that looks something like:

{
  options: {},
  foo: 'bar', //<= our added property
  files: [{ 
    options: {}, 
    src: ['examples.js', 'gulpfile.js', 'index.js', 'utils.js'], 
    dest: '' } 
  ] 
}

Nodes

It's also possible to modify individual files nodes as they're created on the files array. To do so, simply return a function in the plugin and it will be called on each node.

Additionally, you can either modify the node before it's normalized or after, by checking for the rawNode property or filesNode respectively.

Examples

var config = new Files();
function updateNode(config) {
  config.foo = 'bar';

  return function fn(node) {
    if (!node.filesNode) return fn;
    // return the plugin function if it's not a filesNode
    // this way we know with certainty that `node`
    // will be a filesNode
    node.options.one = 'two';
    node.dest = 'baz/';
    node.abc = 'xyz';
  };
}
config.use(updateNode);
console.log(config.expand({src: '*.js'}).files);

Results in an object that looks something like:

{
  options: {},
  foo: 'bar', //<= our added `config` property
  files: [{ 
    options: { one: 'two' }, 
    src: ['examples.js', 'gulpfile.js', 'index.js', 'utils.js'], 
    dest: 'baz/',
    abc: 'xyz' } 
  ] 
}

Examples

Supports any of the formats supported by the files-objects library as well as any of the configurations in examples.md.

options

mapDest

Expand src-dest mappings. Creates a dest filepath for each src filepath.

Type: Boolean

Default: undefined

Example:

config.expand({src: 'test/fixtures/*.js', dest: 'dist/', mapDest: true});

results in

[ 
  {src: [ 'test/fixtures/x.js' ], dest: 'dist/test/fixtures/x.js' },
  {src: [ 'test/fixtures/y.js' ], dest: 'dist/test/fixtures/y.js' },
  {src: [ 'test/fixtures/z.js' ], dest: 'dist/test/fixtures/z.js' } 
]

flatten

Flatten destination paths. Joins the src basename to the defined dest path.

Type: Boolean

Default: undefined

Example:

config.expand({src: 'test/fixtures/*.js', dest: 'dist/', mapDest: true, flatten: true});

results in

[ 
  {src: [ 'test/fixtures/x.js' ], dest: 'dist/x.js' },
  {src: [ 'test/fixtures/y.js' ], dest: 'dist/y.js' },
  {src: [ 'test/fixtures/z.js' ], dest: 'dist/z.js' } 
]

ext

The extension to use on dest files.

Type: String

Default: undefined

Example:

config.expand({src: '*.coffee', dest: 'dist/', ext: '.js'});

extDot

The part of the extension to use on dest files when the extension is automatically mapped from src files.

Type: String

Default: undefined

Choices:

• first: everything after the first dot
• last: everything after the last dot

Example:

config.expand({src: '*.js', dest: 'dist/', extDot: 'first'});

cwd

Type: String

Default: undefined

Example:

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

rename

Type: Function

Default: src is appended to the defined dest. If flatten is true, then src basename is appended to dest.

Example:

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

filter

Filter by fs.lstat "type" or using a custom filter function.

Type: Function|String.

Default: undefined

Example:

Filter by fs.lstat method name:

config.expand({src: '**/*', dest: 'dist/', filter: 'isFile'});

Filter function:

config.expand({
  options: {
    filter: function (str) {
      return !/DS_Store/.test(str);
    }
  },
  // dotfiles
  src: ['.*']
});

// [ { src:
//      [ '.editorconfig',
//        '.git',
//        '.gitattributes',
//        '.gitignore',
//        '.jshintrc',
//        '.travis.yml',
//        '.verb.md' ],
//     dest: '' } ]

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
• mapDest
• ext
• extDot
• extend
• flatten
• rename
• process
• srcBase

example

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

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

Both result in something like:

{
  options: { mapDest: true },
  files:
   [ { options: {}, src: [...], dest: 'dist/examples.js' },
     { options: {}, src: [...], dest: 'dist/gulpfile.js' },
     { options: {}, src: [...], dest: 'dist/index.js' },
     { options: {}, src: [...], dest: 'dist/utils.js' } ] 
}

Coverage

Statements   : 100% (106/106)
Branches     : 100% (57/57)
Functions    : 100% (11/11)
Lines        : 100% (104/104)

Related projects

You might also be interested in these projects:

• expand: Recursively resolve templates in an object, string or array. | homepage
• 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
• expand-utils: Utils shared by the expand libs. | homepage
• map-dest: Map the destination path for a file based on the given source path and options. | homepage
• normalize-config: Normalize a declarative configuration with any combination of src-dest mappings, files arrays, files objects and… more | homepage

Contributing

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

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

Or visit the verb-readme-generator project to submit bug reports or pull requests for the readme layout template.

Building docs

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

Generate readme and API documentation with verb:

$ npm install -g verb verb-readme-generator && 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 June 25, 2016.