crushit

CrushIt

CrushIt is a commandline tool for compiling, concatenating, and minifying scripts from a web page. I wrote CrushIt to make it easy to optimize my code for use in production.

Install (npm)

npm install -g crushit

Usage

# Basic usage
crushit [options] [url]


## Beautify output code 
crushit -b [url]


## Include comments in the output code
crushit -c [url]


## Perform maximum optimisation
crushit -m [url]


## Beautify output code and include comments
crushit -bc [url]

CLI Example

# Compiling scripts from my website
crushit http://www.rflab.co.za

You can also include CrushIt in your node programs

var crushit = require("crushit");

crushit.crushScripts(url, options);

# options
beatify    - Beautify output code
max     - Perform maximum optimisation
comments   - Include comments in the output code
onComplete - Callback function that takes on argument

Program Example

var crushit = require("crushit");

crushit.crushScripts("http://www.rflab.co.za", {
    beautify: true,
    
    max: false,
    
    comments: true,
    
    onComplete: function (error, code) {
        if (error) {
            console.log(error.msg);   
        }
        else {
            console.log(code);
        }
    }
});

To Do

• Add css minification
• Write better docs

License

(MIT License)

Copyright (c) 2012 Qawelesizwe Mlilo [e-mail]

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the 'Software'), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.