# grunt-coffee-redux

> Compile CoffeeScript files to JavaScript with the CoffeeScript Redux compiler.

Latest version **0.2.4** (published 2014-01-28) · 0 weekly downloads

## Install

```sh
npm install grunt-coffee-redux
pnpm add grunt-coffee-redux
yarn add grunt-coffee-redux
bun add grunt-coffee-redux
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.2.4 |
| Published | 2014-01-28 |
| First published | 2013-01-18 |
| Weekly downloads | 0 |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >= 0.8.0 |
| Dependencies | 1 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 6 |
| Author | Moritz Heuser |
| Maintainers | mheuser |
| Keywords | gruntplugin |

## Links

- npm: https://www.npmjs.com/package/grunt-coffee-redux
- Repository: https://github.com/mheuser/grunt-coffee-redux
- Issues: https://github.com/mheuser/grunt-coffee-redux/issues
- npm.io page: https://npm.io/package/grunt-coffee-redux

## Dependencies (1)

- [coffee-script-redux](https://npm.io/package/coffee-script-redux.md) 2.0.0-beta8

## Recent versions

- 0.2.4 (latest) — 2014-01-28
- 0.2.3 — 2013-02-24
- 0.2.2 — 2013-02-10
- 0.2.1 — 2013-02-10
- 0.2.0 — 2013-01-18
- 0.1.0 — 2013-01-18

## README

# grunt-coffee-redux

> Compile CoffeeScript files to JavaScript with the CoffeeScript Redux compiler.


## Getting Started
If you haven't used [grunt][] before, be sure to check out the [Getting Started][] guide, as it explains how to create a [gruntfile][Getting Started] as well as install and use grunt plugins. Once you're familiar with that process, install this plugin with this command:

```shell
npm install grunt-coffee-redux --save-dev
```

[grunt]: http://gruntjs.com/
[Getting Started]: http://gruntjs.com/getting-started


## Coffeeredux task
_Run this task with the `grunt coffeeredux` command._

_This task is a [multi task][] so any targets, files and options should be specified according to the [multi task][] documentation._
[multi task]: https://github.com/gruntjs/grunt/wiki/Configuring-tasks


This plugin provides the [CoffeeScript Redux](https://github.com/michaelficarra/CoffeeScriptRedux) compiler.

### Options

#### bare

Type: `boolean`

Default: `no`

Compile the JavaScript without the top-level function safety wrapper.

#### sourceMap

Type: `boolean`

Default: `no`

Create a source map and a CoffeeScript file with all concatenated sources in
the same folder as the target JavaScript file. 

The source map will be named like this: `#{targetJsFileName}map.json`, e.g.:
`helloworld.jsmap.json`.

The CoffeeScript file with all concatenated sources will be named like this:
`#{targetJsFileName}.coffee`, e.g.: `helloworld.js.coffee`.


### Example Configuration

```coffee
coffeeredux:
  options:
    bare: false
    sourceMap: true
  compile:
    files:
      'tmp/helloworld.js': [
        'test/fixtures/hello.coffee'
        'test/fixtures/world.coffee'
      ]
```

This configuration will create following files in the `tmp` folder:

  * `helloworld.js.coffee`: This is the result of the concatenation of the
  files `hello.coffee` and `world.coffee`.
  
  * `helloworld.jsmap.json`: The source map who is pointing to the
  `helloworld.js.coffee`.

  * 'helloworld.js': Is the to JavaScript compiled version of the
  `helloworld.js.coffee` file.



## Release History

 * 2013-02-10   v0.2.2   Fixed error logging
 * 2013-02-10   v0.2.1   Updated coffee redux dependency to 2.0.0beta2 Updated grunt-contrib-internal to get working links in the README.md
 * 2013-01-19   v0.2.0   Show in which file a parse error has happened.
 * 2013-01-19   v0.1.0   Initial npm release

---

Task submitted by [Moritz Heuser](https://github.com/moritzh)

*This file was generated on Sun Feb 10 2013 11:15:56.*

---
_Source: https://npm.io/package/grunt-coffee-redux · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._