vime

vime是一个结构化的(neo)vim配置，具有如下优势：

1. 结构简单明了。该项目中每个插件都单独对应一个配置文件，插件列表config/layers.vim可以对插件进行组合。
2. 增删配置容易。大家可以根据自己的需求，快速的增减插件。
3. 低耦合性。大家可以将某一个插件的配置文件单独拿出来放到自己的(neo)vim配置中直接使用。

一些截图和GIF，欢迎各位提供：

1. 点击查看截图
2. 点击查看GIF

目录

• 整体结构
• 安装
  • 依赖
  • 安装
• 插件结构
• 插件以及快捷键
  • 补全
    • 可选插件
    • 快捷键
  • 文件管理
    • 可选插件
    • 快捷键
  • 快速检索
    • 可选插件
    • 快捷键
  • 基础快捷键
    • 快捷键
  • Git
    • 可选插件
    • 快捷键
  • 多光标
    • 可选插件
    • 快捷键
  • 快速跳转
    • 可选插件
    • 快捷键
  • 注释与文档
    • 可选插件
    • 快捷键
  • 终端
    • 可选插件
    • 快捷键
  • 代码折叠
    • 可选插件
    • 快捷键
  • 笔记
    • 可选插件
    • 快捷键
  • Latex
    • 可选插件
    • 快捷键
    • 其他
  • tmux
    • 可选插件
  • 书签
    • 可选插件
    • 快捷键
  • session
  • Surround
    • 可选插件
    • 快捷键
  • 数据库
  • 绘图
  • Debug
  • Run
  • 翻译
  • 其他
• TODO

整体结构

├── init.vim
├── config.vim
├── vimrc -> ./init.vim
├── autoload/
│   ├── common/
│   │   └── functions.vim
├── config/
│   ├── plugins/
│   ├── layers/
│   ├── other/
│   ├── theme/
│   │   ├── theme.vim
│   │   ├── statusline.vim
│   │   └── tabline.vim
│   ├── layer.vim
│   ├── base.vim
│   ├── keymap.vim
│   └── plugin_list.vim
├── plugin/
├── ftplugin/
└── scripts/

下面简单介绍下整个结构：

1. init.vim

   neovim初始化的时候要加载的文件，vimrc链接到init.vim文件上，是vim初始化时要加载的文件。

2. config.vim

   该文件主要是一些用户自定义的全局配置文件。

3. autoload/

   在(neo)vim中，autoload/目录用于自动加载。我将一些通用的函数放到autoload/common/functions.vim文件中，如果大家想单独复制一个插件的配置到自己的(neo)vim配置中，那么请不要忘记将这些通用函数复制过去，因为很多插件配置都用到了这里的函数。

4. config/

   该目录是主要的配置文件目录。

   • config/plugins/

     此目录下面就是所有插件的配置，一个插件对应一个文件，文件的名称与插件的名称相同，比如插件Plug "user_name/plugin_name.vim"对应的配置文件名称为plugin_name.vim.vim。

     对于插件的配置文件，有一个小小的规范，某个插件的按键映射最好写到对应配置文件的最后。

   • config/layers/

     该目录主要存储一些插件组合配置文件。

   • config/other/

     此目录主要存放一些插件需要用到的文件，比如插件coc用到的coc-settings.json，ycm用到的ycm_extra_conf.py等文件。

   • config/theme/

     主题配置，(neo)vim主题相关的配置基本上都放到该文件夹下。

   • config/layer.vim

     此文件主要用于从config/layers/目录下选择合适的插件组合。

   • base.vim

     基础配置。

   • keymap.vim

     此文件是一些快捷键配置，通常这些快捷键与插件无关，与插件相关的快捷键一般都放到插件的配置文件中。

5. plugin/

   在(neo)vim中，plugin/目录下的配置会在(neo)vim启动的时候自动加载，因此，我主要用于存放一些自定义的配置在这里。

6. ftplugin

   该目录是(neo)vim的目录，该目录下的文件都是以文件类型.vim格式进行命名，比如c.vim，cpp.vim，表示遇到c，cpp文件的时候要执行对应文件的代码。

7. scripts/

   该目录主要存储一些常用的脚本文件，如preview.sh等。

安装

依赖

下面是一些必须或者可选的一些依赖：

1. neovim

   此处的neovim是指python包中neovim，通过pip install neovim进行安装，必须安装。

2. ripgrep

   该软件主要用于fzf、clap、leaderf等插件，主要用于内容检索，建议安装。

3. nodejs、npm

   该软件主要用于coc补全插件，如果使用coc则必须安装。

4. neovim-remote、xdotool、inkscape、rofi、pip install inkscape-figures

   这些软件主要用于vimtex插件，写latex的用户可能会用到。

   其中xdotool主要用于在预览软件中按下ctrl+鼠标左键定位到代码位置，inkscape、rofi、inkscape-figures三个软件主要用于使用inkscape绘图然后自动插入到latex中，主要参考inkscape-figures。

5. zathura

   该软件是pdf阅读器，同样主要用于vimtex插件，主要是用来进行预览，可选。

安装

git clone https://github.com/fgheng/vime ~/.config/nvim

然后打开(neo)vim，执行:PlugInstall等待插件安装完毕即可！

注意：

1. 因为一开始没有安装主题，因此在第一次启动的时候可能会提示找不到主题，属于正常现象，执行完:PlugInstall之后再打开(neo)vim即可。
2. 因为列表中有关于tmux的插件，而这些插件只有在tmux中打开(neo)vim的时候才会加入到插件列表中，因此，第一次运行vime的时候如果没有启动tmux，那么这些关于tmux的插件将不会安装，要安装这些插件需要在tmux中打开(neo)vim后重新执行PlugInstall命令才可以。
3. 第一次安装可能要等待很长时间，可以稍微耐心等待一下。

插件结构

此部分主要介绍vime的插件结构。

所有用到的插件都在config/plugin_list.vim中，该文件中的内容如下：

Plug 'neoclide/coc.nvim', { 'branch': 'release' }
Plug 'junegunn/fzf.vim'
Plug 'junegunn/fzf', { 'do': {-> fzf#install()} }
Plug 'antoinemadec/coc-fzf',  {'branch': 'release'}

需要什么插件，就在这里添加。

当需要为自己使用的插件自定义配置的时候，请按照如下的例子进行：

以Plug 'juegunn/fzf.vim'为例，首先我们要在config/plugin_list.vim中添加一行Plug 'juegunn/fzf.vim'，表示我们要安装该插件，接下来要为该插件自定义配置，那么需要在config/plugins/目录下建立与插件名同名的文件fzf.vim.vim，注意后缀.vim，最后在该文件中编写关于该插件的配置即可。

如果不想使用该插件了，那么只需要在config/plugin_list.vim中注释掉该插件，config/plugins/fzf.vim.vim文件则不必删除，(neo)vim在启动的时候将不再加载该配置文件。

插件以及快捷键

下面介绍的是我常用的插件及其快捷键，当然，我会先按照类型进行介绍，同一个类型下可能会有很多插件（一般选择自己喜欢的那个），而我的配置中，同一个类型的插件的快捷键我都尽可能配置的一样，这样，在更换为另一个插件的时候，更改的只有(neo)vim的表现形式而不会改变我们的使用习惯。

补全

可选插件

对于补全，有很多插件，而我常用的是两个，一个是coc，另一个是YouCompleteMe，两者都属于补全类的插件，因此，两者的快捷键应该一致。

1. 使用coc

   Plug 'neoclide/coc.nvim', { 'branch': 'release' }

2. 使用YouCompleteMe

   Plug 'ycm-core/YouCompleteMe', {'do': 'python3 install.py --all'}

快捷键

下面是coc插件的额外快捷键

文件管理

可选插件

weirongxu/coc-explorer、Shougo/defx.nvim、nerdtree、ms-jpq/chadtree

1. 使用coc-explorer

   在config/plugin_list.vim中

   let g:coc_global_extensions = ['coc-explorer']

2. 使用defx

   if has('nvim')
     Plug 'Shougo/defx.nvim', { 'do': ':UpdateRemotePlugins' }
     Plug 'kristijanhusak/defx-icons'
     Plug 'kristijanhusak/defx-git'
   else
     Plug 'Shougo/defx.nvim'
     Plug 'roxma/nvim-yarp'
     Plug 'roxma/vim-hug-neovim-rpc'
     Plug 'kristijanhusak/defx-icons'
     Plug 'kristijanhusak/defx-git'
   endif

3. 使用nerdtree

   Plug 'preservim/nerdtree'
   Plug 'Xuyuanp/nerdtree-git-plugin'

4. 使用chadtree

   Plug 'ms-jpq/chadtree', {'branch': 'chad', 'do': ':UpdateRemotePlugins'}

快捷键

快速检索

可选插件

junegunn/fzf.vim、Yggdroot/LeaderF、liuchengxu/vim-clap、coc-lists，其中如果存在前面的三个插件之一，那么coc-lists优先级最低。

1. 使用fzf

   Plug 'junegunn/fzf.vim'
   Plug 'junegunn/fzf', { 'do': {-> fzf#install()} }
   Plug 'antoinemadec/coc-fzf',  {'branch': 'release'}

2. 使用LeaderF

   Plug 'Yggdroot/LeaderF'

3. 使用vim-clap

   Plug 'liuchengxu/vim-clap', { 'do': ':Clap install-binary!' }
   Plug 'vn-ki/coc-clap'

4. 使用coc-lists

   let g:coc_global_extensions = ['coc-lists']

快捷键

基础快捷键

这些快捷键主要是操作窗口与buf的。

快捷键

Git

可选插件

git插件可以选择使用airblade/vim-gitgutter、tpope/vim-fugitive、neoclide/coc-git

1. 使用vim-gitgutter

   Plug 'airblade/vim-gitgutter'

2. 使用vim-fugitive

   Plug 'vim-fugitive', {'on': ['Gwrite', 'Gcommit', 'Gread', 'Gdiff', 'Gblame']}

3. 使用coc-git

   let g:coc_global_extensions = ['coc-git']

快捷键

多光标

可选插件

多光标使用的是插件vim-visual-multi以及coc自带的多光标，如果plug.vim中没有vim-visual-multi那么会使用coc自带的插件，coc行为与前者类似，但是功能不如前者多。

1. 使用vim-visual-multi

   Plug 'mg979/vim-visual-multi'

2. 使用coc自带多光标

   Plug 'neoclide/coc.nvim', { 'branch': 'release' }

快捷键

快速跳转

可选插件

快速跳转使用的是vim-easymotion或者clever-f，easymotion中只使用了两个功能，一个是使用char进行跳转，另一个是跳转到行。

1. 选择vim-easymotion

   Plug 'easymotion/vim-easymotion'

2. 选择clever-f

   Plug 'rhysd/clever-f.vim'

快捷键

注释与文档

可选插件

文档生成器使用kkoomen/vim-doge，注释插件使用nerdcomment或者tyru/caw.vim，caw功能没有nerdcomment多，但是简洁。

1. 使用vim-doge

   Plug 'kkoomen/vim-doge'

2. 使用nerdcomment

   Plug 'preservim/nerdcommenter'

3. 使用caw.vim

   Plug 'tyru/caw.vim'

快捷键

caw快捷键

下面的是nerdcomment的快捷键

终端

可选插件

终端使用的是voldikss/vim-floaterm

1. 使用vim-floaterm

   Plug 'voldikss/vim-floaterm'

快捷键

代码折叠

可选插件

代码折叠使用的插件是pseewald/vim-anyfold

Plug 'pseewald/vim-anyfold'

快捷键

格式化

可选插件

格式化主要是使用coc中的格式化功能，当然你也可以自己增加格式化插件比如sbdchd/neoformat等，另外格式化部分还有junegunn/vim-easy-align这个插件，该插件主要用于对齐。

Plug 'junegunn/vim-easy-align'

快捷键

笔记

可选插件

笔记使用的是插件vimwiki/vimwiki，可以记笔记可以写日记，支持markdown。

可以使用junegunn/fzf.vim、Yggdroot/LeaderF进行笔记文件和笔记内容的搜索，这个已经配置好了可以直接使用。

快捷键

Latex

可选插件

latex可以选择使用lervag/vimtex

Plug 'lervag/vimtex'

快捷键

其他

关于neovim+vimtex+zathura的反向搜索，也就是在从zathura定位到vim中的代码位置，首先需要安装一些依赖，neovim-remote、xdotool，然后需要编辑zathura的配置文件~/.config/zathura/zathurarc，加入如下内容：

set synctex true
set synctex-editor-command "gvim --remote-silent +%l %f"

这样在zathura中就可以使用ctrl+鼠标左键直接定位到对应的代码位置了。

tmux

可选插件

与tmux相关的插件有如下几个：

1. 窗口导航 vim-tmux-navigator

   Plug 'christoomey/vim-tmux-navigator'

2. vim-tmux-focus-events

   " 需要在tmux的配置文件~/.tmux.conf中添加 set -g focus-events on
   Plug 'tmux-plugins/vim-tmux-focus-events'

3. tmux与vim之间复制粘贴

   Plug 'roxma/vim-tmux-clipboard'

4. 提示tmux终端中的内容

   Plug 'wellle/tmux-complete.vim'

书签

可选插件

标记使用vim-bookmarks或者coc-bookmark，因为coc-explorer支持显示coc-bookmark中的书签，所以我使用coc-bookmark，不过可以在config/plug.vim中加入vim-bookmarks两者快捷键一致。

1. 使用coc-bookmark

   let g:coc_global_extensions = ['coc-bookmark']

2. 使用vim-bookmarks

   Plug 'MattesGroeger/vim-bookmarks'

快捷键

session

默认使用了vim-startify这个插件作为开始界面，该插件的可以自定义起始界面，配置在./config/plugins/vim-startify.vim下，可以自定义配置。session使用轮换方式，第一次存储一个session0，第二次还是存储session0，不过上一次的session0变为了session1，第三次存储session0，前面的session0变为session1，session1变为session2。

Surround

可选插件

Surround是使用快捷键来给指定的字符串添加包围，比如引号等。使用的插件是tpope/vim-surround以及vim-sanwich

1. 使用vim-surround

Plug 'tpope/vim-surround'

2. 使用vim-sandwich

Plug 'machakann/vim-sandwich'

快捷键

下面是vim-sanwich的快捷键，不过我增加了与vim-surround一致的快捷键配置，可以直接使用vim-surround的快捷键。

数据库

数据库可以选择使用tpope/vim-dadbod

绘图

绘图使用vim-scripts/DrawIt，命令行输入DrawIt进入绘图模式。

Debug

debug可以选择使用puremourning/vimspector，暂时没有需求，所以还没有配置。

Run

代码run使用韦大的插件，但是我现在还没有需求，做一暂时没有配置。

翻译

翻译之前使用voldikss/coc-translator，接下来又换成了voldikss/vim-translator然后感觉都稍微有些许问题，最后选择了iamcco/dict.vim，但是该插件不支持悬浮窗口，我需要对其更改下支持悬浮窗口。

其他

TODO

• [✓] 更新ycm的配置，使其与coc行为一致
• [✓] 更新nerdtree的配置（已更新部分），使其与defx, coc-explorer行为一致
• [✓] 录制GIF放到issue中
• [✓] 更新tagbar的配置
• [✓] 更新clap，leaderf配置，使其与fzf行为一致
• [✓] 重新规划一下目录结构
• [✓] 重新编写readme，每个部分都应该加上所使用的插件，例：Plug 'user/plug_name'
• [✓] 将一些通用函数提取出来