Giter Club home page Giter Club logo

crushit's Introduction

CrushIt

CrushIt is a commandline tool for crawling web pages and compiling scripts.

Build Status

Install (npm)

npm install -g crushit

Usage

# Basic usage
crushit [options] [url] [file]


## Beautify output code 
crushit -b [url]


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


## Perform maximum optimisation
crushit -x [url] [output filename]


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

CLI Examples

# Compiling scripts from my website with default options
crushit http://www.ragingflame.co.za

# Compiling scripts from my website with options and specifying an output file
crushit -xm http://www.ragingflame.co.za crushed.js

You can also include CrushIt in your node programs

var crushIt = require("crushit");

crushIt =  new crushIt();

crushIt.squeeze(options, callback);

# options
website  - (String)   Web page URL
comments - (Boolean)  Keep comments
beatify  - (Boolean)  Beautify output code
mangle   - (Boolean)  Mangle variable names
max      - (Boolean)  Perform maximum optimisation

callback - (Function) Callback function that takes 2 arguments, the first one is an error flag or object and the second one is the output code

Program Example

var crushIt = require("crushit");

crushIt =  new crushIt();

crushIt.squeeze({
    website: "http://www.ragingflame.co.za",
    comments: false,
    beatify: false,
    mangle: true,
    max: true
}, 
function (error, code) {
    if (error) {
        console.error(error);   
    }
    else {
        console.log(code);
    }
});

Short Code

The options argument may also be a string variable

var crushIt = require("crushit");

crushIt =  new crushIt();

crushIt.squeeze("http://www.ragingflame.co.za", function (error, code) {
    if (error) {
        console.error(error);   
    }
    else {
        console.log(code);
    }
});

Testing

npm test

License

(MIT License)

Copyright (c) 2012 Qawelesizwe Mlilo [email protected]

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.

crushit's People

Contributors

qawemlilo avatar

Stargazers

JT5D avatar Amit Erandole avatar Joe Seifi avatar Shatrughn Gupta avatar Yuya Saito avatar Chris Witko avatar  avatar  avatar  avatar

Watchers

Kevin Kelley avatar  avatar James Cloos avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.