Configure

You can customize the document hover template. A default template is here. The syntax rule is jinja. The template path is decided by your OS:

• ~/.config/pip/template.md.j2

• For windows, change ~/.config to ~/AppData/Local

• For macOS, change ~/.config to ~/Library

(Neo)Vim

For vim:

• Change ~/.config/nvim to ~/.vim

• Change init.vim to vimrc

coc.nvim

~/.config/nvim/coc-settings.json:

{
  "languageserver": {
    "requirements": {
      "command": "requirements-language-server",
      "filetypes": [
        "requirements"
      ]
    }
  }
}

vim-lsp

~/.config/nvim/init.vim:

if executable('requirements-language-server')
  augroup lsp
    autocmd!
    autocmd User lsp_setup call lsp#register_server({
          \ 'name': 'requirements',
          \ 'cmd': {server_info->['requirements-language-server']},
          \ 'whitelist': ['requirements'],
          \ })
  augroup END
endif

Neovim

~/.config/nvim/init.lua:

vim.api.nvim_create_autocmd({ "BufEnter" }, {
  pattern = { "requirements.txt", "requirements/*.txt" },
  callback = function()
    vim.lsp.start({
      name = "requirements",
      cmd = { "requirements-language-server" }
    })
  end,
})

Emacs

~/.emacs.d/init.el:

(make-lsp-client :new-connection
(lsp-stdio-connection
  `(,(executable-find "requirements-language-server")))
  :activation-fn (lsp-activate-on "requirements.txt" "requirements/*.txt")
  :server-id "requirements")))

Helix

~/.config/helix/languages.toml:

[[language]]
name = "requirements"
language-servers = [ "requirements-language-server",]

[language_server.requirements-language-server]
command = "requirements-language-server"

KaKoune

kak-lsp

~/.config/kak-lsp/kak-lsp.toml:

[language_server.requirements-language-server]
filetypes = [ "requirements",]
command = "requirements-language-server"

Sublime

~/.config/sublime-text-3/Packages/Preferences.sublime-settings:

{
  "clients": {
    "requirements": {
      "command": [
        "requirements-language-server"
      ],
      "enabled": true,
      "selector": "source.requirements"
    }
  }
}

Visual Studio Code

An official support of generic LSP client is pending.

vscode-glspc

~/.config/Code/User/settings.json:

{
  "glspc.serverPath": "requirements-language-server",
  "glspc.languageId": "requirements.txt"
}