/base-fs-rename

Plugin for 'base' applications that adds a `rename` method that can be passed to `app.dest()` (this is an instance plugin, not pipeline plugin)

Primary LanguageJavaScriptMIT LicenseMIT

base-fs-rename NPM version NPM downloads Build Status

Plugin for 'base' applications that adds a rename method that, when called, can be passed to app.dest() as the rename function (this is an instance plugin, not pipeline plugin)

Install

Install with npm:

$ npm install --save base-fs-rename

Usage

Requires either the base-fs or the assemble-fs plugin to work.

var fs = require('base-fs');
var rename = require('base-fs-rename');
var Base = require('base');
var app = new Base();

app.use(rename());
app.use(fs());

app.src('fixtures/a.txt')
  // pass `app.rename()` to `app.dest()`
  .pipe(app.dest(app.rename('actual')));

Related projects

You might also be interested in these projects:

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

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

License

Copyright © 2016, Jon Schlinkert. Released under the MIT license.


This file was generated by verb, v0.9.0, on June 20, 2016.