Vim plugin 的设计与原理 [ Jackon.me ]

vim 的个性化设置和功能扩展，均通过 script 实现，又叫 plugin。
plugin 是 vim 的精髓。

最常用的配置文件 vimrc，也是一种 plugin。
换句话说，所有的 plugin 都在配置 vim 的行为。

总体概念

plugin 类型及其相互关系

常见的 5 种 plugin 类型：

vimrc
global
filetype
syntax
compiler

vimrc 是 plugin 执行的入口(类似 main 函数)，
所有的配置都可以在这一个文件中完成。
所有其他配置都直接或间接由该文件调用以生效。

与其他编程语言一样，为了提高源文件的可读性，增加代码的可重用性等，
衍生出了 global/filetype/syntax/compile 等 4 种主要 plugin。
通过 runtime, source 等命令加载其他 plugin

vim 通过路径区分 plugin 类型。
配置目录下的一个子目录，是一类 plugin。

vim 搜索路径

由 runtimepath 控制搜索顺序，一旦找到立即停止。

默认搜索顺序：

$HOME/.vim: Max/Linux 是 home 目录下的 .vim/
$VIMRUNTIME: 系统自带的 plugin

建议将个性化配置全部放在 $HOME/.vim 中，
与 vim 自带的配置文件隔离，方便备份。

vim 中查看 plugin 的搜索路径(runtimepath)

1
2
3

:set runtimepath?
runtimepath=~/.vim,/var/lib/vim/addons,/usr/share/vim/vimfiles,/usr/share/vim/
vim73,/usr/share/vim/vimfiles/after,/var/lib/vim/addons/after,~/.vim/after

plugin 安装

copy 到对应目录下即可。根据 plugin 类型选择 copy 的目录。
更新帮助文档。在 vim 中运行 :helptags ~/vimfiles/doc

重点 plugin 介绍

global plugin

global plugin 位于 plugin 目录下，对全局生效，所以默认自动加载。

filetype plugin

filetype plugin 只对特定类型的文件生效。

通过事件监听(autocmd)，获取打开文件的类型，然后加载对应的 plugin。

在 .vimrc 中配置 autocmd 规则：

" required
filetype plugin on
" define behavior when filetype change to `tt`
" here, the behavior is set to execute `echo "hello"`
autocmd FileType tt echo "hello"

用 Vim 打开扩展名为 .tt 的文件，或者在 Vim 中执行 :set filetype=tt，可以看到 “hello” 输出。

如果没有用 autocmd 显式声明 xxx 文件对应的行为，
则加载 ftplugin 目录下的 xxx.vim

1
2
3

:set filetype=c
"expt: load c.vim and change highlight in c syntax
"required: c.vim in ftplugin, it is in $VIMRUNTIME/ftplugin by default

注意：使用 ftplugin 时，需要开启 filetype 和 filetype plugin

" 开启 filetype 和 filetype plugin
:filetype plugin on
" 查看 filetype plugin 开启状态
:filetype
filetype detection:ON  plugin:ON  indent:ON

一个更深入 filetype plugin 的例子 – 基于 buffer 监听 .xml 文件的创建或打开。

1	autocmd BufNewFile,BufRead *.xml source ~/.vim/ftplugin/xml.vim

功能是

监听的事件: 创建或打开 .xml文件(BufNewFile,BufRead)
执行的行为: 加载 ftplugin/xml.vim

syntax plugin

原理与 ftplugin 类似，监听 syntax 事件，加载 syntax 目录下的插件。

触发 filetype 事件的同时，也会触发对应的 syntax 事件。

1 2	syntax on :set syntax=c

compile plugin

同样是事件监听，插件位于 compiler 目录。

" add below to vimrc
autocmd BufNewFile,BufRead *.py compiler python`
" open a file ending with .py and run
:make
" expt: errors printed

Vim plugin 的设计与原理