nvim lspconfig

nvim-lspconfig

nvim-lspconfig é um repositório "somente dados", que fornece configurações básicas e padrão do cliente Nvim LSP para vários servidores LSP.

Veja a documentação para todas as configurações ou :help lspconfig-all do Nvim.

Importante ⚠️

• Se você encontrou um bug na funcionalidade Nvim LSP ( :help lsp ), relate-o ao núcleo do Neovim.
  • Não relate isso aqui. Apenas os dados de configuração residem aqui.
• Essas configurações são de melhor esforço e suportadas pela comunidade. Veja contribuições.
• Nota: Este repositório fornece apenas configurações . Sua API programática está obsoleta e não deve ser usada externamente.
  • O trabalho está planejado para upstream seletivamente as partes da "estrutura" ( não as configurações) do nvim-lspconfig, para o núcleo do Nvim, e descontinua-las no nvim-lspconfig.

Instalar

• Requer Nvim 0.9 acima. Atualize o Nvim e o nvim-lspconfig antes de relatar um problema.
• Instale o nvim-lspconfig usando o recurso "pacotes" do Vim:

   git clone https://github.com/neovim/nvim-lspconfig ~/.config/nvim/pack/nvim/start/nvim-lspconfig
  

• Ou use um gerenciador de plugins de terceiros (consulte a documentação do seu gerenciador de plugins).

Início rápido

1. Instale um servidor de idioma, por exemplo, pyright

   npm i -g pyright

2. Adicione a configuração do servidor de idioma ao seu init.lua.

    require ' lspconfig ' . pyright . setup {}

3. Certifique-se de que seu projeto/espaço de trabalho contenha um marcador raiz que corresponda aos requisitos do servidor especificados em :help lspconfig-all .
4. Abra um arquivo de código no Nvim. O LSP anexará e fornecerá diagnósticos.

    nvim main.py
   

5. Execute :checkhealth lsp para ver o status ou solucionar problemas.

Leia :help lspconfig para obter detalhes. Leia :help lspconfig-all para obter a lista completa de detalhes específicos do servidor. Para servidores que não estão em seu $PATH (por exemplo, jdtls , elixirls ), você deve definir manualmente o parâmetro cmd ao chamar setup() .

Configuração

O Nvim define algumas opções e mapeamentos padrão quando um buffer é anexado ao LSP (consulte :help lsp-config ). Em particular:

• 'tagfunc'
  • Ativa recursos de "ir para definição" usando <C-]> e outros comandos de tag.
• 'omnifunc'
  • Ativa a conclusão do modo omni (manual) com <CX><CO> no modo Inserir. Para o preenchimento automático , é necessário um plugin de preenchimento automático.
• 'formatexpr'
  • Habilita a formatação LSP com gq .
• K mapeia para vim.lsp.buf.hover() no modo Normal.
• [d e ]d mapeiam para vim.diagnostic.goto_prev() e vim.diagnostic.goto_next() , respectivamente.
• <CW>d mapeia para vim.diagnostic.open_float() .

Personalização adicional pode ser obtida usando o evento de comando automático LspAttach . O evento de comando automático LspDetach pode ser usado para "limpar" mapeamentos se um buffer for desconectado de um servidor LSP. Consulte :h LspAttach e :h LspDetach para obter detalhes e exemplos. Veja :h lsp-buf para detalhes sobre outras funções LSP.

Opções de configuração adicionais podem ser fornecidas para cada servidor LSP passando argumentos para a função setup . Veja :h lspconfig-setup para detalhes. Exemplo:

 local lspconfig = require ( ' lspconfig ' )
lspconfig . rust_analyzer . setup {
  -- Server-specific settings. See `:help lspconfig-setup`
  settings = {
    [ ' rust-analyzer ' ] = {},
  },
}

Solução de problemas

Os motivos mais comuns pelos quais um servidor de idioma não inicia ou se conecta são:

1. O servidor de idiomas não está instalado. nvim-lspconfig não instala servidores de idiomas para você. Você deve ser capaz de executar o cmd definido no módulo Lua de cada servidor a partir da linha de comando e ver se o servidor de linguagem é iniciado. Se o cmd for um nome de executável em vez de um caminho absoluto para o executável, verifique se ele está no seu caminho.
2. Plug-ins de tipo de arquivo ausentes. Certos idiomas não são detectados pelo Vim/Nvim porque ainda não foram adicionados ao sistema de detecção de tipo de arquivo. Certifique-se de :set ft? mostra o tipo de arquivo e não um valor vazio.
3. Não acionando a detecção de raiz. Alguns servidores de linguagem só serão iniciados se forem abertos em um diretório, ou diretório filho, contendo um arquivo que sinaliza a raiz do projeto. Na maioria das vezes, esta é uma pasta .git , mas cada servidor define a configuração raiz no arquivo lua. Consulte doc/configs.md ou a fonte para obter a lista de diretórios raiz.
4. Você deve transmitir capabilities para cada setup {} se quiser que eles entrem em vigor.
5. Não chame setup {} duas vezes para o mesmo servidor . A segunda chamada para setup {} substituirá a primeira.

Relatórios de bugs

Se você encontrou um bug na funcionalidade LSP, relate-o ao núcleo do Neovim.

Antes de relatar um bug, verifique seus logs e a saída de :LspInfo . Adicione o seguinte ao seu init.vim para ativar o registro:

 vim . lsp . set_log_level ( " debug " )

Tente executar o servidor de idiomas e abra o log com:

 :LspLog

Na maioria das vezes, o motivo da falha está presente nos logs.

Comandos

• :LspInfo (alias obsoleto para :che lspconfig ) mostra o status dos servidores de idiomas ativos e configurados.
• :LspStart <config_name> Inicia o nome do servidor solicitado. Só será iniciado com êxito se o comando detectar um diretório raiz correspondente à configuração atual. Passe autostart = false para sua chamada .setup{} para um servidor de linguagem se desejar iniciar clientes somente com este comando. O padrão é todos os servidores que correspondem ao tipo de arquivo de buffer atual.
• :LspStop <client_id> O padrão é parar todos os clientes de buffer.
• :LspRestart <client_id> O padrão é reiniciar todos os clientes de buffer.

Contribuições

Se um servidor de idioma estiver faltando em configs.md, contribuir com uma nova configuração para ele ajudará outras pessoas, especialmente se o servidor exigir configuração especial. Siga estas etapas:

1. Leia CONTRIBUTING.md.
2. Crie um novo arquivo em lua/lspconfig/configs/SERVER_NAME.lua .
   • Copie uma configuração existente para começar. A maioria das configurações é simples. Para um exemplo extenso, consulte texlab.lua.
3. Tire dúvidas nas discussões do GitHub ou na sala Neovim Matrix.

Processo de liberação

Para publicar um lançamento:

• Crie e envie uma nova tag.
• Depois de enviar a tag, uma ação do GitHub empacotará automaticamente o plugin e publicará o lançamento no LuaRocks.

Licença

Colaboradores do Neovim com direitos autorais. Todos os direitos reservados.

nvim-lspconfig está licenciado sob os termos da licença Apache 2.0.

Veja LICENSE.md