gentelella/vendors/update/README.md

update

Easily keep anything in your project up-to-date by installing the updaters you want to use and running update in the command line! Update the copyright date, licence type, ensure that a project uses your latest eslint or jshint configuration, remove deprecated package.json fields, or anything you can think of!

CLI

Install

Install globally with npm

$ npm i -g update

Commands

$ update <command> [options]

List updaters

Choose from a list of updaters and tasks to run:

$ update list

Run a specific updater

The following would run updater foo:

$ update foo

# run updater "foo" with options
$ update foo --bar=baz

tasks

(TODO)

plugins

(TODO)

pipeline plugins

(TODO)

instance plugins

(TODO)

middleware

A middleware is a function that exposes the following parameters:

• file: {Object} vinyl file object

• next: {Function} must be called to continue on to the next file.

  function rename(file, next) {
  file.path = 'foo/' + file.path;
  next();
  }
  
  // example usage: prefix all `.js` file paths with `foo/`
  app.onLoad(/\.js/, rename);
  

The onStream method is a custom middleware handler that the update

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: Assemble is a powerful, extendable and easy to use static site generator for node.js. Used… 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 with a user-friendly and expressive API. | homepage
• scaffold: Conventions and API for creating declarative configuration objects for project scaffolds - similar in format… more | homepage
• templates: System for creating and managing template collections, and rendering templates with any node.js template engine.… more | homepage
• update: Update | homepage
• verb: Documentation generator for GitHub projects. Verb is extremely powerful, easy to use, and is used… more | homepage

Authoring

Updaters

(TODO)

Tasks

(TODO)

Middleware

(TODO)

Plugins

Updater plugins follow the same signature as gulp plugins

Example

function myPlugin(options) {
  return through.obj(function(file, enc, next) {
    var str = file.contents.toString();
    // do stuff to `file`
    file.contents = new Buffer(file.contents);
    next(null, file);
  });
}

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 © 2016 Jon Schlinkert Released under the MIT license.

---

This file was generated by verb on January 09, 2016.