banshee

0.1.1 • Public • Published

Banshee

A speedy tool for combining and compressing your JavaScript, CoffeeScript, CSS and LESS source files.

Banshee combines your source files into a single script or stylesheet to reduce HTTP overhead and make development easier. It has built-in support for Sprockets-style dependency syntax (#= require x) and a lightning-fast, built-in watch mechanism to detect changes to your source files and recompile on the fly.

Requires node v0.8+

Build Status

Installation

$ npm install -g banshee

Command Line Interface

Syntax:

$ banshee <input file>:<output file> [options]

Example

$ banshee src/application.coffee:build/application.min.js

Options

Option Description
-c, --compress Compress the final output
-w, --watch Use the built-in watch mechanism to observe your source files and re-compile when something changes
-q, --quiet Quiet the command-line output
--no-color Disable color in the output
--full-paths Use full filepaths in the manifest output
--clear Clear the terminal window, on by default with --watch
-h, --help Output usage information
-v, --version Output the version number

Requiring Source Files

Banshee supports Sprockets-style requires, with one exception. Instead of using require_tree, you can simply use require and Banshee will automatically detect if the path is a source file or a directory. Please note, doing require on a top level directory will be recursive through its sub-directories.

Syntax: (JavaScript)

//= require lib/some_directory
//= require other_file.js

Syntax: (CoffeeScript)

#= require lib/some_directory 
#= require other_file.coffee 

Syntax: (CSS)

/*= require lib/some_directory */
/*= require other_file.css */

Syntax: (LESS) Uses normal LESS import statements.

@import 'lib/dependency1';
@import 'dependency2';

Paths used in require statements are evaluated relative to the file which contains them.

Contribute

We'd love your help. Fork us so we can make Banshee better.

$ git clone git://github.com/imulus/banshee

Download

You can download this project in either zip or tar formats.

or get the source code on GitHub : imulus/banshee

Readme

Keywords

none

Package Sidebar

Install

npm i banshee

Weekly Downloads

25

Version

0.1.1

License

none

Last publish

Collaborators

  • caseyohara
  • taylorsmith