linux下vim的自动补全的插件

This project adds [CoffeeScript] support to vim. It covers syntax, indenting, compiling, and more.  [CoffeeScript]: http://coffeescript.org/ ## Table of Contents - Installation - [Requirements](#requirements) - [Install using Pathogen](#install-using-pathogen) - [Install using Vundle](#install-using-vundle) - [Install from a Zip File](#install-from-a-zip-file) - Coffee Commands - [Compile to JavaScript](#compile-to-javascript) - [Compile CoffeeScript Snippets](#coffeecompile-compile-coffeescript-snippets) - [Live Preview Compiling](#coffeewatch-live-preview-compiling) - [Run CoffeeScript Snippets](#coffeerun-run-coffeescript-snippets) - [Lint your CoffeeScript](#coffeelint-lint-your-coffeescript) - Extras - [Literate CoffeeScript](#literate-coffeescript) - [CoffeeScript in HTML](#coffeescript-in-html) - [CoffeeScript in Haml](#coffeescript-in-haml) - Configuration - [Custom Autocmds](#custom-autocmds) - [Configuration Variables](#configuration-variables) - [Configure Syntax Highlighting](#configure-syntax-highlighting) - [Tune Vim for CoffeeScript](#tune-vim-for-coffeescript) ## Requirements - vim 7.4 or later - coffee 1.2.0 or later ## Install using Pathogen This project uses rolling releases based on git commits, so pathogen is a natural fit for it. If you're already using pathogen, you can skip to step 4. 1. Install [pathogen.vim] into `~/.vim/autoload/` (see [pathogen's readme][install-pathogen] for more information.) [pathogen.vim]: http://www.vim.org/scripts/script.php?script_id=2332 [install-pathogen]: https://github.com/tpope/vim-pathogen#installation 2. Enable pathogen in your vimrc. Here's a bare-minimum vimrc that enables all the features of `vim-coffee-script`: ```vim call pathogen#infect() syntax enable filetype plugin indent on ``` If you already have a vimrc built up, just make sure it contains these calls, in this order. 3. Create the directory `~/.vim/bundle/`: mkdir ~/.vim/bundle 4. Clone the `vim-coffee-script` repo into `~/.vim/bundle/`: git clone https://github.com/kchmck/vim-coffee-script.git ~/.vim/bundle/vim-coffee-script/ Updating takes two steps: 1. Change into `~/.vim/bundle/vim-coffee-script/`: cd ~/.vim/bundle/vim-coffee-script 2. Pull in the latest changes: git pull ## Install using Vundle 1. [Install Vundle] into `~/.vim/bundle/`. [Install Vundle]: https://github.com/gmarik/vundle#quick-start 2. Configure your vimrc for Vundle. Here's a bare-minimum vimrc that enables all the features of `vim-coffee-script`: ```vim set nocompatible filetype off set rtp+=~/.vim/bundle/vundle/ call vundle#rc() Plugin 'kchmck/vim-coffee-script' syntax enable filetype plugin indent on ``` If you're adding Vundle to a built-up vimrc, just make sure all these calls are in there and that they occur in this order. 3. Open vim and run `:PluginInstall`. To update, open vim and run `:PluginInstall!` (notice the bang!) ## Install from a Zip File 1. Download the latest zip file from [vim.org][zip]. 2. Extract the archive into `~/.vim/`: unzip -od ~/.vim/ ARCHIVE.zip This should create the files `~/.vim/autoload/coffee.vim`, `~/.vim/compiler/coffee.vim`, etc. You can update the plugin using the same steps. [zip]: http://www.vim.org/scripts/script.php?script_id=3590 ## Compile to JavaScript A `coffee` wrapper for use with `:make` is enabled automatically for coffee files if no other compiler is loaded. To enable it manually, run :compiler coffee The `:make` command is then configured to use the `coffee` compiler and recognize its errors. I've included a quick reference here but be sure to check out [`:help :make`][make] for a full reference of the command.   [make]: http://vimdoc.sourceforge.net/htmldoc/quickfix.html#:make_makeprg Consider the full signature of a `:make` call as :[silent] make[!] [COFFEE-OPTIONS]... By default `:make` shows all compiler output and jumps to the first line reported as an error. Compiler output can be hidden with a leading `:silent`: :silent make Line-jumping can be turned off by adding a bang: :make! `COFFEE-OPTIONS` given to `:make` are passed along to `coffee` (see also [`coffee_make_options`](#coffee_make_options)): :make --bare --output /some/dir See the [full table of options](http://coffeescript.org/#usage) for a list of all the options that `coffee` recognizes. *Configuration*: [`coffee_compiler`](#coffee_compiler), [`coffee_make_options`](#coffee_make_options) #### The quickfix window Compiler errors are added to the [quickfix] list by `:make`, but the quickfix window isn't automatically shown. The [`:cwindow`][cwindow] command will pop up the quickfix window if there are any errors: :make :cwindow This is usually the desired behavior, so you may want to add an autocmd to your vimrc to do this automatically: autocmd QuickFixCmdPost * nested cwindow | redraw! The `redraw!` command is needed to fix a redrawing quirk in terminal vim, but can removed for gVim. [quickfix]: http://vimdoc.sourceforge.net/htmldoc/quickfix.html#quickfix [cwindow]: http://vimdoc.sourceforge.net/htmldoc/quickfix.html#:cwindow #### Recompile on write To recompile a file when it's written, add a `BufWritePost` autocmd to your vimrc: autocmd BufWritePost *.coffee silent make! #### Cake and Cakefiles A `cake` compiler is also available with the call :compiler cake You can then use `:make` as above to run your Cakefile and capture any `coffee` errors: :silent make build It runs within the current directory, so make sure you're in the directory of your Cakefile before calling it. *Configuration*: [`coffee_cake`](#coffee_cake), [`coffee_cake_options`](#coffee_cake_options) ## CoffeeCompile: Compile CoffeeScript Snippets CoffeeCompile shows how the current file or a snippet of CoffeeScript is compiled to JavaScript. :[RANGE] CoffeeCompile [vert[ical]] [WINDOW-SIZE] Calling `:CoffeeCompile` without a range compiles the whole file:   Calling it with a range, like in visual mode, compiles only the selected snippet of CoffeeScript:   Each file gets its own CoffeeCompile buffer, and the same buffer is used for all future calls of `:CoffeeCompile` on that file. It can be quickly closed by hitting `q` in normal mode. Using `vert` opens the CoffeeCompile buffer vertically instead of horizontally (see also [`coffee_compile_vert`](#coffee_compile_vert)): :CoffeeCompile vert By default the CoffeeCompile buffer splits the source buffer in half, but this can be overridden by passing in a `WINDOW-SIZE`: :CoffeeCompile 4 *Configuration*: [`coffee_compiler`](#coffee_compiler`), [`coffee_compile_vert`](#coffee_compile_vert) #### Quick syntax checking If compiling a snippet results in a compiler error, CoffeeCompile adds that error to the [quickfix] list. [quickfix]: http://vimdoc.sourceforge.net/htmldoc/quickfix.html#quickfix   You can use this to quickly check the syntax of a snippet. ## CoffeeWatch: Live Preview Compiling CoffeeWatch emulates using the Try CoffeeScript preview box on the [CoffeeScript homepage][CoffeeScript].   CoffeeWatch takes the same options as CoffeeCompile: :CoffeeWatch [vert[ical]] [WINDOW-SIZE] After a source buffer is watched, leaving insert mode or saving the file fires off a rec