Source

dotfiles / vim / bundle / vim-coffee-script / readme.md

Full commit

This project adds CoffeeScript support to the vim editor. Currently, it supports almost all of CoffeeScript's syntax and indentation style.

Screenshot

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.

  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 everything CoffeeScript.

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.

Compiling a CoffeeScript Snippet

The CoffeeCompile command can be used to peek at how the current file or a snippet of CoffeeScript would be compiled to JavaScript. Calling CoffeeCompile without a range compiles the entire file:

CoffeeCompile

and shows an output like:

Compiled

Calling CoffeeCompile with a range, like in visual mode, compiles the selected snippet of CoffeeScript:

CoffeeCompile Snippet

and shows an output like:

Compiled Snippet

The command can also be mapped to a visual mode key for convenience:

vmap KEY :CoffeeCompile<CR>

Customizing

Compile the current file on write/save

If you are using the NodeJS version of CoffeeScript, 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 JavaScript. For example, /Users/brian/ZOMG.coffee will compile to /Users/brian/ZOMG.js.

Disable trailing whitespace error highlighting

If having trailing whitespace highlighted as an error is a bit much, the following line can be added to your ~/.vimrc to disable it:

let coffee_no_trailing_space_error = 1

Disable trailing semicolon error highlighting

Likewise for the highlighting of trailing semicolons:

let coffee_no_trailing_semicolon_error = 1

Disable future/reserved words error highlighting

The same for reserved words:

let coffee_no_reserved_words_error = 1