base-watch

    0.1.3 • Public • Published

    base-watch NPM version Build Status

    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:

    assemble

    var watch = require('base-watch');
     
    var assemble = require('assemble');
    var app = assemble();
     
    app.use(watch());

    assemble-core

    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 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

    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.

    Keywords

    none

    Install

    npm i base-watch

    DownloadsWeekly Downloads

    224

    Version

    0.1.3

    License

    MIT

    Last publish

    Collaborators

    • jonschlinkert
    • doowb