Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
114 lines (72 sloc) 5.757 kb

FAQ

I want to start new project with Brunch. What's the workflow?

  • Create a new project with brunch new <skeleton>.
  • Create static HTML pages in app/assets directory (login.html, user.html etc.) and corresponding styles in app/styles.
  • If you need any app-specific scripts in the browser make sure they are loaded in your html via the require('') function. See the Brunch conventions.
  • Watch application files with brunch watch --server and see the results in browser on localhost:3333. Auto-debug in browser with auto-reload-brunch (npm install --save auto-reload-brunch) which will automatically re-apply styles or reload the page when changes are saved.
  • When all mockups are done, create app classes for them with scaffolt (scaffolt package). E.g. scaffolt view user (you need to have generators directory in your app).
  • Debug your code in browser via console.log or debugger statements.

I don't like CoffeeScript. Does brunch work for pure js projects?

Yep, brunch is language-agnostic! Just create a project from any JS skeleton and customize it to your needs.

How to use Bower?

Brunch supports Bower package manager.

To add packages to your project:

  • Make sure you have bower.json, which can be generated with bower init
  • Add packages to the dependencies field of your bower.json
  • Optionally specify the overrides property for packages without bower.json. This is needed because brunch automatically compiles bower dependencies in right order.
  • Note that overrides do not impact Bower's behavior, so the original dependency graph will still be copied by bower install. But specifying overrides is effective for changing the dependencies that actually get built into your project.

Example app with Bower integration: http://github.com/paulmillr/ostio

I want to create a separate JavaScript file (for a bookmarklet, etc.). What's the best way?

Use this joinTo config. It will compile all files in app/ (except in app/namespace) to one file and all files in app/namespace to another.

joinTo:
  'javascripts/namespace.js': /^app(\/|\\)namespace/
  'javascripts/app.js': /^app(\/|\\)(?!namespace)/
  'javascripts/vendor.js': /^vendor/

How do I uninstall an old plugin and install a new one?

For example, you want to change default Handlebars templates to eco.

  • Remove the "handlebars-brunch": "version" line from package.json.
  • Install eco-brunch: npm install eco-brunch --save.

What version of each plugin do I need to use?

You may have seen that there are eco-brunch 1.0.1, 1.1.0 etc.

Brunch x.y.z releases are compatible with plugins (in this case eco-brunch) x.(<= y).*. This means that:

You can use:

  • brunch 1.1.0 with plugin 1.0.0.
  • brunch 1.1.0 with plugin 1.1.9.
  • brunch 1.9.14 with plugin 1.5.6.

You may encounter problems if you use:

  • brunch 1.1.0 with plugin 1.2.0.
  • brunch 1.1.0 with plugin 2.0.0.
  • brunch 2.0.0 with plugin 1.2.0.

I get an EMFILE error when I build a Brunch project. WTF?

EMFILE means there are too many open files. Brunch watches all your project files and it's usually a pretty big number. You can fix this error with setting max opened file count to a bigger number using the command ulimit -n <number> (10000 should be enough).

How do I enable verbose mode for brunch commands?

TL;DR: Add a DEBUG environment variable, e.g. DEBUG='brunch:*'. Then, when you run brunch watch, you'll see debug output.

Output can be filtered to particular parts of Brunch's internal workflow by modifying the command to something like DEBUG='brunch:pipeline'.

This is useful for explicitly seeing the list of source files that are compiled into each output file (as well as their order).

Linux/OS X:

Add DEBUG='brunch:*' in front of your brunch command for on-demand use, such as DEBUG='brunch:*' brunch build

Or run export DEBUG='brunch:*' to persist the setting for the rest of your terminal session. Optionally, add this to your ~/.bash_profile, ~/.zshrc, etc.

Windows:

Add a System Environment variable via Control Panel > System > Advanced System Settings (Advanced Tab) > Environment Variables: Windows System Environment Variable

I get an error like "MODULE_NOT_FOUND" when I try to run Brunch

You need to install brunch plugins. It can be done simply by executing npm install in your project directory.

What languages do you recommend I use?

  • CoffeeScript is used because it plays nice with object-oriented Backbone.js nature.
  • Stylus is used because a) it has customizable syntax (you can use or drop braces / semicolons / colons), unlike less / sass; b) its mixins are transparent. If you're writing border-radius in stylus with nib, it's automatically expanded to all needed vendor prefixes. No need to use LESS / SCSS syntax. Example: https://gist.github.com/2005644.
  • Handlebars templates are used because they are logic-less, compatible with Mustache (which has implementations in many languages), and have a nice helpers system. If you're a fan of clear terse syntax, you might like Jade instead, which is similar to, but much clearer than HAML.

What is the recommended way of running tests?

This simple function will load all your files that are ending with -test suffix (user-view-test.coffee etc).

window.require.list()
  .filter(function(name) {return /-test$/.test(name);})
  .forEach(require);
Jump to Line
Something went wrong with that request. Please try again.