Skip to content
Broccoli plugin for referring to source directories on the file system
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
test
.gitignore
.jshintignore
.jshintrc
.npmignore
.travis.yml
CHANGELOG.md
LICENSE
README.md
appveyor.yml
index.js
package.json

README.md

Broccoli Source

Build Status Build status

Broccoli plugin for creating "source" nodes that refer to physical file system directories.

Example Usage

In Brocfile.js:

var broccoliSource = require('broccoli-source');
var WatchedDir = broccoliSource.WatchedDir;
var UnwatchedDir = broccoliSource.UnwatchedDir;

// Refers to the ./lib directory on disk, and watches it.
var lib = new WatchedDir('lib');
// Note: this is equivalent to the deprecated plain-string syntax:
//var lib = 'lib';

// Refers to the ./bower_components/jquery directory, but does not watch it.
var jquery = new UnwatchedDir('bower_components/jquery');

Reference

new WatchedDir(directoryPath, options)

Create a Broccoli node referring to a directory on disk. The Broccoli watcher used by broccoli serve will watch the directory and all subdirectories, and trigger a rebuild whenever something changes.

  • directoryPath: A path to a directory, either absolute, or relative to the working directory (typically the directory containing Brocfile.js).

    The directory must exist, or Broccoli will abort.

  • options

    • annotation: A human-readable description for this node.

new UnwatchedDir(directoryPath, options)

Same as WatchedDir, but the directory will not be watched.

This can be useful for performance reasons. For example, say you want to refer to a large directory hierarchy of third-party code in your Brocfile.js. Such third-party code is rarely edited in practice. Using UnwatchedDir instead of WatchedDir saves the overhead of setting up useless file system watchers.

When in doubt, use WatchedDir instead.

You can’t perform that action at this time.