OBSOLETE

This project is now obsolete, see why in issue #18.

ready.js - continuous javascript integration

What does it do?

1. Check if your javascript files are valid with jshint.
2. Compile your javascript files with Uglify JS.
3. (Later) Watch your javascript files for jshint while you're coding.
4. Create an aggregated file of all your javascripts.

Installation

npm install ready.js --global

Usage

Usage: readyjs [FILES OR DIRECTORIES] [options]

Options:
  -o, --output    The file or directory in which to write the output                                
  -c, --config    Specify a config.json file                                           
  -i, --ignore    Ignore these files from JSHint but output them in the aggregated file
  -k, --keep      Keep individual minified files                                       
  --no-recursive  Don't recurse in sub-directories                                     
  -h, --help      Display this help                                                    
  -v, --version   Display the current version

Continuous integration

1. run npm install ready.js --global
2. run echo 'readyjs path/to/src -o path/to/dest' >> .git/hooks/pre-commit

Configuration file

You can use a configuration file with ready.js. It has to be a JSON with that format :

{
  "output" : "path/to/destination", // The file in which to write the output
  "ignore" : [], // Ignore these files from JSHint but output them in the aggregated file
  "keep" : false, // Keep individual minified files
  "no-recursive" : false // Don't recurse in sub-directories
}

Contribute

You can create issues.

You can also contribute code :

1. Fork the code on GitHub
2. Clone your fork in your environment : git clone [email protected]:USERNAME/ready.js.git
3. Create a branch for your feature : git checkout -b your_branch_name
4. Write and delete code and commit as often as you can : git commit -am "A descriptive message"
5. Push the branch to your fork : git push origin your_branch_name
6. Create a pull request on GitHub (click the Pull request button on your fork page)

API Reference

You can use this function readyjs.compile(sources, [options], callback(err, minified))

ready.compile(['./js', 'lib/cat.js'], {analyse:false}, function(err, minified) {
});

See main file for more information.

options

• ignore default is [] : A list of files to ignore. (ex : _jquery*.js)
• analyze default is true : If should analyze files through jshint
• recursive default is true : If should go through directory recursively

callback(err, minified)

• err : The errors that happened. If jshint didn't pass, err will contain formatted jshint errors
• minified : The aggregated minified code for all files

Need more help?

• Create an issue.
• Write me an email at [email protected]