| Brett Cannon | b12efd3 | 2004-11-06 19:56:45 +0000 | [diff] [blame^] | 1 | " vimrc file for following the coding standards specified in PEP 7 & 8. |
| Brett Cannon | 8b4e886 | 2004-09-19 05:43:13 +0000 | [diff] [blame] | 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 |
| Brett Cannon | b12efd3 | 2004-11-06 19:56:45 +0000 | [diff] [blame^] | 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 | " |
| Brett Cannon | 8b4e886 | 2004-09-19 05:43:13 +0000 | [diff] [blame] | 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 make 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 | |
| Brett Cannon | 8b4e886 | 2004-09-19 05:43:13 +0000 | [diff] [blame] | 20 | " Number of spaces to use for an indent. |
| 21 | " This will affect Ctrl-T and 'autoindent'. |
| 22 | " Python: 4 spaces |
| 23 | " C: tab (8 spaces) |
| 24 | au BufRead,BufNewFile *.py,*pyw set shiftwidth=4 |
| 25 | au BufRead,BufNewFile *.c,*.h set shiftwidth=8 |
| 26 | |
| 27 | " Number of spaces that a pre-existing tab is equal to. |
| Brett Cannon | b12efd3 | 2004-11-06 19:56:45 +0000 | [diff] [blame^] | 28 | " For the amount of space used for a new tab use shiftwidth. |
| Brett Cannon | 8b4e886 | 2004-09-19 05:43:13 +0000 | [diff] [blame] | 29 | " Python: 8 |
| 30 | " C: 8 |
| 31 | au BufRead,BufNewFile *py,*pyw,*.c,*.h set tabstop=8 |
| 32 | |
| 33 | " Replace tabs with the equivalent number of spaces. |
| 34 | " Also have an autocmd for Makefiles since they require hard tabs. |
| 35 | " Python: yes |
| 36 | " C: no |
| Brett Cannon | b12efd3 | 2004-11-06 19:56:45 +0000 | [diff] [blame^] | 37 | " Makefile: no |
| Brett Cannon | 8b4e886 | 2004-09-19 05:43:13 +0000 | [diff] [blame] | 38 | au BufRead,BufNewFile *.py,*.pyw set expandtab |
| 39 | au BufRead,BufNewFile *.c,*.h set noexpandtab |
| 40 | au BufRead,BufNewFile Makefile* set noexpandtab |
| 41 | |
| 42 | " Wrap text after a certain number of characters |
| 43 | " Python: 79 |
| 44 | " C: 79 |
| 45 | au BufRead,BufNewFile *.py,*.pyw,*.c,*.h set textwidth=79 |
| 46 | |
| 47 | " Turn off settings in 'formatoptions' relating to comment formatting. |
| 48 | " - c : do not automatically insert the comment leader when wrapping based on |
| 49 | " 'textwidth' |
| 50 | " - o : do not insert the comment leader when using 'o' or 'O' from command mode |
| 51 | " - r : do not insert the comment leader when hitting <Enter> in insert mode |
| 52 | " Python: not needed |
| 53 | " C: prevents insertion of '*' at the beginning of every line in a comment |
| 54 | au BufRead,BufNewFile *.c,*.h set formatoptions-=c formatoptions-=o formatoptions-=r |
| 55 | |
| 56 | " Use UNIX (\n) line endings. |
| 57 | " Only used for new files so as to not force existing files to change their |
| 58 | " line endings. |
| 59 | " Python: yes |
| 60 | " C: yes |
| 61 | au BufNewFile *.py,*.pyw,*.c,*.h set fileformat=unix |
| 62 | |
| 63 | |
| Brett Cannon | b12efd3 | 2004-11-06 19:56:45 +0000 | [diff] [blame^] | 64 | " ---------------------------------------------------------------------------- |
| Brett Cannon | 8b4e886 | 2004-09-19 05:43:13 +0000 | [diff] [blame] | 65 | " The following section contains suggested settings. While in no way required |
| 66 | " to meet coding standards, they are helpful. |
| 67 | |
| 68 | " Set the default file encoding to UTF-8: ``set encoding=utf-8`` |
| 69 | |
| 70 | " Put a marker at the beginning of the file to differentiate between UTF and |
| Brett Cannon | b12efd3 | 2004-11-06 19:56:45 +0000 | [diff] [blame^] | 71 | " UCS encoding (WARNING: can trick shells into thinking a text file is actually |
| 72 | " a binary file when executing the text file): ``set bomb`` |
| Brett Cannon | 8b4e886 | 2004-09-19 05:43:13 +0000 | [diff] [blame] | 73 | |
| 74 | " For full syntax highlighting: |
| 75 | "``let python_highlight_all=1`` |
| 76 | "``syntax on`` |
| 77 | |
| 78 | " Automatically indent: ``filetype indent on`` |
| 79 | |
| Brett Cannon | b12efd3 | 2004-11-06 19:56:45 +0000 | [diff] [blame^] | 80 | " Folding based on indentation: ``set foldmethod=indent`` |
| Brett Cannon | 24a0045 | 2004-09-20 22:33:21 +0000 | [diff] [blame] | 81 | |
| 82 | " Make trailing whitespace explicit: |
| 83 | "highlight WhitespaceEOL ctermbg=red guibg=red |
| 84 | "match WhitespaceEOL /\s\+$/ |
| 85 | " or |
| 86 | "set list listchars=trail:- |
| 87 | |