History Report a problem
Article Edit this page Discussion

Keep your vimrc file clean

From Vim Tips Wiki

(Redirected from VimTip1510)
Jump to: navigation, search
 

Tip 1510Previous TipNext Tip

Created: July 23, 2007 Complexity: basic Author: Datagrok Version: 7.0


Many tips that you find on this site and others will tell you to add some code to your .vimrc file. (Or on Windows, your _vimrc file.) :help vimrc-intro

Once you do this a few times, it can get pretty big and confusing, especially if the bits of configuration you're adding are each specific to a single language. Worse, some settings might be incompatible with others.

Happily, Vim has a very nice built-in way to organize and manage language-specific options by breaking them out into files and directories. You can learn all about it by reading :help vimfiles, :help ftplugin-overrule, :help after-directory.

The quick way to get started is to move all the language-specific stuff from your .vimrc file into a file named .vim/ftplugin/language.vim.

This turns a .vimrc that looks like this:

autocmd FileType * set tabstop=2|set shiftwidth=2|set noexpandtab
autocmd FileType python set tabstop=4|set shiftwidth=4|set expandtab
au BufEnter *.py set ai sw=4 ts=4 sta et fo=croql

Into this:

" ~/.vimrc
" Global settings for all files, unless I want to override them
set tabstop=2
set shiftwidth=2
set noexpandtab

" ~/.vim/ftplugin/python.vim
" Python-specific settings
setlocal tabstop=4
setlocal shiftwidth=4
setlocal expandtab
setlocal autoindent
setlocal smarttab
setlocal formatoptions=croql

If there's a filetype plugin distributed with Vim that you want to completely disable, make your own (perhaps empty) settings file and adding this line:

let b:did_ftplugin = 1

If you like most of what Vim's filetype plugin is doing, but you want to override something specific, you can place your settings in .vim/after/ftplugin/language.vim. More info can be found in :help after-directory

If there's a new file extension that you want Vim to recognize, don't muck about with augroup in your .vimrc, put the settings in the right place. Read up in :help ftdetect.

There's a lot more you can do with your .vim directory. ~/.vim/compiler is a good place to keep configuration that gets applied on a per-compiler basis (for example, I might need to use any of javac, jikes, ant, or make to compile and parse the compiler output for a java source file.) I also like to keep a couple color schemes in ~/.vim/colors, and I keep notes in vimhelp format in ~/.vim/doc. Periodically running :helptags ~/.vim/doc lets me jump to a tag in those notes using :h. :help helptags :help vimfiles

[edit] Comments

Rate this article:

Share this article:

Hubs Highlights International Sites Wikia messages
Entertainment
Gaming
Cartoons & Comics
Science Fiction
Hobbies
Sports
See all...
Grand Theft Auto
Terminator Wiki
Legend of Zelda Wiki
Flash Gordon
Everquest II Wiki
Yo-Yo Wiki
German
Spanish
Chinese
Japanese
More...
Wikia is hiring for several open positions
Send this article to a friend
"Keep your vimrc file clean"
 
 
Hi!

I thought you'd like this page from Wikia!

http://vim.wikia.com

Come check it out!
Send confirmation