go/vim at 3a895563df1acf1724424071af7c5ce4397cfd77 - go

qbit/go

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

History

Josh Hoak b76ddefee5 misc/vim: Adding flag-guarding for Vim commands Default behavior is the same as before, but now a user may selectively disable some commands. Also: deleted the mappings for import.vim. Tested: by trying the commands for fmt, import and godoc in succession to make sure they still work. Also, ran test.sh in ftplugin/go. R=golang-dev, dsymonds CC=golang-dev https://golang.org/cl/10124043		2013-06-13 15:07:09 +10:00
..
autoload/go	misc/vim: fix for autocompletion	2012-08-28 03:59:16 +08:00
ftdetect	misc/vim: restore fileencodings.	2012-03-14 18:43:01 +11:00
ftplugin/go	misc/vim: Adding flag-guarding for Vim commands	2013-06-13 15:07:09 +10:00
indent	misc/vim: drop indent support for jump labels.	2011-05-14 09:45:32 -07:00
plugin	misc/vim: Adding flag-guarding for Vim commands	2013-06-13 15:07:09 +10:00
syntax	misc/vim: add error type.	2011-11-01 21:47:07 -04:00
readme.txt	misc/vim: update installation instructions to work better with some Linux distributions.	2013-02-18 14:03:47 +11:00

readme.txt

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

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

  " Some Linux distributions set filetype in /etc/vimrc.
  " Clear filetype flags before changing runtimepath to force Vim to reload them.
  filetype off
  filetype plugin indent off
  set runtimepath+=$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,
     and autoload/go/complete.vim to $HOME/.vim/autoload/go/complete.vim.