go/vim at e6815c536e1d33c8e13bc78019ff861b57e150da - go

qbit/go

mirror of https://github.com/golang/go synced 2024-11-05 11:56:12 -07:00

History

David Symonds 3294404900 misc/vim: fix :Import insertion heuristic. If a factored import group has a blank line, assume it is dividing separate groups of imports (e.g. standard library vs. site-specific). import ( "bytes" "io" "mycorp/package" ) The most common case is inserting new standard library imports, which are usually (stylistically) the first group, so we should drop "net" in the above example immediately after "io". Since this logic is getting non-trivial, add a test. R=golang-dev, minux.ma, franciscossouza CC=golang-dev https://golang.org/cl/6445043		2012-07-30 08:48:51 +10:00
..
autoload/go	misc/vim: command complete using autoload helper function.	2011-08-18 11:50:55 +10:00
ftdetect	misc/vim: restore fileencodings.	2012-03-14 18:43:01 +11:00
ftplugin/go	misc/vim: fix :Import insertion heuristic.	2012-07-30 08:48:51 +10:00
indent	misc/vim: drop indent support for jump labels.	2011-05-14 09:45:32 -07:00
plugin	misc/vim: command complete using autoload helper function.	2011-08-18 11:50:55 +10:00
syntax	misc/vim: add error type.	2011-11-01 21:47:07 -04:00
readme.txt	misc/vim: command complete using autoload helper function.	2011-08-18 11:50:55 +10:00

readme.txt

Vim plugins for Go (http://golang.org)
======================================

To use all the Vim plugins, add these lines to your vimrc.

  set rtp+=$GOROOT/misc/vim
  filetype plugin indent on
  syntax on

If you want to select fewer plugins, use the instructions in the rest of
this file.

Vim syntax highlighting
-----------------------

To install automatic syntax highlighting for GO programs:

  1. Copy or link the filetype detection script to the ftdetect directory
     underneath your vim runtime directory (normally $HOME/.vim/ftdetect)
  2. Copy or link syntax/go.vim to the syntax directory underneath your vim
     runtime directory (normally $HOME/.vim/syntax). Linking this file rather
     than just copying it will ensure any changes are automatically reflected
     in your syntax highlighting.
  3. Add the following line to your .vimrc file (normally $HOME/.vimrc):

     syntax on

In a typical unix environment you might accomplish this using the following
commands:

  mkdir -p $HOME/.vim/ftdetect
  mkdir -p $HOME/.vim/syntax
  mkdir -p $HOME/.vim/autoload/go
  ln -s $GOROOT/misc/vim/ftdetect/gofiletype.vim $HOME/.vim/ftdetect/
  ln -s $GOROOT/misc/vim/syntax/go.vim $HOME/.vim/syntax
  ln -s $GOROOT/misc/vim/autoload/go/complete.vim $HOME/.vim/autoload/go
  echo "syntax on" >> $HOME/.vimrc


Vim filetype plugins
--------------------

To install one of the available filetype plugins:

  1. Same as 1 above.
  2. Copy or link one or more plugins from ftplugin/go/*.vim to the
     Go-specific ftplugin directory underneath your vim runtime directory
     (normally $HOME/.vim/ftplugin/go/*.vim).
  3. Add the following line to your .vimrc file (normally $HOME/.vimrc):

     filetype plugin on


Vim indentation plugin
----------------------

To install automatic indentation:

  1. Same as 1 above.
  2. Copy or link indent/go.vim to the indent directory underneath your vim
     runtime directory (normally $HOME/.vim/indent).
  3. Add the following line to your .vimrc file (normally $HOME/.vimrc):

     filetype indent on


Godoc plugin
------------

To install godoc plugin:

  1. Same as 1 above.
  2. Copy or link plugin/godoc.vim to $HOME/.vim/plugin/godoc,
     syntax/godoc.vim to $HOME/.vim/syntax/godoc.vim,
     ftplugin/go/godoc.vim to $HOME/.vim/ftplugin/go/godoc.vim.
     and autoload/go/complete.vim to $HOME/.vim/autoload/go/complete.vim.