base-files-each

base-files-each

Base plugin for iterating over an array of 'files' objects in a declarative configuration and writing them to the file system.

Install

Install with npm:

$ npm install base-files-each --save

Usage

var files = require('base-files-each');

Example

var expand = require('expand-files');
var Base = require('base');
var pipeline = require('base-pipeline');
var each = require('base-files-each');
var vfs = require('base-fs');
var app = new Base();

app.use(pipeline());
app.use(each());
app.use(vfs());

// register pipeline plugins using the `.plugin` method
app.plugin('foo', function(options) {
  return through.obj(function(file, enc, next) {
    // do plugin stuff 
    next(null, file);
  });
});

// use `expand-files` to expand a declarative configuration object
config = expand({
  cwd: fixtures,
  src: '*.txt',
  dest: actual
});

// pass the config object to `.each()`
app.each(config)
  .on('end', function() {
    console.log('done!');
  });

API

.each

Iterate over an array of files objects in a declarative configuration, optionally run them through a plugin pipline, then write the files to the file system.

Params

• config {Object}
• cb {Function}: Optional callback function. If callback is not passed, .eachStream is called and a stream is returned.

Example

var expand = require('expand-files');
var config = expand.config({src: '*', dest: 'foo/'});
generate.each({files: [config]}, function(err) {
  if (err) throw err;
  console.log('done!');
});

// or
generate.each({files: [config]})
  .on('end', function() {
    console.log('done!');
  });

.eachSeries

Generate files configurations in series.

Params

• config {Object}
• cb {Function}

Example

var expand = require('expand-files');
var config = expand.config({src: '*', dest: 'foo/'});
generate.eachSeries({files: [config]}, function(err) {
  if (err) throw err;
  console.log('done!');
});

.eachStream

Generate files configurations in parallel.

Params

• config {Object}
• returns {Stream}: returns stream with all process files

Example

var expand = require('expand-files');
var config = expand.config({src: '*', dest: 'foo/'});
generate.eachStream({files: [config]}, options)
  .on('error', console.error)
  .on('end', function() {
    console.log('done!');
  });

Related projects

You might also be interested in these projects:

base-files-process: Plugin for processing files from a declarative configuration. | homepage

• base-fs: base-methods plugin that adds vinyl-fs methods to your 'base' application for working with the file… more | homepage
• base-pipeline: base-methods plugin that adds pipeline and plugin methods for dynamically composing streaming plugin pipelines. | homepage
• base-task: base plugin that provides a very thin wrapper around https://github.com/doowb/composer for adding task methods to… more | homepage
• base: base is the foundation for creating modular, unit testable and highly pluggable node.js applications, starting… more | homepage

Contributing

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

Building docs

Generate readme and API documentation with verb:

$ npm install verb && npm run docs

Or, if verb is installed globally:

$ 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 May 17, 2016.