`local-highlight.nvim` 使用教程

local-highlight.nvim 使用教程

local-highlight.nvim 项目地址: https://gitcode.com/gh_mirrors/lo/local-highlight.nvim

1. 项目目录结构及介绍

local-highlight.nvim 是一个为 Neovim 设计的高性能局部高亮插件，它利用正则表达式和 extmarks 来实现光标下单词的快速高亮。以下是基本的项目结构概览：

local-highlight.nvim
├── doc             # 文档目录，包括插件的使用手册 README.md
├── lua             # Lua 源码目录，存放插件的核心逻辑
│   └── local-highlight.lua
├── stylua.toml     # Stylua 配置文件，用于代码风格统一
├── LICENSE         # 许可证文件，遵循 Apache-2.0 协议
├── README.md       # 主要的项目介绍和说明文档
└── .gitignore      # Git 忽略文件配置

• lua/local-highlight.lua: 核心脚本，包含了插件的所有功能实现。
• doc: 包含插件的详细文档，如安装和配置说明。
• stylua.toml: 如果你关注Lua代码的样式一致性，这个配置用于Stylua代码格式化工具。

2. 项目的启动文件介绍

虽然没有明确的“启动文件”概念，但在 Neovim 中，插件一旦被正确安装并通过初始化脚本(init.vim 或 .config/nvim/init.lua)启用，就会自动“启动”。通常，通过以下方式调用插件：

-- 对于 Vimscript (init.vim)
call plug#begin('~/.vim/plug-in')
Plug 'tzachar/local-highlight.nvim'
call plug#end()
" 然后在 Vim 脚本中配置
let g:local_highlight_enabled = 1

-- 对于 Lua (init.lua)
vim.api.nvim_set_packpath('/path/to/your/pack/path', { 'r' })
require("plenary").installer.install({
    {"tzachar/local-highlight.nvim", requires = {"plenary.nvim"}}
})
require('local-highlight').setup{}

这里的配置确保插件加载，并通过调用 require('local-highlight').setup{} 进行初始化。

3. 项目的配置文件介绍

local-highlight.nvim 的配置不依赖于单独的配置文件，而是通过 Lua 脚本中的 require('local-highlight').setup{} 函数来进行。下面是部分可配置项示例：

require('local-highlight').setup{
    file_types = {'python', 'cpp'},          -- 限制只在指定文件类型中激活
    disable_file_types = {'tex'},            -- 在特定文件类型中禁用
    hlgroup = 'Search',                      -- 自定义高亮组名称，默认是LocalHighlight
    insert_mode = false,                     -- 是否在插入模式下也展示高亮
    min_match_len = 1,                       -- 最小匹配长度
    max_match_len = math.huge,                -- 最大匹配长度，这里是无上限
    highlight_single_match = true,           -- 是否高亮唯一匹配项
}

• file_types: 指定此插件应附加到哪些文件类型的缓冲区。
• disable_file_types: 设置不想应用插件的文件类型列表。
• hlgroup: 自定义高亮使用的组名，改变默认的高亮效果。
• insert_mode: 控制是否在插入模式下也保持高亮。
• min_match_len 和 max_match_len: 控制匹配单词的长度范围。
• highlight_single_match: 当设置为 false 时，如果只有一个匹配项，则不会高亮显示。

通过上述步骤和配置，你可以定制和启用 local-highlight.nvim，以优化你在 Neovim 中的编码体验。

local-highlight.nvim 项目地址: https://gitcode.com/gh_mirrors/lo/local-highlight.nvim