dsimard / ready.js

OBSOLETE - continuous javascript integration

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]

ready.js's Issues

[feature request] --no-aggregate option and exclude node_modules option

Can you please add --no-aggregate option?
In addition, is there an easy way to exclude everything under node_modules directory?

Thanks

Integration of vows & colorize output

Hey,
I made a quick hack (it's really a hack) for integrating vows into ready.js.
See schakko@cbeee9f

Greetings,
Schakko

Problems when files have the same names

It seems all files are pulled from their folders and copied to the current one before processing.
That means that if files stored in different folders share the same name, they are going to be overwritten and the process will fail.

You could say that we should name all our files differently, but I think it's fairly common for people to have a MVC structure where we would have something like this:

views/product.js
model/product.js

What do you think?

[Kubuntu] Cannot install compiler locally

I've tried to install ready.js using npm, but instead of having binaries in /usr/local, they end up in a local 'node_modules' folder.

I can then launch the command and it can compile files, however, when trying to install the compiler locally (I don't fancy sending all my files on the Internet), it fails with this:
ERROR : Installing a compiler is available only with a NPM installation. Run npm install ready.

I suspect that the error message meant ' npm install ready.js', but still that's what I did and it still doesn't work.

This project should not be used

It's sad to say but the truth is that you shouldn't use this project anymore.

This project was released about a year before grunt. Grunt really took off so now, it doesn't make sense to use ready.js.

I'm for conventions and I appreciate when a community gets behind a tool. That way, a new language/framework/whatever can have a solid growth.

Conventions ask me to stop developing and pushing ready.js. I learned a lot and I thank you all for using ready.js.

I will update the README file accordingly.

Switch from Google Closure Compiler to Uglify-js

Just a suggestion, but I would love this change for two reasons:

1. Google's Closure Compiler has made some funky and unnecessary alterations to some of my JavaScript, and has been reported by others as being randomly buggy in certain situations.

2. Uglify is more performant than Closure Compiler.

Thanks!

Discussion topic: New ready.js approach

Hi @dsimard, before starting to build my own tool, I want to talk with you about a radical change of ready js.
Hope you will understand my goals reading the confing.json below

{
  "targets": [{
      "output_file": "public/js/my-awesome-lib-compiled.js",
      "source": "js/lib/my-awesome-lib.js",
      "syntax_check": {
        "indent": 2,
        "boss": true,
        "browser": true
      },
      "compile": true,
    },{
      "output_file": "public/js/application-min.js",
      "source": [
        "js/lib/mootools-core-1.4.2-full-nocompat.js --check-syntax",
        "js/lib/mootools-more-1.4.0.1.js --check-syntax",
        "public/js/my-awesome-lib-compiled.js",
        "js/application.js --check-syntax --compile",
      ],
      "syntax_check": "default",
      "compile": true,
  }],
  "defaults": {
    "syntax_check": {
      "indent": 2,
      "boss": true,
      "browser": true,
      "curly": true,
      "debug": true,
      "devel": true,
      "eqeqeq": true,
      "es5": true,
      "expr": true,
      "mootools": true,
      "newcap": true,
      "passfail": true,
      "triling": true,
      "undef": true,
      "white": true
    }
  }
}

"order" option not affecting aggregation order

The final aggregation doesn't seem to be respecting the "order" config option for me...

I enter:

{ 
  src : "themes/refresh/js/",
  dest : "themes/refresh/js/minified",
  minifiedExtension : "min",
  order:[
    "jquery.js", 
    "jquery.ui.js",
    "jquery.animate_rotate_scale.js",
    "jquery.carousel.js",
    "jquery.css_transform.js",
    "jquery.equal_columns.js",
    "jquery.js",
    "jquery.simpleSlideshow.js",
    "lettering.js",
    "application.js"
  ],
  runGCompiler : true, // If should run GoogleCompiler
  runJsLint : false, // If should run JsLint
  debug: true,
  aggregateTo : "themes/refresh/js/all.min.js" // Which file to aggregate all javascript files
}

...but mysteriously, equal_columns, simpleSlideshow, and lettering come out first in the resulting file. Any ideas?

Doesn't work on Windows

Just a quick feedback that it doesn't seem to work with Windows binaries of node.js.
An obvious reason is because of the use of things like

#!/usr/bin/env node

but there are other problems like compiling with --nojslint will compile the local folder if trying to use a config file or won't find files if trying to use a source/dest syntax.

Does not work at all

$npm install ready.js

Then in my local folder, I did:

$readyjs resource-widget.js resource-widget.min.js

I'm pretty sure I'm running on the same directory as my files are, but nothing popped up. This is the message that came out:

WARNING : No files to process

What's wrong?

Feature request: jshint integration

What about integrating jshint? jslint is too aggressive sometimes...

jshint

How about working with http://jshint.com to allow more configurability?

package.json data doesn't parse in npm 0.3.0.

Error message when trying to install:

npm info it worked if it ends with ok
npm info using [email protected]
npm info using [email protected]
npm info fetch http://registry.npmjs.org/ready.js/-/ready.js-1.2.1.tgz
npm ERR! couldn't read package.json in /tmp/npm-1300123490834/1300123490834-0.1645010879728943/contents/package
npm ERR! Error installing [email protected]
npm ERR! Error: Failed to parse json
npm ERR! Unexpected token ILLEGAL
npm ERR! at jsonParseFail (/usr/local/lib/node/.npm/npm/0.3.15/package/lib/utils/read-json.js:89:11)
npm ERR! at /usr/local/lib/node/.npm/npm/0.3.15/package/lib/utils/read-json.js:82:14
npm ERR! at P (/usr/local/lib/node/.npm/npm/0.3.15/package/lib/utils/read-json.js:62:40)
npm ERR! at cb (/usr/local/lib/node/.npm/npm/0.3.15/package/lib/utils/graceful-fs.js:31:9)
npm ERR! at [object Object]. (fs.js:86:5)
npm ERR! at [object Object].emit (events.js:39:17)
npm ERR! at afterRead (fs.js:882:12)
npm ERR! JSON.parse
npm ERR! JSON.parse Failed to parse package.json data.
npm ERR! JSON.parse Note that package.json must be actual JSON, not
npm ERR! JSON.parse just a JavaScript object.
npm ERR! JSON.parse
npm ERR! JSON.parse This changed in npm 0.3.0, and is not a bug in npm.
npm ERR! JSON.parse Tell the package author to fix their package.json file.
npm ERR! JSON.parse
npm ERR! System Darwin 10.6.0
npm ERR! argv { remain: [ 'ready.js' ],
npm ERR! argv cooked: [ 'install', 'ready.js' ],
npm ERR! argv original: [ 'install', 'ready.js' ] }

Feature request: Use local compiler.jar?

After testing ready.js for a bit, I always run into a big stack of "Error Compiling" issues. I went in and started logging the actual error, which turned out to be:

"Too many compiles performed recently"

I can wait an hour and keep going, but it would be awesome to just integrate the compiler app (found here http://code.google.com/closure/compiler/docs/gettingstarted_app.html).