Vim-addon-local-vimrc 使用教程

1. 项目介绍

vim-addon-local-vimrc 是一个 Vim 插件，它允许用户在每个项目目录中使用局部的 .vimrc 配置文件。这个插件会在 Vim 启动时自动遍历从根目录到当前文件所在目录的路径，寻找并加载 .vimrc 或 .vimrc.lua 配置文件。为了安全性，该插件会在加载配置文件之前计算其哈希值，如果文件未知，则需要用户确认是否加载。当文件被修改后，哈希值会自动更新。

2. 项目快速启动

首先，确保你已经安装了 Vim 编辑器。

# 克隆项目到本地
git clone https://github.com/MarcWeber/vim-addon-local-vimrc.git

# 进入项目目录
cd vim-addon-local-vimrc

# 将插件安装到 Vim 的插件目录
cp -r plugin/* ~/.vim/plugin/

在项目的根目录下创建一个 .vimrc 文件，并添加自定义的 Vim 配置。以下是一个简单的配置文件示例：

augroup LOCAL_SETUP
    autocmd BufRead,BufNewFile *.sql,*.php call vim_addon_sql#Connect('mysql', { 'database': 'DATABASE', 'user': 'USER', 'password': 'PASSWORD' })
    autocmd FileType php setlocal noexpandtab | setlocal tabstop=4 | setlocal sw=4
augroup end

启动 Vim 并打开一个文件，插件将自动应用 .vimrc 文件中的设置。

3. 应用案例和最佳实践

• 局部配置管理：在不同的项目中使用不同的 Vim 配置，以适应特定的开发需求。
• 安全性增强：通过哈希验证避免加载未知的或可能有害的配置文件。
• 自定义文件类型支持：在局部 .vimrc 文件中定义针对特定文件类型的配置，如 SQL 或 PHP。

4. 典型生态项目

目前，vim-addon-local-vimrc 没有明确列出依赖的生态项目。但是，你可以结合以下类型的 Vim 插件来增强你的开发体验：

• 代码自动完成插件：如 vim-addon-sql，为 SQL 文件提供自动完成功能。
• 代码格式化插件：如 vim-autoformat，自动格式化代码。
• 项目管理插件：如 NERDTree，提供文件系统浏览器。

通过这些插件和 vim-addon-local-vimrc 的结合使用，可以极大地提升使用 Vim 进行项目开发时的效率。