coffeeify-cached/README.md

browserify plugin for coffee-script with support for mixed .js and .coffee files (with compile cache)

# coffeeify [![Build Status](https://travis-ci.org/jnordberg/coffeeify.svg?branch=master)](https://travis-ci.org/jnordberg/coffeeify)

CoffeeScript browserify transform. Mix and match `.coffee` and `.js` files in the same project.

## Difference
The difference between this package and the original [coffeeify](http://ghub.io/coffeeify) is that this module caches coffeescript compilations according to the files' hashes and stores them to disk so that next time a file with the same hash will be processed re-compilation won't be needed.

## Example

Given some files written in a mix of `js` and `coffee`:

foo.coffee:

```coffee
console.log require './bar.js'
```

bar.js:

```javascript
module.exports = require('./baz.coffee')(5)
```

baz.coffee:

```coffee
module.exports = (n) -> n ** n
```

Install coffeeify into your app:

```
$ npm install coffeeify
```

When you compile your app, just pass `-t coffeeify` to browserify:

```shell
$ browserify -t coffeeify foo.coffee > bundle.js
$ node bundle.js
3125
```

You can omit the `.coffee` extension from your requires if you add the extension to browserify's module extensions:

```javascript
module.exports = require('./baz')(5)
```

```
$ browserify -t coffeeify --extension=".coffee" foo.coffee > bundle.js
$ node bundle.js
3125
```

You can also pass options to the CoffeeScript compiler:

```
$ browserify -t [ coffeeify --bare false --header true ] --extension=".coffee" foo.coffee
..
// Generated by CoffeeScript 1.10.0
(function() {
  console.log(require('./bar.js'));

}).call(this);
..
```

## Options

Name       | Default   | Description
-----------|-----------|-------------------------------------------------------------------------------------------
sourceMap  | `null`    | Generate source maps, deteremined from browserify's `--debug` option if not set.
bare       | `true`    | Omit the `(function(){ .. }).call(this);` wrapper.
header     | `false`   | Include the `// Generated by CoffeeScript <version>` header in every file processed.

When using browserify programatically options can be passed as an object, example:

```coffee
browserify = require 'browserify'
coffeeify = require 'coffeeify'

bundle = browserify
  extensions: ['.coffee']

bundle.transform coffeeify,
  bare: false
  header: true

bundle.add 'foo.coffee'

bundle.bundle (error, result) ->
  throw error if error?
  process.stdout.write result
```

## Install

With [npm](https://npmjs.org) do:

```
npm install coffeeify
```

## License

MIT