<commit_before>This project adds [CoffeeScript] support to the vim editor. Currently, it
supports [almost][todo] all of CoffeeScript's syntax and indentation style.

![Screenshot][screenshot]

[CoffeeScript]: http://coffeescript.org
[todo]: http://github.com/kchmck/vim-coffee-script/blob/master/todo.md
[screenshot]: http://i.imgur.com/xbto8.png

### Installing and using

1. Install [pathogen] into `~/.vim/autoload/` and add the following line to your
   `~/.vimrc`:

        call pathogen#runtime_append_all_bundles()

     Be aware that it must be added before any `filetype plugin indent on`
     lines according to the install page:

     > Note that you need to invoke the pathogen functions before invoking
     > "filetype plugin indent on" if you want it to load ftdetect files. On
     > Debian (and probably other distros), the system vimrc does this early on,
     > so you actually need to "filetype off" before "filetype plugin indent on"
     > to force reloading.

[pathogen]: http://www.vim.org/scripts/script.php?script_id=2332

2. Create, and change into, the `~/.vim/bundle/` directory:

        $ mkdir -p ~/.vim/bundle
        $ cd ~/.vim/bundle

3. Make a clone of the `vim-coffee-script` repository:

        $ git clone git://github.com/kchmck/vim-coffee-script.git
        [...]
        $ ls
        vim-coffee-script/

Thatʼs it. Pathogen should handle the rest. Opening a file with a `.coffee`
extension or a `Cakefile` will load all the CoffeeScript stuff.

### Updating

1. Change into the `~/.vim/bundle/vim-coffee-script/` directory:

        $ cd ~/.vim/bundle/vim-coffee-script

2. Pull in the latest changes:

        $ git pull

Everything will then be brought up to date.

### Customizing

Some of the possibly unwanted syntax highlighting elements can be disabled
in the following ways.

### Compiling CoffeeScript on File Write (save)

If you are using the NodeJS version of CofeeScript, with the "coffee" command 
in your path, you can enable auto-compiling on file write (save) like so:
	
	let coffee_compile_on_save=1

This will compile the coffeescript to js. Ex: /Users/brian/ZOMG.coffee will compile to<commit_msg>Updating bad header in readme to make instructions easier to read<commit_after>This project adds [CoffeeScript] support to the vim editor. Currently, it
supports [almost][todo] all of CoffeeScript's syntax and indentation style.

![Screenshot][screenshot]

[CoffeeScript]: http://coffeescript.org
[todo]: http://github.com/kchmck/vim-coffee-script/blob/master/todo.md
[screenshot]: http://i.imgur.com/xbto8.png

### Installing and using

1. Install [pathogen] into `~/.vim/autoload/` and add the following line to your
   `~/.vimrc`:

        call pathogen#runtime_append_all_bundles()

     Be aware that it must be added before any `filetype plugin indent on`
     lines according to the install page:

     > Note that you need to invoke the pathogen functions before invoking
     > "filetype plugin indent on" if you want it to load ftdetect files. On
     > Debian (and probably other distros), the system vimrc does this early on,
     > so you actually need to "filetype off" before "filetype plugin indent on"
     > to force reloading.

[pathogen]: http://www.vim.org/scripts/script.php?script_id=2332

2. Create, and change into, the `~/.vim/bundle/` directory:

        $ mkdir -p ~/.vim/bundle
        $ cd ~/.vim/bundle

3. Make a clone of the `vim-coffee-script` repository:

        $ git clone git://github.com/kchmck/vim-coffee-script.git
        [...]
        $ ls
        vim-coffee-script/

Thatʼs it. Pathogen should handle the rest. Opening a file with a `.coffee`
extension or a `Cakefile` will load all the CoffeeScript stuff.

### Updating

1. Change into the `~/.vim/bundle/vim-coffee-script/` directory:

        $ cd ~/.vim/bundle/vim-coffee-script

2. Pull in the latest changes:

        $ git pull

Everything will then be brought up to date.

### Customizing

Some of the possibly unwanted syntax highlighting elements can be disabled
in the following ways.

#### Compiling CoffeeScript on File Write (save)

If you are using the NodeJS version of CofeeScript, with the "coffee" command 
in your path, you can enable auto-compiling on file write (save) like so:
	
	let coffee_compile_on_save=1

This will compile the coffeescript to js. Ex: /Users/brian/ZOMG.coffee will compile to
{'fraction_non_alphanumeric': 0.09668571428571429, 'fraction_numerical': 0.005028571428571428, 'mean_word_length': 3.3283877349159248, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 13, 'https://': 0, 'lorem ipsum': 0, 'www.': 2, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '160744', 'n_tokens_mistral': 1419, 'n_tokens_neox': 1322, 'n_words': 515}