update

Update

CLI

Install

Install globally with npm

$ npm i -g update

$ update

tasks

plugins

pipeline plugins

instance plugins

middleware

A middleware function takes file and next.

function rename(file, next) {
  file.path = 'foo/' + path.basename(file.path);
  next();
}

Example

The onStream method is a custom middleware handler that the update i

app.onStream(/lib\//, rename);

API

Install

Install with npm

$ npm i update --save

var update = require('update');

API

Update

Create an update application. This is the main function exported by the update module.

Params

• options {Object}

Example

var Update = require('update');
var update = new Update();

Related projects

• assemble: Static site generator for Grunt.js, Yeoman and Node.js. Used by Zurb Foundation, Zurb Ink, H5BP/Effeckt,… more | homepage
• boilerplate: Tools and conventions for authoring and publishing boilerplates that can be generated by any build… more | homepage
• composer: API-first task runner with three methods: task, run and watch. | homepage
• generate: Fast, composable, highly extendable project generator for node.js | homepage
• scaffold: Conventions and API for creating scaffolds that can by used by any build system or… more | homepage
• templates: System for creating and managing template collections, and rendering templates with any node.js template engine.… more | homepage
• update: Update the year in all files in a project using glob patterns. | homepage
• verb: Documentation generator for GitHub projects. Verb is extremely powerful, easy to use, and is used… more | homepage

Authoring

Updaters

Tasks

Middleware

Plugins

Updater plugins follow the same signature as gulp plugins

Example

function foo(options) {
  return through.obj(function (file, enc, cb) {
    var str = file.contents.toString();
    // do stuff
    file.contents = new Buffer(file.contents);
    this.push(file);
    cb();
  });
}

Publish

1. Name your project following the convention: updater-*
2. Don't use dots in the name (e.g .js)
3. Make sure you add updater to the keywords in package.json
4. Tweet about your updater!

Running tests

Install dev dependencies:

$ npm i -d && npm test

Contributing

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

Author

Jon Schlinkert

• github/jonschlinkert
• twitter/jonschlinkert

License

Copyright © 2015 Jon Schlinkert Released under the MIT license.

This file was generated by verb on December 19, 2015.