Awesome
base-watch
Watch plugin for base applications.
Install
Install with npm:
$ npm install base-watch --save
Heads up this plugin requires the [base-tasks][] plugin to be registered first.
Usage
var watch = require('base-watch');
var Base = require('base');
var base = new Base();
base.use(watch());
If you're using assemble or assemble-core you can add the plugin like this:
var watch = require('base-watch');
var assemble = require('assemble');
var app = assemble();
app.use(watch());
var watch = require('base-watch');
var assemble = require('assemble-core');
var app = assemble();
app.use(watch());
API
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}: Returns the 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 watchoptions
{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 ofFSWatcher
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-generators: Adds project-generator support to your
base
application. | 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
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
Brian Woodward
License
verb © 2016, Brian Woodward. Released under the MIT license.
This file was generated by verb, v0.9.0, on April 06, 2016.