Package Exports

buildr

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (buildr) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

Welcome to Buildr

Install

Install Node.js
Install CoffeeScript
```
 npm -g install coffeescript
```

If you also want image compression, do this:

On OSX

  ruby -e "$(curl -fsSLk https://gist.github.com/raw/323731/install_homebrew.rb)"
  brew install gifsicle libjpeg optipng pngcrush

On Apt Linux

  sudo apt-get update && sudo apt-get install gifsicle libjpeg-progs optipng pngcrush

On Yum Linux

  sudo yum -y install gifsicle libjpeg-progs optipng pngcrush

Windows

Hahahahaha

Configure

Before you use Buildr, you must specify some configuration for it. Here is an example:

 {
     srcPath: 'src'
     outPath: 'out'
    compress: true
    srcLoaderPath: 'src/loader.js'
    outStylePath: 'out/styles.css'
    outScriptPath: 'out/scripts.js'
     scripts: [
         'scripts/file1.js'
         'scripts/file2.coffee'
     ]
     styles: [
         'styles/file1.css'
         'styles/file2.less'
     ]
 }

Which works great for the following app structure:

app

src

scripts

file1.js

file2.coffee

styles

file1.css

file2.less

Using that configuration with buildr will:

Copy app/src to app/out
Generate src/loader.js which loads in the original styles and scripts into your page; use this file for development
Generates out/styles.css and out/scripts.js which are all your styles and scripts compressed and bundled together respectively; use these files for production

If you'd prefer to have the srcPath and the outPath the same, you can do that too.

Run

As a Command Line Tool

Note: this option is currently disabled due to this bug

Install Buildr Globally
```
 npm -g install buildr
```
Stick your configuration in app/buildr.cson
Within your app root, run buildr

As a Module

Install Buildr Locally
```
 npm install buildr
```

Code

buildr = require 'buildr'
config = {} # your configuration
myBuildr = buildr.createInstance(config)
myBuildr.process (err) ->
    throw err if err
    console.log 'Building completed'

License

History

Stability

To install a specific version, say version 0.2, run npm install buildr@0.2

Changelog

v0.5 July 9, 2011
- Added srcLoader compilation
v0.4 July 1, 2011
- Extremely Simplified
v0.3 May 31, 2011
- Exploration into better architectures
v0.2 April 2, 2011
- Initial Release
v0.1 March 23, 2011
- Initial Commit

Todo

Needs javascript compression re-added
Needs image compression re-added
Needs auto file finding
Needs jshint checking on .js files (not .coffee files)
Needs no-config version
Needs unit tests for the first time