Builder for creating distributable JavaScript files from source. Concatenate, wrap, uglify.
Switch branches/tags
Nothing to show
Pull request Compare This branch is 12 commits behind powmedia:master.
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
test
.gitignore
LICENSE
README.md
index.js
package.json

README.md

buildify

Builder for creating distributable JavaScript files from source. Concatenate, wrap, uglify.

##Install Requires NodeJS to run.

Then install buildify via npm:

npm install buildify

Create a file with your build script (see the example in 'Usage' below), call it something like build.js and then run it with:

node build.js

##Usage

var buildify = require('buildify');

buildify()
  .load('base.js')
  .concat(['part1.js', 'part2.js'])
  .wrap('../lib/template.js', { version: '1.0' })
  .save('../distribution/output.js')
  .uglify()
  .save('../distribution/output.min.js');

##API

###buildify([dir, options]) Create a new Builder instance.

Takes the starting directory as the first argument, e.g. __dirname. If this is not set, the current working directory is used.

Options:

  • interpolate Underscore template settings. Default to mustache {{var}} style interpolation tags.
  • encoding File encoding (Default 'utf-8')
  • eol End of line character (Default '\n')
  • quiet Whether to silence console output

###setDir(absolutePath) Set the current working directory.

###changeDir(relativePath) Change the current working directory.

###setContent(content) Set the content to work with.

###getContent() Get the current content. Note: breaks the chain.

###load(file) Load file contents.

###concat(files, [eol]) Concatenate the content of multiple files.

buildify()
    .concat(['file1.js', 'file2.js']);

###wrap(template, [data]) Wrap the contents in a template.

Useful for creating AMD/CommonJS compatible versions of code, adding notes/comments to the top of the file etc.

By default the template uses Mustache-style tags and has a special tag, {{body}} which is where the contents are placed.

Other custom tags can be included and passed in the data argument.

//template.js
/*
 * This is a module for doing stuff.
 * Version {{version}}.
 */
(function() {
    //Setup code can go here
    
    {{body}}
});

//build.js
buildify()
    .load('src.js')
    .wrap('template.js', { version: '1.0' });

###perform(fn) Perform a function on the content. The content is set to what the function returns.

buildify()
    .load('src.js')
    .perform(function(content) {
        return content.replace(\assetpath\g, 'http://cdn.example.com');
     });    

###uglify() Minimise your JS using uglifyJS.

###cssmin([maxLineLength]) Minimise your CSS using clean-css. Optionally a line break is inserted after 'maxLineLength' characters in the minimized css file.

###save(file) Save the contents to a file.

###clear() Reset/clear contents.

##Changelog 0.3.0 Add cssmin() for minifying CSS (RustyMarvin) Fix tests under Windows (RustyMarvin)

0.2.0 Add perform() for custom functions (trevorgerhardt)