vim-addon-local-vimrc


Ⅰ. 插件描述

kiss local vimrc with hash protection

Ⅱ. 基本信息

创建日期:  2011-07-30
使用用户:  111
Github星:  135
插件作者:  Marc Weber

Ⅲ. 安装方法

使用Vundle管理器安装

在你的.vimrc下添加:
Plugin 'marcweber/vim-addon-local-vimrc'
… 然后在Vim中运行以下命令:
:source %
:PluginInstall

对于Vundle版本 < 0.10.2,请用上面的Bundle替换Plugin。

使用NeoBundle管理器安装

在你的.vimrc下添加:
NeoBundle 'marcweber/vim-addon-local-vimrc'
… 然后在Vim中运行以下命令:
:source %
:NeoBundleInstall

使用VimPlug管理器安装

在你的.vimrc下添加:
Plug 'marcweber/vim-addon-local-vimrc'
… 然后在Vim中运行以下命令:
:source %
:PlugInstall

使用Pathogen管理器安装

在终端中运行以下命令:
cd ~/.vim/bundle
git clone https://github.com/marcweber/vim-addon-local-vimrc

Ⅳ. 文档说明

vim-addon-local-vimrc

Configuration: these are the defaults:

let g:local_vimrc = {'names':['.vimrc'],'hash_fun':'LVRHashOfFile'}

Features:

  • When Vim starts up, every directory from root to the directory of the file
    is traversed and special files such as .(local-)vimrc files are sourced
  • Because you don't want to run untrusted code by accident, this plugin
    calculates a hash before sourcing. If its unknown you must confirm sourcing

the file. The hash is updated automatically if you write a local vimrc file.

  • if you change a directory and edit a file the local vimrc files are resourced

USAGE:

create a .vimrc in your project directory.
To make sure it's working, add: echo "this file is being sourced by vim"

Sample local .vimrc

augroup LOCAL_SETUP
  " using vim-addon-sql providing alias aware SQL completion for .sql files and PHP:
  autocmd BufRead,BufNewFile *.sql,*.php call vim_addon_sql#Connect('mysql',{'database':'DATABASE', 'user':'USER', 'password' : 'PASSWORD'})

  " for php use tab as indentation character. Display a tab as 4 spaces:
  " autocmd BufRead,BufNewFile *.php set noexpandtab| set tabstop=4 | set sw=4
  autocmd FileType php setlocal noexpandtab| setlocal tabstop=4 | setlocal sw=4

  " hint: for indentation settings modelines can be an alternative as well as
  " various plugins trying to set vim's indentation based on file contents.
augroup end

KISS: If you need filetype support write au commands into the local vimrc.

Yes I know that there are already a couple of existing similar plugins.
But I they work for filetypes only (why?) and they don't verify file contents.

Alternatives

directory local .vimrc without walking up directory tree using vim builtin 'exrc' option:
:h 'exrc'
:h 'secure'
but 'secure' is not very secure, eg echo system('cat .vimrc') is executed
unless the file belongs to a different owner..

contributors

Thiago de Arruda (github.com/tarruba)

添加新评论