Misc/vimrc

   1 " vimrc file for following the coding standards specified in PEP 7 & 8.
   2 "
   3 " To use this file, source it in your own personal .vimrc file (``source
   4 " <filename>``) or, if you don't have a .vimrc file, you can just symlink to it
   5 " (``ln -s <this file> ~/.vimrc``).  All options are protected by autocmds
   6 " (read below for an explanation of the command) so blind sourcing of this file
   7 " is safe and will not affect your settings for non-Python or non-C files.
   8 "
   9 "
  10 " All setting are protected by 'au' ('autocmd') statements.  Only files ending
  11 " in .py or .pyw will trigger the Python settings while files ending in *.c or
  12 " *.h will trigger the C settings.  This makes the file "safe" in terms of only
  13 " adjusting settings for Python and C files.
  14 "
  15 " Only basic settings needed to enforce the style guidelines are set.
  16 " Some suggested options are listed but commented out at the end of this file.
  17
  18
  19 " Number of spaces to use for an indent.
  20 " This will affect Ctrl-T and 'autoindent'.
  21 " Python: 4 spaces
  22 " C: tab (8 spaces)
  23 au BufRead,BufNewFile *.py,*pyw set shiftwidth=4
  24 au BufRead,BufNewFile *.c,*.h set shiftwidth=8
  25
  26 " Number of spaces that a pre-existing tab is equal to.
  27 " For the amount of space used for a new tab use shiftwidth.
  28 " Python: 8
  29 " C: 8
  30 au BufRead,BufNewFile *py,*pyw,*.c,*.h set tabstop=8
  31
  32 " Replace tabs with the equivalent number of spaces.
  33 " Also have an autocmd for Makefiles since they require hard tabs.
  34 " Python: yes
  35 " C: no
  36 " Makefile: no
  37 au BufRead,BufNewFile *.py,*.pyw set expandtab
  38 au BufRead,BufNewFile *.c,*.h set noexpandtab
  39 au BufRead,BufNewFile Makefile* set noexpandtab
  40
  41 " Use the below highlight group when displaying bad whitespace is desired
  42 highlight BadWhitespace ctermbg=red guibg=red
  43
  44 " Display tabs at the beginning of a line in Python mode as bad
  45 au BufRead,BufNewFile *.py,*.pyw match BadWhitespace /^\t\+/
  46
  47 " Wrap text after a certain number of characters
  48 " Python: 79
  49 " C: 79
  50 au BufRead,BufNewFile *.py,*.pyw,*.c,*.h set textwidth=79
  51
  52 " Turn off settings in 'formatoptions' relating to comment formatting.
  53 " - c : do not automatically insert the comment leader when wrapping based on
  54 "    'textwidth'
  55 " - o : do not insert the comment leader when using 'o' or 'O' from command mode
  56 " - r : do not insert the comment leader when hitting <Enter> in insert mode
  57 " Python: not needed
  58 " C: prevents insertion of '*' at the beginning of every line in a comment
  59 au BufRead,BufNewFile *.c,*.h set formatoptions-=c formatoptions-=o formatoptions-=r
  60
  61 " Use UNIX (\n) line endings.
  62 " Only used for new files so as to not force existing files to change their
  63 " line endings.
  64 " Python: yes
  65 " C: yes
  66 au BufNewFile *.py,*.pyw,*.c,*.h set fileformat=unix
  67
  68
  69 " ----------------------------------------------------------------------------
  70 " The following section contains suggested settings.  While in no way required
  71 " to meet coding standards, they are helpful.
  72
  73 " Set the default file encoding to UTF-8: ``set encoding=utf-8``
  74
  75 " Puts a marker at the beginning of the file to differentiate between UTF and
  76 " UCS encoding (WARNING: can trick shells into thinking a text file is actually
  77 " a binary file when executing the text file): ``set bomb``
  78
  79 " For full syntax highlighting:
  80 "``let python_highlight_all=1``
  81 "``syntax on``
  82
  83 " Automatically indent based on file type: ``filetype indent on``
  84 " Keep indentation level from previous line: ``set autoindent``
  85
  86 " Folding based on indentation: ``set foldmethod=indent``
  87
  88 " Make trailing whitespace explicit (left off since this will automatically
  89 " insert the highlight or characters *as you type*, which can get annoying):
  90 "``match BadWhitespace /\s\+$/``
  91 "
  92 " or, for a non-colored, character-based solution:
  93 "
  94 "``set list listchars=trail:-``
  95