Wikia

Vim Tips Wiki

Changes: File type plugins

Edit

Back to page

(Change <tt> to <code>, perhaps also minor tweak.)
(Disabling default ftplugins)
 
(2 intermediate revisions by 2 users not shown)
Line 24: Line 24:
 
</pre>
 
</pre>
   
to your [[vimrc]], ''before'' the <code>:filetype ftplugin on</code> line.
+
to your [[vimrc]], ''before'' the <code>:filetype plugin on</code> line.
   
 
==Setting a default filetype==
 
==Setting a default filetype==
Line 36: Line 36:
 
You can set the filetype of the current buffer with a command like this example:
 
You can set the filetype of the current buffer with a command like this example:
 
<pre>
 
<pre>
set ft=python
+
:set ft=python
 
</pre>
 
</pre>
   
Another approach is to assign a file name when creating the blank buffer, for example, by entering a command like <code>gvim mynewfile.py</code> to start Vim, or with commands like these from within Vim:
+
Another approach is to assign a file name when creating the blank buffer, for example, by entering a command like <code>vim mynewfile.py</code> to start Vim, or with commands like these from within Vim:
 
<pre>
 
<pre>
 
:new mynewfile.py
 
:new mynewfile.py
Line 50: Line 50:
 
" default filetype
 
" default filetype
 
let g:do_filetype = 0
 
let g:do_filetype = 0
au GUIEnter,BufAdd * if expand('<afile>') == "" | let g:do_filetype = 1 | endif
+
au BufWinEnter,BufAdd * if expand('<afile>') == "" | let g:do_filetype = 1 | endif
 
au BufEnter * if g:do_filetype | setf python | let g:do_filetype = 0 | endif
 
au BufEnter * if g:do_filetype | setf python | let g:do_filetype = 0 | endif
 
</pre>
 
</pre>
   
<code>GUIEnter</code> is for the buffer that is opened on startup. <code>BufAdd</code> is for new blank buffers.
+
<code>BufWinEnter</code> is for the buffer that is opened on startup. <code>BufAdd</code> is for new blank buffers.
   
 
Why the need to use a global variable, and not set the <code>filetype</code> immediately, is to my understanding, because the buffer hasn't been fully created when the autocmd is triggered.
 
Why the need to use a global variable, and not set the <code>filetype</code> immediately, is to my understanding, because the buffer hasn't been fully created when the autocmd is triggered.

Latest revision as of 17:38, February 5, 2014

Tip 130 Printable Monobook Previous Next

created 2001 · complexity intermediate · author Benji Fisher · version 6.0


A file type plugin (ftplugin) is a script that is run automatically when Vim detects the type of file when the file is created or opened. The type can be detected from the file name (for example, file sample.c has file type c), or from the file contents.

OverviewEdit

For an overview of file type plugins see :help ftplugins.

Disabling default ftpluginsEdit

If you want to disable all ftplugins, or disable a particular default ftplugin, see :help :filetype and :help ftplugin-overrule.

If you have your own ftplugins, and you want to disable all the default ones, then do not include a check for b:did_ftplugin in your ftplugin files, and add the line

:autocmd BufEnter * let b:did_ftplugin = 1

to your vimrc, before the :filetype plugin on line.

Setting a default filetypeEdit

When you edit a blank buffer (for example, just after starting Vim, or as a result of the :new command), the buffer will have no filetype so there will be no syntax highlighting or other ftplugin assistance.

You can check the filetype of the current buffer with command:

:set ft?

You can set the filetype of the current buffer with a command like this example:

:set ft=python

Another approach is to assign a file name when creating the blank buffer, for example, by entering a command like vim mynewfile.py to start Vim, or with commands like these from within Vim:

:new mynewfile.py
:edit mynewfile.py
:tabnew mynewfile.py

Alternatively, the following in your vimrc will set a default filetype for all new buffers:

" default filetype
let g:do_filetype = 0
au BufWinEnter,BufAdd * if expand('<afile>') == "" | let g:do_filetype = 1 | endif
au BufEnter * if g:do_filetype | setf python | let g:do_filetype = 0 | endif

BufWinEnter is for the buffer that is opened on startup. BufAdd is for new blank buffers.

Why the need to use a global variable, and not set the filetype immediately, is to my understanding, because the buffer hasn't been fully created when the autocmd is triggered.

See alsoEdit

CommentsEdit

 TO DO 

Around Wikia's network

Random Wiki