<commit_before># Haml CoffeeScript Templates

**This is a work in progress fork and a pull request will be made when stable.**

Haml CoffeeScript is a Haml parser that understands CoffeeScript. It will generate a JavaSript template that can be rendered
to HTML. Those templates can be used in your [Backbone.js](http://documentcloud.github.com/backbone/) application.

It is heavily inspired by <NAME>s [haml-js](https://github.com/creationix/haml-js). We developed it since we love
Haml & CoffeeScript and we don't want to have a media break in our tool chain. If you want to see it in action feel free
to take a look at our [website](http://www.9elements.com/).

We also written a motivational [blog post](http://9elements.com/io/?p=551) where we explain our tool chain.

## Installation

Clone the repository and install with `npm`:

```bash
$ git clone git://github.com/9elements/haml-coffee.git
$ cd haml-coffee
$ npm install
```

We will publish it to npm soon.

## Compile Haml CoffeeScript

After the installation you will have a `haml-coffee` binary:

```bash
$ haml-coffee
Usage: node ./bin/haml-coffee

Options:
  -i, --input                        Either a file or a directory name to be compiled            [required]
  -o, --output                       Set the output filename
  -n, --namespace                    Set a custom template namespace                             [default: "window.HAML"]
  -t, --template                     Set a custom template name
  -f, --format                       Set HTML output format, either `xhtml`, `html4` or `html5`  [default: "html5"]
  -e, --custom-html-escape           Set the custom HTML escaping function name
  --disable-html-attribute-escaping  Disable any HTML attribute escaping                         [boolean]
  --disable-html-escaping            Disable any HTML escaping                                   [boolean]
```

### `-i`/`--input` option

You can either specify a single template or a directory. When you supply a directory, templates are being searched
within it:

```bash
$ haml-coffee -i template.haml
```

This will generate a template with the same name but the extension changed to `jst`. The above command for example would
generate a template named `template.jst`.

### `-o`/`--output` option

You can specify a single output file name to be used instead of the automatic generated output file name:

```bash
$ haml-coffee -i template.haml -o t.js
```<commit_msg>Fix usage in the README.<commit_after># Haml CoffeeScript Templates

**This is a work in progress fork and a pull request will be made when stable.**

Haml CoffeeScript is a Haml parser that understands CoffeeScript. It will generate a JavaSript template that can be rendered
to HTML. Those templates can be used in your [Backbone.js](http://documentcloud.github.com/backbone/) application.

It is heavily inspired by <NAME> [haml-js](https://github.com/creationix/haml-js). We developed it since we love
Haml & CoffeeScript and we don't want to have a media break in our tool chain. If you want to see it in action feel free
to take a look at our [website](http://www.9elements.com/).

We also written a motivational [blog post](http://9elements.com/io/?p=551) where we explain our tool chain.

## Installation

Clone the repository and install with `npm`:

```bash
$ git clone git://github.com/9elements/haml-coffee.git
$ cd haml-coffee
$ npm install
```

We will publish it to npm soon.

## Compile Haml CoffeeScript

After the installation you will have a `haml-coffee` binary:

```bash
$ haml-coffee
Usage: node haml-coffee

Options:
  -i, --input                        Either a file or a directory name to be compiled            [required]
  -o, --output                       Set the output filename
  -n, --namespace                    Set a custom template namespace                             [default: "window.HAML"]
  -t, --template                     Set a custom template name
  -f, --format                       Set HTML output format, either `xhtml`, `html4` or `html5`  [default: "html5"]
  -e, --custom-html-escape           Set the custom HTML escaping function name
  --disable-html-attribute-escaping  Disable any HTML attribute escaping                         [boolean]
  --disable-html-escaping            Disable any HTML escaping                                   [boolean]
```

### `-i`/`--input` option

You can either specify a single template or a directory. When you supply a directory, templates are being searched
within it:

```bash
$ haml-coffee -i template.haml
```

This will generate a template with the same name but the extension changed to `jst`. The above command for example would
generate a template named `template.jst`.

### `-o`/`--output` option

You can specify a single output file name to be used instead of the automatic generated output file name:

```bash
$ haml-coffee -i template.haml -o t.js
```
{'fraction_non_alphanumeric': 0.09127954360228199, 'fraction_numerical': 0.003667481662591687, 'mean_word_length': 2.6498141263940522, 'pattern_counts': {'":': 0, '<': 5, '<?xml version=': 0, '>': 5, 'https://': 2, 'lorem ipsum': 0, 'www.': 2, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 2, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '2507468', 'n_tokens_mistral': 1400, 'n_tokens_neox': 1307, 'n_words': 602}