Vim-addon-local-vimrc 使用与配置指南

1. 项目目录结构及介绍

vim-addon-local-vimrc 项目是一个用于 Vim 编辑器的插件，它允许用户在每个项目中指定本地配置文件（如 .vimrc 或 .vimrc.lua）。项目的目录结构相对简单，主要包括以下几个部分：

• plugin 目录：包含插件的主要脚本文件。
• LICENSE.txt：项目的 MIT 许可证文件。
• README.md：项目的说明文档。

项目的核心功能是通过 plugin 目录中的脚本实现的，而 README.md 提供了项目的基本信息和使用说明。

2. 项目的启动文件介绍

vim-addon-local-vimrc 插件在 Vim 启动时会自动加载。它没有特定的启动文件，但是其功能在 Vim 运行时始终生效。插件的工作原理是：

• 当 Vim 启动时，插件会遍历从根目录到当前文件所在目录的所有目录。
• 对于每个目录，插件会查找 .vimrc 或 .vimrc.lua 等特殊文件并尝试加载它们。
• 在加载之前，插件会计算文件的哈希值，以确保安全性。如果哈希值未知，用户需要确认是否加载文件。

3. 项目的配置文件介绍

项目的配置主要通过 .vimrc 或 .vimrc.lua 文件进行。以下是一些基本的配置选项：

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

• 'names' 选项用于指定要加载的本地配置文件的名称。
• 'hash_fun' 选项指定用于计算文件哈希值的函数。

在项目的本地配置文件中，用户可以定义自动命令（augroup），设置文件类型相关的配置，例如为 SQL 和 PHP 文件提供自动完成和缩进设置。以下是一个示例配置：

augroup LOCAL_SETUP
    " 为 SQL 和 PHP 文件提供自动完成
    autocmd BufRead,BufNewFile *.sql,*.php call vim_addon_sql#Connect('mysql', {'database': 'DATABASE', 'user': 'USER', 'password': 'PASSWORD'})
    " 为 PHP 文件设置制表符缩进
    autocmd BufRead,BufNewFile *.php set noexpandtab | set tabstop=4 | set sw=4
augroup end

用户可以根据自己的需要，在本地配置文件中添加或修改配置。