base-watch

base-watch

Watch plugin for base applications.

Heads up this plugin should be used with base-tasks.

Install

Install with npm:

$ npm i base-watch --save

Usage

var watch = require('base-watch');

API

.plugin

Adds a watch method to your app that takes a file, directory, or glob pattern and watches for changes to those files. When a change occurs, the specified task(s) or function will execute.

If no task(s) or function is specified, only the instance of FSWatcher is returned and can be used directly. See chokidar.watch for more information.

• returns {Function}: plugin function to be used in a base application.

Example

app.use(watch());

watch

Watch a file, directory, or glob pattern for changes and build a task or list of tasks when changes are made. Watch is powered by chokidar so arguments can be anything supported by chokidar.watch.

Params

• glob {String|Array}: Filename, Directory name, or glob pattern to watch
• options {Object}: Additional options to be passed to chokidar
• tasks {String|Array|Function}: Tasks that are passed to .build when files in the glob are changed.
• returns {Object}: Returns an instance of FSWatcher from chokidar

Example

var watcher = app.watch('templates/pages/*.hbs', ['site']);

Related projects

• base: base is the foundation for creating modular, unit testable and highly pluggable node.js applications, starting… more | homepage
• base-tasks: base-methods plugin that provides a very thin wrapper around https://github.com/jonschlinkert/composer for adding task methods to… more | homepage
• chokidar: A neat wrapper around node.js fs.watch / fs.watchFile / fsevents. | homepage
• composer: API-first task runner with three methods: task, run and watch. | homepage

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

Brian Woodward

• github/doowb
• twitter/doowb

License

Copyright © 2016 Brian Woodward Released under the MIT license.

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