“我报名参加金石计划1期挑战——瓜分10万奖池，这是我的第1篇文章，点击查看活动详情”
neovim IDE基本使用说明
安装须知
仓库地址： github.com/HUAHUAI23/n…
需要准备的东西
- 请确保系统有
git，tar，curl，wget，和基本的编译环境例如gcc和libstdc++库，ubuntu可以通过sudo apt install git tar curl wget build-essential安装上面所需软件。 - 网络环境可以流畅的访问github
如何安装
nvim.tar包的目录结构如下
├── initial.sh
├── int42.sh
├── nvim-linux64.tar
├── open.sh
├── runtime
└── share
nvim-linux64.tar是neovim官方的portable版 github.com/neovim/neov… 将nvim.tar包下载下来后执行如下命令
tar -xf nvim.tar
cd nvim64
bash initial.sh
rm -rf trush
cd nvim-linux64/bin/
# 将为当前shell环境添加alias，即终端输入n就可以打开neovim，等效于nvim-linux64/bin/nvim
source int42.sh
第一次进入neovim后，neovim会自动下载插件,下载完插件后可以退出待第二次继续进入neovim，第二次进入neovim时请执行:TSupdate 更新treesitter和执行:PackSync 更新插件，为保证LSP正常工作，须执行:Mason 然后将这些全部安装"bash-language-server", "shfmt", "shellcheck", "stylua", "lua-language-server", "black", "pyright", "pylint", "debugpy", "clang-format", "clangd", "cpptools", "eslint-lsp", "eslint_d", "node-debug2-adapter", "typescript-language-server", "quick-lint-js", "prettier", "sqls", "sql-formatter", "json-lsp", "html-lsp", "fixjson", "emmet-ls", "css-lsp"
Mason安装上述LSP DAP Linter Formatter 可能需要安装nodejs，python venv，golang环境。
ubuntu下nodejs安装参考 nvm: github.com/nvm-sh/nvm
golang: sudo apt install golang
python venv: sudo apt install python3 python3-venv
我的neovim可以做什么
我的neovim配置了c，python，nodejs，lua，bash，ts，sql的LSP，代码调试功能配置了python和nodejs。TODO下一步计划配置一下markdown，使其可以方便的编辑markdown文件。
我的neovim首页
neovim插件介绍
写在前面,约定习俗
<>表示必选项，例如<number>表示必须选择一个数字。[]表示可选项。ctrl-i表示组合键ctrli,sp表示组合键sp。<space>表示空格键<CR>表示enter键<Tab>表示Tab键。|表示或:h ZZ表示在vim normol模式下输入:h ZZ，即进入command模式然后输入h ZZ，h是help的缩写，即help命令。
目录
1 vim
1.1 vim基础
- 常用模式 vim有四种常用模式，分别是命令模式（command），编辑模式（insert），普通模式（normal），视图模式（view）。
- 模式切换
normal模式下通过
iIoOaA进入insert模式，insert模式通过Esc进入normal模式，normal模式通过VCtrl-vvctrl-q进入view模式，normal模式通过:进入命令模式。 - normal模式下常见操作
hjkl方向键上下左右k h l j0^光标跳到行首，$光标跳到行尾，gg光标跳到首行，G光标跳到末行，<number>gg跳转到number行。ctrl-i光标跳转至上一个位置，ctrl-o光标跳转至下一个位置，可通过:jumps命令查看具体的跳转表。f <a-z|A-Z>在当前行查找字母，并把光标跳转至该字母。/<word> |?<word>在全文种搜索指定文字。ZZ退出vim，与wq相似，但有一些差异，具体可参考:h ZZ。r替换单个字母，R连续替换，x删除光标位置处字符，X删除光标前面的一个字符，D当光标处到行尾的字符剪切至vim剪切板寄存器中，dd将当前行内容剪切至vim剪切板寄存器中，yy复制当前行内容到vim剪切板寄存器中，u回退至上一个状态，p将寄存器剪切板中的内容粘贴到光标位置，w光标跳转至下一个单词首字母，b光标跳转至上一个单词首字母，e光标跳转至当前单词尾字母。 - 一些有关vim motion操作
normal模式下motion操作可以更方便的编辑文字，下面列举一些例子：
dw将光标位置一直到该单词词尾剪切至vim剪切板寄存器中，该行为等同de,diw将光标位置单词剪切至vim剪切板寄存器中，d5l从光标位置向左一共5个字符剪切至vim剪切板寄存器中，di'将单引号内的内容剪切至vim剪切板寄存器中（i可以理解为in），类似的动作还有dGdfl(将光标位置到字符l间的内容剪切至vim剪切板寄存器中)cwciw（将当前光标位置单词剪切至vim剪切板寄存器中，并进入insert模式）ci'cfly6j(从光标位置开始向下复制6行内容至vim剪切板寄存器中)，6j(光标向下移动6行)更多参考:h motion。 - 有关光标跳转操作
ctrl-f光标向下跳转半页，ctrl-b光标向上跳转半页，ctrl-u光标向上跳转多行，ctrl-d光标向下跳转多行，(和)jump statement，{和}jump section，%跳转至对应闭合括号，ctrl-i光标跳转至上一个位置，ctrl-o光标跳转至下一个位置，可通过:jumps命令查看具体的跳转表。 - 与窗口相关操作
在vim中有着window tab buffer概念，buffer即缓存区，它存储着内容，比如当前编辑的文件，这涉及到Linux的一个概念流，在Linux中一切都是文件都是数据，你当前编辑的文件就是一个数据流，该数据流暂存在内存的一块地址中（buffer），最后发生一次io写入到硬盘中，在Linux中硬盘也是一个文件，可以通过
ls /dev/查看。buffer中的数据通过window展示，即在vim中打开一个窗口展示buffer中的数据，tab则为布局方式，组织排列窗口的布局。vim tab +----------------------+-------------------------+ | window | window | | 10101010101010101010 | | | 10010101010101010101 | | | 11100001010101010101 | | | 100000111~~~+-------------->buffer | | | | +-------------------------------------------------+ | window | | | | | | | | | | | | | | | | | +----------------------+-------------------------+:split沿着水平方向打开一个新的window，:vsplit沿着垂直方向打开一个新的window。:split <filename|path/to/file>打开一个新的文件:vsplit <filename|path/to/file> - normal模式下一些查找操作
#向上查找光标处单词，*向下查找光标处单词，/进入搜索，?进入搜索，N在搜索中向上跳转（上一个），n在搜索中向下跳转（下一个） - 其他一些normal模式下常用功能
:s/a/b将当前行找到的第一个a替换成b:s/a/b/g将一行中找到的a均换成b:%s/a/b/g将当前buffer中所有的找到的a替换成b:2,6s/a/b/g将2到6行的找到的a替换成b:set nohli取消搜索高亮，:set past设置进入粘贴模式，:set nopas退出粘贴模式。
2 我的neovim插件配置
2.1 配置文件目录结构说明
neovim在启动阶段会加载目录 $XDG_CONFIG_HOME/nvim 下的init.vim文件或init.lua文件，sysinit.vim在neovim启动阶段也会被加载，一般这个文件在目录 $VIM/sysinit.vim 下，更详细的说明参考:h config 。在neovim启动过程中，sysinit.vim会拉起我的neovim配置，sysinit.vim在目录 nvim-linux64/share/nvim/ 下，我的配置文件在吗目录 nvim-linux64/share/nvim/runtime/lua/ 下，下面是目录nvim-linux64/share/nvim/runtime/lua/ 的目录结构。
├── autocmd.lua
├── basic.lua
├── cmp
│ └── cmp.lua
├── colorscheme.lua
├── dap
│ └── nvim-dap
│ ├── config
│ │ ├── cpp.lua
│ │ └── nodejs.lua
│ └── setup.lua
├── init.lua
├── keybindingAlias.lua
├── keybindings.lua
├── lsp
│ ├── common-config.lua
│ ├── config
│ │ ├── bash.lua
│ │ ├── clangd.lua
│ │ ├── css.lua
│ │ ├── emmet-ls.lua
│ │ ├── eslint.lua
│ │ ├── html.lua
│ │ ├── json.lua
│ │ ├── lua.lua
│ │ ├── pyright.lua
│ │ ├── quick-lint-js.lua
│ │ ├── sqls.lua
│ │ └── tsserver.lua
│ ├── null-ls.lua
│ ├── setup.lua
│ └── ui.lua
├── plugin-config
│ ├── bufferline.lua
│ ├── comment.lua
│ ├── dashboard.lua
│ ├── fidget.lua
│ ├── indent-blankline.lua
│ ├── lualine.lua
│ ├── neoscrolL.lua
│ ├── nvim-autopairs.lua
│ ├── nvim-tree.lua
│ ├── nvim-treesitter.lua
│ ├── project.lua
│ ├── telescope.lua
│ ├── todo-comments.lua
│ ├── toggleterm.lua
│ ├── trouble.lua
│ └── zen-mode.lua
└── project.md
autocmd.lua为定义的一些vim autocmd比如在yank的时候高亮yank的内容，对指定文件保存时进行格式化处理，basic.lua为对neovim一些基本编辑属性的配置，比如定义2个空格等于一个tab，cmp目录里的配置文件为neovim写代码时自动补全配置。
**neovim 代码补全
colorscheme.lua定义了neovim的主题，配色，dap目录里的文件为neovim代码调试器相关配置。
neovim 调试代码
init.lua为初始化配置文件，即sysinit.vim拉起init.lua，init.lua拉起后续的配置文件，keybindings.lua定义neovim一些键位映射，lsp目录下的配置文件为neovim LSP相关配置，neovim LSP包括neovim的一些代码定义跳转，引用跳转，代码提示等。
neovim—LSP
plugin-config目录下的文件为各种插件的配置文件。
2.2 neovim键位映射说明
- 基本键位映射
定义neovim的Leader键为
;,leader键是什么，详细可以参考:h <Leader>可以通过修改keybindingAlias.lua文件定义自己的键位映射- normal模式下键位映射
取消了normal模式下
H，L，s，<F1>键的默认功能。<F1>进入command模式H,L光标向左移动35个字符，光标向右移动35个字符sp,P进入粘贴模式，退出粘贴模式，什么是粘贴模式参考:h 'paste'ctrl-uctrl-d向上向下移动多行光标ctrl-jctrl-k向上向下移动多行光标<Leader>q关闭当前window，<Leader>w保存当前window的buffer（将当前window的内容保存），<Leader>WQ关闭所有window，<Leader>Q退出neovim并且不保存buffersh,sv新建水平window，新建垂直window，s←，s→，s↑，s↓上下左右切换window，sw按顺时针方向依次切换windowsk，sj，s,，s.将window向上移动2点，将window向下移动2点，将window向左移动2点，将window向右移动2点，s=将window恢复默认大小 - insert模式下键位映射
取消了insert模式下
ctrl-f的默认功能<F1>进入command模式<Leader><Leader>进入normal模式 - visual模式下键位映射
ctrl-jctrl-k向上向下移动多行光标 - command模式下键位映射
ctrl-jctrl-k在命令补全窗口中向上移动向下移动 - terminal模式下键位映射
normal模式下
st水平方向上打开终端window normal模式下stv垂直方向上打开终端window<Esc>terminal模式回到normal模式s←，s→，s↑，s↓上下左右切换window
- normal模式下键位映射
取消了normal模式下
- 插件键位映射
插件键位一般是在normal模式下
- nvimTree
<space>f打开|关闭 nvimTree - LSP
rn重命名变量ca打开LSP行为gd跳转至定义，gh打开文档，gr跳转至引用，gj，gk跳转至上一个语法检查，跳转至下一个语法检查，gl打开语法检查列表，<Leader>f格式化代码。 - DAP
<F5>打开代码调试，<F6>执行下一步，<space>w关闭代码调试，<space>T去掉所有中断点，<space>t标记中断点，<space>h光标处表达式求值，visual模式下<Leader><Leader>光标处表达式求值。 - bufferline
<Leader>j<Leader>k切换到左边的buffer，切换到右边的buffer，<Leader>h<Leader>l向左交换buffer，向右交换buffer。 - telescope
normal模式和insert模式下
ctrl-f在当前buffer中查找内容。 - cmp
<Tab>，shift<Tab>，ctrl-k，ctrl-j自动补全框向上选择，向下选择，<CR>选中，ctrl-u，ctrl-d自动补全扩展窗口向下移动，向上移动，ctrl-<Space>打开自动补全，<Space>e关闭自动补全。 - toggerterm
<Leader>ta打开|关闭 终端，<Leader>tb打开|关闭 终端，<Leader>tc打开|关闭 终端。
- nvimTree
2.3 插件介绍
-
LSP LSP相关详细内容参考
:h lsp
LSP: github.com/neovim/nvim…
null-ls: github.com/jose-elias-…
mason: github.com/williamboma…
:LspInfo:LspLog:NullLsInfo:NullLsLog可以查看LSP client相关情况。 -
bufferline bufferline：github.com/akinsho/buf…
:BufferLinePick切换至选中的buffer:BufferLinePickClose关闭选中的buffer:BufferLineCloseLeft关闭当前buffer左边的所有buffer:BufferLineCloseRight关闭当前buffer右边的所有buffer -
lspsaga lspsage: github.com/glepnir/lsp…
:LSoutlineToggle打开outline lspsage outline在lspsaga窗口中，
o可以跳转至对应变量处 lspsage提供很多有关LSP的东西，:Lspsaga <rename|lsp_finder|code_action|hover_doc|...> -
nvim-tree nvimTree: github.com/kyazdani42/…
:NvimTreeToggle打开|关闭nvimTree窗口， 下面列举nvimTree窗口一些常用的快捷键指令`<CR>` edit open a file or folder; root will cd to the above directory `I` toggle_git_ignored toggle visibility of files/folders hidden via |git.ignore| option `H` toggle_dotfiles toggle visibility of dotfiles via |filters.dotfiles| option `U` toggle_custom toggle visibility of files/folders hidden via |filters.custom| option `R` refresh refresh the tree `a` create add a file; leaving a trailing `/` will add a directory `d` remove delete a file (will prompt for confirmation) `D` trash trash a file via |trash| option `r` rename rename a file `x` cut add/remove file/directory to cut clipboard `c` copy add/remove file/directory to copy clipboard `p` paste paste from clipboard; cut clipboard has precedence over copy; will prompt for confirmation `y` copy_name copy name to system clipboard `Y` copy_path copy relative path to system clipboard `gy` copy_absolute_path copy absolute path to system clipboard `s` system_open open a file with default system application or a folder with default file manager, using |system_open| option `f` live_filter live filter nodes dynamically based on regex matching. `F` clear_live_filter clear live filter `q` close close tree window `W` collapse_all collapse the whole tree `E` expand_all expand the whole tree, stopping after expanding |actions.expand_all.max_folder_discovery| folders; this might hang neovim for a while if running on a big folder `S` search_node prompt the user to enter a path and then expands the tree to match the path `.` run_file_command enter vim command mode with the file the cursor is on `<C-k>` toggle_file_info toggle a popup with file infos about the file under the cursor `g?` toggle_help toggle help `m` toggle_mark Toggle node in bookmarks `bmv` bulk_move Move all bookmarked nodes into specified location -
treesitter treesitter: github.com/nvim-treesi… 一些常用treesitter命令
:TSupdate更新treesitter语法树:TSBufEnable <highlight|moduleName...>启用treesitter相应模块:TSBufDisable <highlight|moduleName...>不启用treesitter相应模块:TSmoduleInfo查看treesitter模块信息 -
telescope telescope: github.com/nvim-telesc… telescope 窗口的默认键位映射
Mappings Action <C-n>/<Down>Next item <C-p>/<Up>Previous item j/kNext/previous (in normal mode) H/M/LSelect High/Middle/Low (in normal mode) gg/GSelect the first/last item (in normal mode) <CR>Confirm selection <C-x>Go to file selection as a split <C-v>Go to file selection as a vsplit <C-t>Go to a file in a new tab <C-u>Scroll up in preview window <C-d>Scroll down in preview window <C-/>Show mappings for picker actions (insert mode) ?Show mappings for picker actions (normal mode) <C-c>|qClose telescope <Esc>Close telescope (in normal mode) <Tab>Toggle selection and move to next selection <S-Tab>Toggle selection and move to prev selection <C-q>Send all items not filtered to quickfixlist (qflist) <M-q>Send all selected items to qflist 在insert模式下输入
ctrl-/和在normal模式下输入?都可以获取对应模式下默认的键位映射。:Telescope会列举所有的telescope模块，键入模块名以调用相应模块 :telescope常用telescope模块
:Telescope [find_file|live_grep|buffers|env|diagnostics|keymaps|highlights|man_pages|help_tags...] -
project project: github.com/ahmedkhalf/…
:Telescope project打开项目窗口 项目窗口下的默认键位映射Normal mode Insert mode Action f <c-f> find_project_files b <c-b> browse_project_files d <c-d> delete_project s <c-s> search_in_project_files r <c-r> recent_project_files w <c-w> change_working_directory 通过在项目目录创建名为project.md的文件，包含project.md的目录将成为项目根目录，可通过修改project插件配置文件的patterns来自定义自己的项目跟目录匹配模式。 project插件配置文件
-
comment todo commentTodo: github.com/folke/todo-… 类似vscode的todotree 触发todo的关键词
常用的todo命令 :TodoQuickFix :TodoLocList :TodoTrouble :TodoTelescope :TodoTrouble cwd=~/projects/foobar -
trouble trouble: github.com/folke/troub… Trouble comes with the following commands:
:Trouble [mode]: open the list:TroubleClose [mode]: close the list:TroubleToggle [mode]: toggle the list:TroubleRefresh: manually refresh the active listmode = "workspace_diagnostics"|"workspace_diagnostics"|"document_diagnostics", "quickfix"|"lsp_references"|"loclist"trouble窗口默认键位映射
close = "q", -- close the list cancel = "<esc>", -- cancel the preview and get back to your last window / buffer / cursor refresh = "r", -- manually refresh jump = {"<cr>", "<tab>"}, -- jump to the diagnostic or open / close folds open_split = { "<c-x>" }, -- open buffer in new split open_vsplit = { "<c-v>" }, -- open buffer in new vsplit open_tab = { "<c-t>" }, -- open buffer in new tab jump_close = {"o"}, -- jump to the diagnostic and close the list toggle_mode = "m", -- toggle between "workspace" and "document" diagnostics mode toggle_preview = "P", -- toggle auto_preview hover = "K", -- opens a small popup with the full multiline message preview = "p", -- preview the diagnostic location close_folds = {"zM", "zm"}, -- close all folds open_folds = {"zR", "zr"}, -- open all folds toggle_fold = {"zA", "za"}, -- toggle fold of current file previous = "k", -- preview item next = "j" -- next itemo经常用到 -
toggleterm toggleterm: github.com/akinsho/tog…
常用的toggleterm命令 :<count>TermExec :<count>ToggleTerm :ToggleTermToggleAll :ToggleTermSetName work :ToggleTermSendCurrentLine <T_ID> :ToggleTermSendVisualLines <T_ID> :ToggleTermSendVisualSelection <T_ID> -
cmp cmp: github.com/hrsh7th/nvi…
:CmpStatus查看cmp加载状态
