将 Flux LSP 与 Vim 结合使用

要求

• Vim 8+
• npm

安装 Flux 插件

安装和管理 Vim 插件的方法有很多。我们推荐以下两种方法中的任何一种

• 使用 vim-lsp 安装
• 使用 vim-coc 安装

两种方法都需要您将以下内容添加到您的 .vimrc 中，以便 Vim 可以识别 .flux 文件类型

" Flux file type
au BufRead,BufNewFile *.flux		set filetype=flux

使用 vim-lsp 安装

1. 使用 npm 安装 flux-lsp-cli

   npm i -g @influxdata/flux-lsp-cli
   

2. 安装 vim-lsp

   如果目录尚不存在，请在您的 ~/.vim/ 中创建一个名为 pack/$USER/start/ 的目录，并将 vim-lsp 克隆到其中

   cd ~
   mkdir -p .vim/pack/$USER/start/
   cd .vim/pack/$USER/start/
   git clone https://github.com/prabirshrestha/vim-lsp
   

3. 编辑您的 .vimrc

   接下来，编辑您的 .vimrc 配置文件以包含以下内容

   let g:lsp_diagnostics_enabled = 1
   
   if executable('flux-lsp')
       au User lsp_setup call lsp#register_server({
           \ 'name': 'flux lsp',
           \ 'cmd': {server_info->[&shell, &shellcmdflag, 'flux-lsp']},
           \ 'whitelist': ['flux'],
           \ })
   endif
   
   autocmd FileType flux nmap gd <plug>(lsp-definition)
   

使用 vim-coc 安装

1. 从 npm 安装 flux-lsp-cli

   npm i -g @influxdata/flux-lsp-cli
   

2. 安装 plug-vim

   安装 plug-vim，Vim 的插件管理器。

3. 安装 vim-coc

   安装 vim-coc，Vim 的代码补全插件。

4. 配置 vim-coc

   vim-coc 使用位于您的 ~/.vim/ 目录中的 coc-settings.json。要运行 Flux LSP，请在 languageserver 下添加 Flux 部分

   {
     "languageserver": {
         "flux": {
           "command": "flux-lsp",
           "filetypes": ["flux"]
         }
     }
   }
   

   要调试 flux-lsp，请将其配置为记录到 /tmp/fluxlsp

   {
     "languageserver": {
         "flux": {
           "command": "flux-lsp",
           "args": ["-l", "/tmp/fluxlsp"],
           "filetypes": ["flux"]
         }
     }
   }