日期:2023年11月3日标签:DeveloperHandbook

Vscode Neovim #

最近用公司电脑开发时,使用 vscode-vim 编写代码遇到了几次卡顿延迟的情况,所以就把 vim 插件换成了 vscode-neovim

vim 快捷键:https://pengfeixc.com/blogs/developer-handbook/vim-shortcuts

Vscode-Neovim Vs Vscode-Vim #

vscode-neovim 与 vscode-vim 相比有以下两点优势:

  1. vscode 上的 vim 插件只是 vim 的模拟器,也就是阉割版的 vim,而 neovim 插件不是,所以 vscode-neovim 功能更全
  2. vscode-neovim 性能更好,使用了几天没有发现卡顿延迟的现象

vscode 与 neovim 协作 #

vscode-neovim 的工作原理是将 neovim 编辑器嵌入到 vscode 中,以实现完整的 vim 功能。这意味着,你可以给 neovim 安装插件,并且在 vscode 中生效。

当打开一个安装 vscode-neovim 插件的 vscode,实际上发生了什么?

  1. 启动 vscode 后,会立刻启动 neovim 实例,并与 neovim 实例进行连接通信。
  2. vscode 打开文件后,neovim 会随之创建一个缓冲区,填入文件内容
  3. 用户通过 vscode 操作文档,vscode 会将所有的按键传给 neovim,就像用户直接使用 neovim 一样。vscode 只不过起到了桥梁的作用。

安装 #

可以参考官方安装指南进行安装:vscode-neovim installation

我这里做一个简单的翻译:

  1. 在 vscode 插件里搜索 vsode-neovim 插件,进行安装
  2. 安装 Neovim,需要安装 0.9.0 之后的版本:https://github.com/neovim/neovim/wiki/Installing-Neovim
  3. vscode 设置文件 settings.json 中需要添加以下设置:
"extensions.experimental.affinity": {
    "asvetliakov.vscode-neovim": 1
},
// neovim 安装路径,下面是 windows 和 linux(or wsl)的路径,你需要改成你的电脑上安装的路径
"vscode-neovim.neovimExecutablePaths.win32": "C:\\Program Files\\Neovim\\bin\\nvim.exe",
"vscode-neovim.neovimExecutablePaths.linux": "/usr/bin/nvim",
// 如果是 wsl 需要开启这个设置
"vscode-neovim.useWSL": true,
  1. 需要添加 neovim 配置文件,linux 的 neovim 配置文件在 ~/.config/nvim/init.vim 中,windows 的 neovim 配置文件在 C:/Users/(你的用户名)/AppData/Local/nvim/init.vim,如果路径不存在,则新建。

  2. vscode-neovim 和 neovim 使用同一个 init.vim 配置文件,但是在里面需要做区分,防止打开 vscode 后会启动大量 neovim 的插件,影响速度。

if exists('g:vscode')
    " VSCode extension
else
    " ordinary Neovim
endif

" VScode extension and ordiary neovim extension

另外 neovim 配置支持 lua 语法,只需要将 init.vim 改为 init.lua 即可,lua 的语法比 vimscript 更加简单。

if vim.g.vscode then
    -- VSCode extension
else
    -- ordinary Neovim
end

我的配置 #

通过 lua 语法设置,更易懂。

  1. vscode neovim 折叠代码快捷键失效
  2. neovim 搜索忽略大小写
  3. neovim 使用系统剪贴板
-- 1.options
-- Hint: use `:h <option>` to figure out the meaning if needed
vim.opt.clipboard = 'unnamedplus'   -- use system clipboard 
vim.opt.completeopt = {'menu', 'menuone', 'noselect'}
vim.opt.mouse = 'a'                 -- allow the mouse to be used in Nvim

-- Searching
vim.opt.incsearch = true            -- search as characters are entered
vim.opt.hlsearch = true            -- do not highlight matches
vim.opt.ignorecase = true           -- ignore case in searches by default
vim.opt.smartcase = true            -- but make it case sensitive if an uppercase is entered

-- Tab
vim.opt.tabstop = 4                 -- number of visual spaces per TAB
vim.opt.softtabstop = 4             -- number of spacesin tab when editing
vim.opt.shiftwidth = 4              -- insert 4 spaces on a tab
vim.opt.expandtab = true            -- tabs are spaces, mainly because of python

-- UI config
vim.opt.number = true               -- show absolute number
vim.opt.relativenumber = true       -- add numbers to each line on the left side
vim.opt.cursorline = true           -- highlight cursor line underneath the cursor horizontally
vim.opt.splitbelow = true           -- open new vertical split bottom
vim.opt.splitright = true           -- open new horizontal splits right
-- vim.opt.termguicolors = true        -- enabl 24-bit RGB color in the TUI
vim.opt.showmode = false            -- we are experienced, wo don't need the "-- INSERT --" mode hint

vim.opt.wrap = false          -- Wrapping sucks (except on markdown)
vim.opt.swapfile = false      -- Do not leave any backup files
vim.opt.showmatch  = true     -- Highlights the matching parenthesis
vim.opt.signcolumn = "yes"    -- Always show the signcolumn, otherwise it would shift the text
vim.opt.hidden = true         -- Allow multple buffers
vim.opt.shortmess:append("c") -- Don't pass messages to |ins-completion-menu|.
vim.opt.encoding = "utf-8"    -- Just in case
vim.opt.cmdheight = 2           -- Shows better messages

vim.opt.foldmethod = "indent"
vim.opt.foldlevel = 99

-- 2.keymaps
-- define common options
local opts = {
    noremap = true,      -- non-recursive
    silent = true,       -- do not show message
}

local map = vim.api.nvim_set_keymap
map("n", "<Space>", "<Nop>", opts)
vim.g.mapleader = " "
vim.g.maplocalleader = " "

-----------------
-- Normal mode --
-----------------

-- Hint: see `:h vim.map.set()`
-- Better window navigation
vim.keymap.set('n', '<C-h>', '<C-w>h', opts)
vim.keymap.set('n', '<C-j>', '<C-w>j', opts)
vim.keymap.set('n', '<C-k>', '<C-w>k', opts)
vim.keymap.set('n', '<C-l>', '<C-w>l', opts)

-- Resize with arrows
-- delta: 2 lines
vim.keymap.set('n', '<C-Up>', ':resize -2<CR>', opts)
vim.keymap.set('n', '<C-Down>', ':resize +2<CR>', opts)
vim.keymap.set('n', '<C-Left>', ':vertical resize -2<CR>', opts)
vim.keymap.set('n', '<C-Right>', ':vertical resize +2<CR>', opts)

-- NvimTree
vim.keymap.set('n', '<C-n>', ':NvimTreeToggle<CR>', {})
vim.keymap.set('n', '<A-n>', ':NvimTreeFindFile<CR>', {})
vim.keymap.set('n', '-', ':NvimTreeCollapse<CR>', {})

-- buffer
vim.keymap.set('n', '<leader>bp', ':bp<CR>')
vim.keymap.set('n', '<leader>bn', ':bn<CR>')

-- vscode 专用设置
if vim.g.vscode then
    local fold = {
        unfoldAll = function()
            vim.fn.VSCodeNotify("editor.unfoldAll")
        end,
        foldAll = function()
            vim.fn.VSCodeNotify("editor.foldAll")
        end,
        fold = function()
            vim.fn.VSCodeNotify("editor.fold")
        end,
        unfold = function()
            vim.fn.VSCodeNotify("editor.unfold")
        end,
    }

    -- 需要安装 bookmarks 插件使用
    local bookmarks = {
        jumpToPrevious = function()
            vim.fn.VSCodeNotify("bookmarks.jumpToPrevious")
        end,
        jumpToNext = function()
            vim.fn.VSCodeNotify("bookmarks.jumpToNext")
        end,
        toggle = function()
            vim.fn.VSCodeNotify("bookmarks.toggle")
        end,
        clear = function()
            vim.fn.VSCodeNotify("bookmarks.clearFromAllFiles")
        end,
    }
    
    local codeReader = {
        quickInfo = function()
            vim.fn.VSCodeNotify("editor.action.showHover")
        end,
    }

    vim.keymap.set('n', 'zR', fold.unfoldAll)
    vim.keymap.set('n', 'zM', fold.foldAll)
    vim.keymap.set('n', 'zo', fold.unfold)
    vim.keymap.set('n', 'zc', fold.fold)

    vim.keymap.set('n', '<leader>bb', bookmarks.toggle)
    vim.keymap.set('n', '<leader>bc', bookmarks.clear)
    vim.keymap.set('n', '<leader>bp', bookmarks.jumpToPrevious)
    vim.keymap.set('n', '<leader>bn', bookmarks.jumpToNext)

    vim.keymap.set('n', '<c-h>', codeReader.quickInfo)
else
     -- ordinary Neovim
end

你也可以在这里获取我的 vscode 配置:自用 vscode 配置

(完)

目录