Package Exports

base-files-process

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (base-files-process) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

base-files-process

Plugin for processing files from a declarative configuration.

Install

Install with npm:

$ npm install base-files-process --save

Usage

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

Example

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

app.use(pipeline());
app.use(files());
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 `.process()`
app.process(config)
  .on('end', function() {
    console.log('done!');
  });

You might also be interested in these 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

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

License

This file was generated by verb, v0.9.0, on May 11, 2016.