Merge branch 'dev'

Author: jayli

README-cn.md

@@ -26,7 +26,38 @@ Vim-easycomplete 是一个快速极简的自动补全插件，兼容 vim 和 neo
 
 Vim 8.2 及以上版本，Neovim 0.7.0 及以上，支持 MacOS/Linux/FreeBSD。
 
-lua 配置（基于 Packer.nvim ）：
+lua 配置（基于 Packer.nvim ），通过 `require("easycomplete").config(opt)` 配置:
+
+```lua
+use { 'jayli/vim-easycomplete', requires = {'L3MON4D3/LuaSnip'}}
+-- snippet 可选方案还有 'SirVer/ultisnips'
+-- `tabnine_enable = 0` 等同于 `vim.g.easycomplete_tabnine_enable = 0`
+require("easycomplete").config({
+    cmdline = 1,
+    pum_noselect = 0,
+    tabnine_enable = 0,
+    nerd_font = 1,
+    enable = 1,
+    winborder = 1,
+    ghost_text = 1,
+    menu_abbr = 0,
+    pum_format = {"abbr", "kind", "menu"},
+    setup = function()
+      vim.keymap.set('n', 'gr', ':EasyCompleteReference<CR>')
+      vim.keymap.set('n', 'gd', ':EasyCompleteGotoDefinition<CR>')
+      vim.keymap.set('n', 'rn', ':EasyCompleteRename<CR>')
+      -- Plugin has already bind shift-k to `:EasyCompleteHover`
+      -- vim.keymap.set('n', 'gh', ':EasyCompleteHover<CR>')
+      vim.keymap.set('n', 'gb', ':BackToOriginalBuffer<CR>')
+    end
+  })
+```
+
+执行 `:PackerInstall`
+
+[完整配置](https://github.com/jayli/vim-easycomplete/wiki/2.-%E5%AE%89%E8%A3%85%E5%92%8C%E9%85%8D%E7%BD%AE#%E5%9F%BA%E4%BA%8E-lua-%E7%9A%84%E5%AE%8C%E6%95%B4%E9%85%8D%E7%BD%AE)
+
+还可以通过全局变量的方式来配置，这段lua配置和上面这段代码作用完全一样：
 
 ```lua
 -- lua
@@ -68,7 +99,7 @@ vim.g.easycomplete_cmdline = 1
 ```
 执行 `:PackerInstall`
 
-Vimscript 配置（基于vim-plug）:
+在非 lua 中，可以使用 viml 配置，Vimscript 配置（基于vim-plug）:
 
 ```vim
 " vim
@@ -113,24 +144,6 @@ let g:easycomplete_cmdline = 1
 
 [一个例子](custom-config.md).
 
-可以使用 Lua setup 风格初始化配置：`require("easycomplete").setup()`:
-
-```lua
--- lua style setup
--- `tabnine_enable = 0` alias `vim.g.easycomplete_tabnine_enable = 0`
-require("easycomplete").setup({
-    cmdline = 1,
-    pum_noselect = 0,
-    tabnine_enable = 0,
-    nerd_font = 1,
-    enable = 1,
-    winborder = 1,
-    ghost_text = 1,
-    menu_abbr = 0,
-    pum_format = {"abbr", "kind", "menu"}
-  })
-```
-
 ## 使用
 
 输入过程中自动显示匹配菜单，并通过 `Tab` 来选择下一个匹配项，`Shift-Tab` 选择上一个匹配项。`Ctrl-]` 跳转到定义处，`Ctrl-t`跳回（和 tags 跳转快捷键一致）。
@@ -178,7 +191,7 @@ require("easycomplete").setup({
 | `g:easycomplete_tabnine_suggestion`  | 0             | Tabnine 行内补全(for nvim only)                             |
 | `g:easycomplete_lsp_checking`        | 1             | 打开文件时是否立即检查 lsp 是否安装                         |
 | `g:easycomplete_tabnine_enable`      | 1             | 启用 Tabnine：启用后补全菜单里会出现 Tabnine 补全项         |
-| `g:easycomplete_directory_enable`    | 1             | 目录匹配                                                    |
+| `g:easycomplete_path_enable`         | 1             | 目录匹配                                                    |
 | `g:easycomplete_tabnine_config`      | `{}`          | [TabNine 配置](#ai-coding-via-tabnine-support)              |
 | `g:easycomplete_filetypes`           | `{}`          | [自定义文件类型配置](#language-support)                     |
 | `g:easycomplete_enable`              | 1             | 是否启用插件                                                |
@@ -221,7 +234,7 @@ LSP 服务会安装在本地路径： `~/.config/vim-easycomplete/servers`。
 
 | 名称        | 语言      | LSP 服务                 | LSP 是否需要安装   | 依赖         | URL |
 |-------------|-----------|:------------------------:|:------------------:|:------------:|:--------:|
-| directory   | directory | No Need                  | 内置               | 无           |          |
+| path        | path      | No Need                  | 内置               | 无           |          |
 | buf         | buf & dict| No Need                  | 内置               | 无           |          |
 | snips       | Snippets  | ultisnips/LuaSnip        | 内置               | python3/lua  |          |
 | ts          | js/ts     | tsserver                 | Yes                | node/npm     |          |

README.md

@@ -15,7 +15,7 @@ Vim-easycomplete is a fast and minimalism style completion plugin for both vim a
 It contains these features:
 
 - Full [lsp]([language-server-protocol](https://github.com/microsoft/language-server-protocol)) support. Easy to install LSP Server with one command
-- Keywords/Directory support
+- Keywords/path support
 - Implemented based on pure vimscript
 - Snippet support.
 - Fast performance
@@ -26,7 +26,38 @@ It contains these features:
 
 Requires Vim 8.2 or higher version on MacOS/Linux/FreeBSD. Neovim 0.7.0 or higher.
 
-Lua config with Packer.nvim:
+Lua config with Packer.nvim via `require("easycomplete").config(opt)`:
+
+```lua
+use { 'jayli/vim-easycomplete', requires = {'L3MON4D3/LuaSnip'}}
+-- For snippet support, 'SirVer/ultisnips' is an alternative option
+-- `tabnine_enable = 0` alias `vim.g.easycomplete_tabnine_enable = 0`
+require("easycomplete").config({
+    cmdline = 1,
+    pum_noselect = 0,
+    tabnine_enable = 0,
+    nerd_font = 1,
+    enable = 1,
+    winborder = 1,
+    ghost_text = 1,
+    menu_abbr = 0,
+    pum_format = {"abbr", "kind", "menu"},
+    setup = function()
+      vim.keymap.set('n', 'gr', ':EasyCompleteReference<CR>')
+      vim.keymap.set('n', 'gd', ':EasyCompleteGotoDefinition<CR>')
+      vim.keymap.set('n', 'rn', ':EasyCompleteRename<CR>')
+      -- Plugin has already bind shift-k to `:EasyCompleteHover`
+      -- vim.keymap.set('n', 'gh', ':EasyCompleteHover<CR>')
+      vim.keymap.set('n', 'gb', ':BackToOriginalBuffer<CR>')
+    end
+  })
+```
+
+Run `:PackerInstall`
+
+[Full configuration](https://github.com/jayli/vim-easycomplete/wiki/2.-%E5%AE%89%E8%A3%85%E5%92%8C%E9%85%8D%E7%BD%AE#%E5%9F%BA%E4%BA%8E-lua-%E7%9A%84%E5%AE%8C%E6%95%B4%E9%85%8D%E7%BD%AE)
+
+You can configure it through global variables like this which is exactly the same as the above configuration:
 
 ```lua
 -- lua
@@ -65,6 +96,7 @@ vim.g.easycomplete_cmdline = 1
 -- vim.g.easycomplete_use_default_cr = 0
 -- vim.keymap.set('i', '<C-L>', '<Plug>EasycompleteCR')
 ```
+
 Run `:PackerInstall`
 
 Vimscript config with vim-plug:
@@ -110,24 +142,6 @@ Run `:PlugInstall`.
 
 [Full configuration example](custom-config.md).
 
-Lua style setup with `require("easycomplete").setup()`:
-
-```lua
--- lua style setup
--- `tabnine_enable = 0` alias `vim.g.easycomplete_tabnine_enable = 0`
-require("easycomplete").setup({
-    cmdline = 1,
-    pum_noselect = 0,
-    tabnine_enable = 0,
-    nerd_font = 1,
-    enable = 1,
-    winborder = 1,
-    ghost_text = 1,
-    menu_abbr = 0,
-    pum_format = {"abbr", "kind", "menu"}
-  })
-```
-
 ## Useage
 
 - `Tab`/`S-Tab`: select next/previous matched items.
@@ -177,7 +191,7 @@ Global configurations:
 | `g:easycomplete_tabnine_suggestion`  | 0             | Tabnine inline suggestion(for nvim only)                      |
 | `g:easycomplete_lsp_checking`        | 1             | Check whether the lsp is installed while opening a file       |
 | `g:easycomplete_tabnine_enable`      | 1             | Enable Tabnine                                                |
-| `g:easycomplete_directory_enable`    | 1             | Directory complete                                            |
+| `g:easycomplete_path_enable`         | 1             | Path complete                                                 |
 | `g:easycomplete_tabnine_config`      | `{}`          | [TabNine Configuration](#ai-coding-via-tabnine-support)       |
 | `g:easycomplete_filetypes`           | `{}`          | [Custom filetyps configuration](#language-support)            |
 | `g:easycomplete_enable`              | 1             | Enable this plugin                                            |
@@ -222,7 +236,7 @@ All supported languages:
 
 | Plugin Name | Languages | Language Server          | Installer          | Requirements | URL |
 |-------------|-----------|:------------------------:|:------------------:|:------------:|:---:|
-| directory   | directory | No Need                  | Integrated         | None         |     |
+| path        | path      | No Need                  | Integrated         | None         |     |
 | buf         | buf & dict| No Need                  | Integrated         | None         |     |
 | snips       | Snippets  | ultisnips/LuaSnip        | Integrated         | python3/lua  |     |
 | ts          | js/ts     | tsserver                 | Yes                | node/npm     |     |

autoload/easycomplete.vim

@@ -86,7 +86,7 @@ let g:easycomplete_ghost_text_str = ""
 let b:easycomplete_typing_timer = 0
 let s:easycomplete_toolkit = g:env_is_nvim ? v:lua.require("easycomplete") : v:null
 let s:util_toolkit = g:env_is_nvim ? v:lua.require("easycomplete.util") : v:null
-let b:is_directory_complete = 0
+let b:is_path_complete = 0
 let b:fast_bs_timer = 0
 
 function! easycomplete#Enable()
@@ -1178,23 +1178,23 @@ function! s:CompletorCallingAtFirstComplete(ctx)
 
   " TODO 原本在设计 CompletorCalling 机制时，每个CallCompeltorByName返回true时继
   " 续执行，返回false中断执行，目的是为了实现那些排他性的CompleteCalling，比如
-  " directory. 这样就只能串行执行每个插件的 completor()
+  " path. 这样就只能串行执行每个插件的 completor()
   "
   " 但在 runtime 中不能很好的执行，因为每个 complete_plugin 的
   " completor 的调用顺序不确定，如果让所有 completor 全都异步，是可以实现排他性
   " complete的，但即便每个调用都是异步，对于 lsp request 已经发出的情况，由于不
   " 能abort掉 lsp 进程，因此还是会有返回值冲刷进 g:easycomplete_menuitems，进而
   " 污染匹配结果。
   "
-  " 这里默认只有 directory 唯一一个需要排他的情况，把 directory 提前。
+  " 这里默认只有 path 唯一一个需要排他的情况，把 path 提前。
   " 设计上需要重新考虑下，是否是只能有一个排他completor，还是存在多个共存的
   " 情况，还不清楚，先这样hack掉
   try
-    let source_directory = ['directory']
+    let source_path = ['path']
     let source_names = []
 
     for name in keys(g:easycomplete_source)
-      if name == "directory"
+      if name == "path"
         continue
       endif
       if name == "snips" || name == "buf"
@@ -1207,8 +1207,8 @@ function! s:CompletorCallingAtFirstComplete(ctx)
         call add(source_names, name)
       endif
     endfor
-    " 最后把 source_directory 放在最前面
-    let source_names = source_directory + source_names
+    " 最后把 source_path 放在最前面
+    let source_names = source_path + source_names
 
     let l:count = 0
     while l:count < len(source_names)
@@ -1866,12 +1866,12 @@ function! easycomplete#CompleteAdd(menu_list, plugin_name)
   let filtered_menu = g_easycomplete_menuitems
   let start_pos = col('.') - strwidth(typing_word)
 
-  if a:plugin_name == "directory"
+  if a:plugin_name == "path"
     " let typed = strpart(getline('.'), 0, col('.') - 1)
     " let start_pos = strwidth(typed) - strwidth(fnamemodify(typed, ":t"))
-    let b:is_directory_complete = 1
+    let b:is_path_complete = 1
   else
-    let b:is_directory_complete = 0
+    let b:is_path_complete = 0
   endif
 
   try
@@ -1962,7 +1962,7 @@ function! s:FirstCompleteRendering(start_pos, menuitems)
   endif
   let l:ctx = easycomplete#context()
   let typing_word = l:ctx["typing"]
-  if b:is_directory_complete
+  if b:is_path_complete
     let typing_word = easycomplete#util#GetFileName(l:ctx["typed"])
   endif
   let should_stop_render = 0
@@ -1982,7 +1982,7 @@ function! s:FirstCompleteRendering(start_pos, menuitems)
     endif
 
     if !should_stop_render && len(source_result) > 0
-      if b:is_directory_complete
+      if b:is_path_complete
         let filtered_menu = deepcopy(source_result)
       else
         " distinct 只去重 bufkeyword 和 dict

…oload/easycomplete/sources/directory.vim autoload/easycomplete/sources/path.vimautoload/easycomplete/sources/directory.vim renamed to autoload/easycomplete/sources/path.vim autoload/easycomplete/sources/directory.vim renamed to autoload/easycomplete/sources/path.vim

@@ -1,12 +1,12 @@
 
-function! easycomplete#sources#directory#completor(opt, ctx)
+function! easycomplete#sources#path#completor(opt, ctx)
   let l:typing_path = s:TypingAPath(a:ctx)
   if !l:typing_path.is_path
     call easycomplete#complete(a:opt['name'], a:ctx, a:ctx['startcol'], [])
     return v:true
   endif
   call easycomplete#util#timer_start(
-        \ "easycomplete#sources#directory#CompleteHandler",
+        \ "easycomplete#sources#path#CompleteHandler",
         \ [a:ctx['typing'], a:opt['name'], a:ctx, a:ctx['startcol'], l:typing_path],
         \ 10 )
   " 展开目录时，中断其他complete逻辑
@@ -15,20 +15,20 @@ function! easycomplete#sources#directory#completor(opt, ctx)
   return v:false
 endfunction
 
-function! easycomplete#sources#directory#CompleteHandler(...)
+function! easycomplete#sources#path#CompleteHandler(...)
   return call(function("s:CompleteHandler"), a:000)
 endfunction
 
 function! s:CompleteHandler(typing, name, ctx, startcol, typing_path)
-  if g:easycomplete_directory_enable == 0
+  if g:easycomplete_path_enable == 0
     call easycomplete#complete(a:name, a:ctx, a:startcol, [])
     return
   endif
   let spath_start = a:typing_path.short_path_start
   try
     let result = s:GetDirAndFiles(a:typing_path, a:typing_path.fname)
   catch
-    call s:errlog('[Directory]', v:exception)
+    call s:errlog('[Path]', v:exception)
     return
   endtry
   if len(result) == 0
@@ -39,7 +39,7 @@ function! s:CompleteHandler(typing, name, ctx, startcol, typing_path)
   call easycomplete#complete(a:name, a:ctx, a:startcol, result)
 endfunction
 
-function! easycomplete#sources#directory#pum()
+function! easycomplete#sources#path#pum()
   if g:env_is_vim && (!pumvisible() || !exists('g:easycomplete_stunt_menuitems'))
     return v:valse
   endif
@@ -49,7 +49,7 @@ function! easycomplete#sources#directory#pum()
   if empty(g:easycomplete_stunt_menuitems)
     return v:false
   endif
-  if get(g:easycomplete_stunt_menuitems[-1], 'plugin_name', "") == "directory"
+  if get(g:easycomplete_stunt_menuitems[-1], 'plugin_name', "") == "path"
     return v:true
   endif
   return v:false
@@ -92,7 +92,7 @@ function! s:GetDirAndFiles(typing_path, base)
   return s:GetWrappedFileAndDirsList(result_list, s:GetPathName(path), l:base)
 endfunction
 
-function! easycomplete#sources#directory#GetDirAndFiles(typing_path, base)
+function! easycomplete#sources#path#GetDirAndFiles(typing_path, base)
   return s:GetDirAndFiles(a:typing_path, a:base)
 endfunction
 
@@ -137,7 +137,7 @@ function! s:GetWrappedFileAndDirsList(rlist, fpath, base)
   return result_with_kind
 endfunction
 
-function! easycomplete#sources#directory#TypingAPath(...)
+function! easycomplete#sources#path#TypingAPath(...)
   return call(function('s:TypingAPath'), a:000)
 endfunction
 

autoload/easycomplete/sources/tn.vim

@@ -477,7 +477,7 @@ function! s:CompleteHandler(res)
 endfunction
 
 function! s:UpdateRendering(result)
-  if easycomplete#sources#directory#pum()
+  if easycomplete#sources#path#pum()
     return
   endif
   call easycomplete#StoreCompleteSourceItems(s:tn_name, a:result)

custom-config.md

@@ -85,8 +85,8 @@ vim.g.easycomplete_tabnine_enable = 1
 -- Enable Tabnine suggestion, default is off
 vim.g.easycomplete_tabnine_suggestion = 0
 
--- Enable directory complete. Default is on
-vim.g.easycomplete_directory_enable = 1
+-- Enable path complete. Default is on
+vim.g.easycomplete_path_enable = 1
 
 -- Show abbr(shortname) at `menu` position in pum
 vim.g.easycomplete_menu_abbr = 1