A fast, reliable asset pipeline, supporting constant-time rebuilds and compact build definitions. Comparable to the Rails asset pipeline in scope, though it runs on Node and is backend-agnostic. For background and architecture, see the introductory blog post.
For the command line interface, see broccoli-cli.
npm install --save-dev broccolinpm install --global broccoli-cli
Brocfile.js file in the project root contains the build specification. It
should export a tree.
A tree can be any string representing a directory path, like
'src'. Or a tree can be an object conforming to the Plugin API
Brocfile.js will usually
directly work with only directory paths, and then use the plugins in the
Plugins section to generate transformed trees.
The following simple
Brocfile.js would export the
app/ subdirectory as a
moduleexports = 'app'
With that Brocfile, the build result would equal the contents of the
tree in your project folder. For example, say your project contains these
app ├─ main.js └─ helper.js Brocfile.js package.json …
broccoli build the-output (a command provided by
broccoli-cli) would generate
the following folder within your project folder:
the-output ├─ main.js └─ helper.js
Using plugins in a
Brocfile.js exports the
app/ subdirectory as
var Funnel =moduleexports = 'app'destDir: 'appkit'
That example uses the plugin
In order for the
require call to work, you must first put the plugin in
devDependencies and install it, with
npm install --save-dev broccoli-funnel
With the above
Brocfile.js and the file tree from the previous example,
broccoli build the-output would generate the following folder:
the-output └─ appkit ├─ main.js └─ helper.js
You can find plugins under the broccoli-plugin keyword on npm.
Running Broccoli, Directly or Through Other Tools
Shared code for writing plugins.
Plugin API Specification
Also see docs/broccoli-1-0-plugin-api.md on how to upgrade from Broccoli 0.x to the Broccoli 1.x API.
- Do not run
broccoli serveon a production server. While this is theoretically safe, it exposes a needlessly large amount of attack surface just for serving static assets. Instead, use
broccoli buildto precompile your assets, and serve the static files from a web server of your choice.
#broccolijson Freenode. Ask your question and stick around for a few hours. Someone will see your message eventually.
- Twitter: mention @jo_liss with your question
- GitHub: Open an issue on a specific plugin repository, or on this repository for general questions.