base-files-process

base-files-process

Plugin for processing files from a declarative configuration.

Table of Contents

• Install
• Usage
• Example
• API
• History
  • v0.2.0 - 2016-07-18
• About
  • Related projects
  • Contributing
  • Building docs
  • Running tests
  • Author
  • License

(TOC generated by verb using markdown-toc)

Install

Install with npm:

$ npm install --save base-files-process

Usage

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

Example

var Base = require('base-app');
var expand = require('expand-files');
var pipeline = require('base-pipeline');
var files = require('base-files-process');
var app = new Base();

app.use(pipeline());
app.use(files());

// 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
var config = expand({
  cwd: fixtures,
  src: '*.txt',
  dest: actual
});

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

API

.processFiles

Process an array of files objects, where each object has a src and dest property.

Params

• files {Array}
• options {Object}
• returns {Stream}

Example

var expand = require('expand-files');
var config = expand({
  cwd: fixtures,
  src: 'b.txt',
  dest: actual
});

app.processFiles(config)
  .on('error', console.log)
  .on('end', console.log);

History

v0.2.0 - 2016-07-18

Breaking changes

• renamed the .process method to .processFiles

About

Related projects

• 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

(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 18, 2016.