Autocmd InsertEnter 在 init.lua 中突出显示光标不起作用 完整init.lua

问题描述

我正在从经过良好测试并使用多年 init.vim 的产品迁移到新的 init.lua。最后两行没有显示错误，但它们不起作用。这个想法是在我输入 insert mode 时显示下划线，并在输入 normal mode 时将其删除。

在init.lua

vim.cmd('highlight Cursorline cterm=NONE gui=NONE guibg=NONE')
vim.cmd('autocmd InsertEnter * highlight Cursorline cterm=underline gui=underline') -- Does not work
vim.cmd('autocmd InsertLeave * highlight Cursorline cterm=NONE gui=NONE')           -- Does not work

---

完整init.lua

-- General setting
vim.api.nvim_set_option('mouse','a')
vim.api.nvim_set_option('laststatus',2)
vim.api.nvim_set_option('title',true)
vim.api.nvim_set_option('cursorline',true)
vim.api.nvim_set_option('clipboard','unnamedplus') -- Register * as clipboard
vim.api.nvim_set_option('ignorecase',true)         -- Search ignore case
vim.api.nvim_set_option('splitright',true)
vim.api.nvim_set_option('splitbelow',true)

-- Search
vim.api.nvim_set_option('hlsearch',true)           -- Highlight search
vim.api.nvim_set_option('incsearch',true)          -- set incremental search

-- UTF-8
vim.api.nvim_set_option('encoding','utf-8')
vim.api.nvim_set_option('fileencoding','utf-8')
--vim.api.nvim_set_option('termencoding','utf-8')

-- Tabs
vim.api.nvim_set_option('expandtab',false)
vim.api.nvim_set_option('tabstop',4)
vim.api.nvim_set_option('shiftwidth',4)
vim.api.nvim_set_option('textwidth',100)
--vim.api.nvim_set_option('',)

-- Colors
vim.api.nvim_set_option('termguicolors',true)
vim.api.nvim_set_option('syntax','on')
vim.api.nvim_command('colorscheme oceanicnext')

-- SHORTCUTS --------------------------------------------------
-- General shortcuts
vim.api.nvim_set_keymap('n','cc',':!make',{})
vim.api.nvim_set_keymap('n','<S-s><S-s>',':w<cr>','ls',':buffers<cr>','gb',':w<cr>:buffers<cr>:b<space>','<space>','/',{})

-- LaTeX shortcuts
vim.api.nvim_command('augroup filetype_tex')
    -- Begin End block
    vim.api.nvim_command('autocmd filetype tex inoremap <C-B> <ESC>YpkI\\begin{<ESC>A}<ESC>jI\\end{<ESC>A}<esc>kA')

    -- Greek letters
    vim.api.nvim_set_keymap('i','<C-g>a','\\alpha',{noremap=true})
    vim.api.nvim_set_keymap('i','<C-g>b','\\beta','<C-g>e','\\epsilon','<C-g>g','\\gamma','<C-g>l','\\lambda','<C-g>m','\\mu','<C-g>o','\\omega','<C-g>s','\\sigma',{noremap=true})

    -- Pretty letter for sets
    vim.api.nvim_set_keymap('i','<C-b>c','\\mathbb{C}','<C-b>k','\\mathbb{K}','<C-b>n','\\mathbb{N}','<C-b>r','\\mathbb{R}',{noremap=true})

    -- Vectors
    vim.api.nvim_set_keymap('i','<C-e>0','\\vec{0}','<C-e>e','\\vec{e}','<C-e>u','\\vec{u}','<C-e>v','\\vec{v}','<C-e>w','\\vec{w}','<C-e>x','\\vec{x}','<C-e>y','\\vec{y}','<C-e>z','\\vec{z}',{noremap=true})
vim.api.nvim_command('augroup end')


-- Relative line numbers
vim.api.nvim_set_option('number',true)
vim.api.nvim_set_option('relativenumber',true)
vim.cmd('augroup numbertoggle')
vim.cmd('autocmd!')
vim.cmd('autocmd BufEnter,FocusGained,InsertLeave * :set relativenumber')
vim.cmd('autocmd BufLeave,FocusLost,InsertEnter   * :set norelativenumber')
vim.cmd('autocmd BufLeave,InsertEnter   * :set number')
vim.cmd('augroup end')

-- Change aspect if in insert mode or not
vim.cmd('highlight Cursorline cterm=NONE gui=NONE guibg=NONE')
vim.cmd('autocmd InsertEnter * highlight Cursorline cterm=underline gui=underline')
vim.cmd('autocmd InsertLeave * highlight Cursorline cterm=NONE gui=NONE')

解决方法

有一个错误，但不是 autocmd。您可以判断您在 Vim 中是否:set cursorline 高亮显示有效。

此时您可能会感到困惑，因为您已经拥有了：

vim.api.nvim_set_option('cursorline',true)

在你的 init.nvim 中。应该有用吧？

好吧，结果不是。看看这个：

:echo &cursorline
:lua vim.api.nvim_set_option('cursorline',true)
:echo &cursorline

在 nvim 0.5.0-beta（几周前构建，nvim 没有明确说明确切时间）中，它的输出是两个零 - 不是 0 和 1。如在，nvim_set_option('cursorline',true) 没有影响。真材实料。

让我们看看 :h 'cursorline' 一分钟：

                        'cursorline' 'cul' 'nocursorline' 'nocul'
'cursorline' 'cul'      boolean (default off)
                        local to window
                        {not available when compiled without the +syntax
                        feature}
        Highlight the text line of the cursor with CursorLine hl-CursorLine.
        Useful to easily spot the cursor.  Will make screen redrawing slower.
        When Visual mode is active the highlighting isn't used to make it
        easier to see the selected text.

仔细查看 local to window - 这就是您的代码不起作用的原因。我不会假装理解为什么（因为我不经常使用 nvim，而且我个人认为 lua api 一团糟），但是 nvim_set_options 不适用于窗口变量。有趣的是，如果您尝试将 int 而不是 bool 传递给 cursorline，该方法将抛出错误，但它仍然无法像您期望的那样设置它。我会在帖子的末尾回到这一点。

让我们看另一个带有任意变量的例子； 'foldmarker'

:echo &foldmarker
> {{{,}}}
:lua vim.api.nvim_set_option('foldmarker','literally,anythingelse')
> (completes,no error)
:echo &foldmarker
> {{{,}}}
:lua vim.api.nvim_win_set_option(0,'foldmarker',no error)
:echo &foldmarker
> literally,anythingelse

作为给读者的练习，第一步也可以用 'paste' 完成。 'paste' 是一个全局变量，据推测，nvim_win_set_option(0,'paste',true) 会抛出

有趣的是，这仅适用于普通的 :set：

:set foldmarker&
:echo &foldmarker
> {{{,}}}
:set foldmarker=literally,anythingelse
:echo &foldmarker
> literally,anythingelse

这意味着，修复代码所需要做的就是：

vim.api.nvim_win_set_option(0,'cursorline',true)

或者：

vim.api.nvim_command('set cursorline')

TL;DR：之所以有效，是因为您现在实际上是在设置 cursorline。无法使用 vim.api.nvim_set_option(name,value) 设置窗口选项（我不知道为什么）。您的自动命令很好，但它们不起作用，因为 cursorline 已关闭。这也与亮点本身无关；清除突出显示只会隐藏光标线，并不会禁用光标线选项。这也意味着在这种情况下您的 autocmds 和高亮显示没问题，但是是您对窗口变量使用了错误的 API 函数导致了这个问题。

还有最后一点建议：检查您正在设置的变量的文档。如果它说窗口，你必须使用nvim_win_set_option，如果它是一个缓冲区，你需要nvim_buf_set_option。这些也包含在 nanotee 的 nvim lua guide 中 - 它还涵盖了额外变量的含义。

---

我不完全确定此行为是否构成错误，或者它是否只是不直观的 API 设计，but I found a bug related to 'number' 在完成可能表明这是预期行为的其余答案后研究错误报告时。不过，我不会将其报告为错误，也不会提出问题来询问这是否有意，所以这只是我这边的温和猜测。但是，手头的证据仍然使它看起来像是有意为之。

这也意味着如果您使用 *_set_option() API，您必须确保您知道要设置的变量类型。如果它真的打算让 nvim_set_option() 以静默方式使窗口选项失败，则您必须手动检查以确保在正确的变量上使用正确的函数，因为 API 函数不会告诉您何时你这样做是错的。或者只是使用 vim.api.nvim_command() - Vim 的 :set 确实正确设置了窗口变量。