nvim lspconfig

nvim-lspconfig

nvim-lspconfig ist ein „nur Daten“-Repository, das grundlegende, standardmäßige Nvim-LSP-Clientkonfigurationen für verschiedene LSP-Server bereitstellt.

Sehen Sie sich die Dokumentation für alle Konfigurationen oder :help lspconfig-all von Nvim an.

Wichtig ⚠️

• Wenn Sie einen Fehler in der Nvim-LSP-Funktionalität ( :help lsp ) gefunden haben, melden Sie ihn dem Neovim-Kern.
  • Melden Sie es hier nicht . Hier leben nur Konfigurationsdaten.
• Bei diesen Konfigurationen handelt es sich um Best-Effort-Konfigurationen, die von der Community unterstützt werden. Siehe Beiträge.
• Hinweis: Dieses Repo stellt nur Konfigurationen bereit. Die programmgesteuerte API ist veraltet und sollte nicht extern verwendet werden.
  • Es ist geplant, die „Framework“-Teile ( nicht die Konfigurationen) von nvim-lspconfig selektiv in den Nvim-Kern hochzuladen und sie in nvim-lspconfig als veraltet zu betrachten.

Installieren

• Erfordert Nvim 0.9 oben. Aktualisieren Sie Nvim und nvim-lspconfig, bevor Sie ein Problem melden.
• Installieren Sie nvim-lspconfig mit der „Pakete“-Funktion von Vim:

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

• Oder verwenden Sie einen Plugin-Manager eines Drittanbieters (lesen Sie die Dokumentation Ihres Plugin-Managers).

Schnellstart

1. Installieren Sie einen Sprachserver, z. B. pyright

   npm i -g pyright

2. Fügen Sie das Sprachserver-Setup zu Ihrer init.lua hinzu.

    require ' lspconfig ' . pyright . setup {}

3. Stellen Sie sicher, dass Ihr Projekt/Arbeitsbereich eine Root-Markierung enthält, die den in :help lspconfig-all angegebenen Serveranforderungen entspricht.
4. Öffnen Sie eine Codedatei in Nvim. LSP wird eine Verbindung herstellen und eine Diagnose bereitstellen.

    nvim main.py
   

5. Führen Sie :checkhealth lsp aus, um den Status anzuzeigen oder Fehler zu beheben.

Weitere Informationen finden Sie unter :help lspconfig . Lesen Sie :help lspconfig-all für die vollständige Liste der serverspezifischen Details. Für Server, die sich nicht in Ihrem $PATH befinden (z. B. jdtls , elixirls ), müssen Sie den cmd Parameter beim Aufruf von setup() manuell festlegen.

Konfiguration

Nvim legt einige Standardoptionen und Zuordnungen fest, wenn ein Puffer an LSP angeschlossen wird (siehe :help lsp-config ). Insbesondere:

• 'tagfunc'
  • Ermöglicht die Funktion „Gehe zur Definition“ mithilfe von und anderen Tag-Befehlen.
• 'omnifunc'
  • Ermöglicht die (manuelle) Omni-Modus-Vervollständigung mit im Einfügemodus. Für die automatische Vervollständigung ist ein Autovervollständigungs-Plugin erforderlich.
• 'formatexpr'
  • Aktiviert die LSP-Formatierung mit gq .
• K wird im Normalmodus auf vim.lsp.buf.hover() abgebildet.
• [d und ]d sind jeweils vim.diagnostic.goto_prev() und vim.diagnostic.goto_next() zugeordnet.
• d wird vim.diagnostic.open_float() zugeordnet.

Weitere Anpassungen können mithilfe des LspAttach Autocommand-Ereignisses erreicht werden. Das LspDetach -Autocommand-Ereignis kann zum „Bereinigen“ von Zuordnungen verwendet werden, wenn ein Puffer von einem LSP-Server getrennt wird. Einzelheiten und Beispiele finden Sie unter :h LspAttach und :h LspDetach . Einzelheiten zu anderen LSP-Funktionen finden Sie unter :h lsp-buf .

Zusätzliche Konfigurationsoptionen können für jeden LSP-Server bereitgestellt werden, indem Argumente an die setup -Funktion übergeben werden. Weitere Informationen finden Sie unter :h lspconfig-setup . Beispiel:

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

Fehlerbehebung

Die häufigsten Gründe, warum ein Sprachserver nicht startet oder keine Verbindung herstellt, sind:

1. Der Sprachserver ist nicht installiert. nvim-lspconfig installiert keine Sprachserver für Sie. Sie sollten in der Lage sein, den im Lua-Modul jedes Servers definierten cmd über die Befehlszeile auszuführen und zu sehen, dass der Sprachserver startet. Wenn es sich bei dem cmd um einen Namen einer ausführbaren Datei und nicht um einen absoluten Pfad zur ausführbaren Datei handelt, stellen Sie sicher, dass er sich in Ihrem Pfad befindet.
2. Fehlende Dateityp-Plugins. Bestimmte Sprachen werden von Vim/Nvim nicht erkannt, da sie noch nicht zum Dateityp-Erkennungssystem hinzugefügt wurden. Stellen Sie sicher :set ft? zeigt den Dateityp und keinen leeren Wert.
3. Root-Erkennung wird nicht ausgelöst. Einige Sprachserver werden nur gestartet, wenn sie in einem Verzeichnis oder Unterverzeichnis geöffnet werden, das eine Datei enthält, die das Stammverzeichnis des Projekts anzeigt. Meistens ist dies ein .git -Ordner, aber jeder Server definiert die Root-Konfiguration in der Lua-Datei. Die Liste der Stammverzeichnisse finden Sie in doc/configs.md oder in der Quelle.
4. Sie müssen für jedes setup {} capabilities übergeben, damit diese wirksam werden.
5. Rufen Sie setup {} nicht zweimal für denselben Server auf . Der zweite Aufruf von setup {} überschreibt den ersten.

Fehlerberichte

Wenn Sie einen Fehler in der LSP-Funktionalität gefunden haben, melden Sie ihn an Neovim Core.

Bevor Sie einen Fehler melden, überprüfen Sie Ihre Protokolle und die Ausgabe von :LspInfo . Fügen Sie Folgendes zu Ihrer init.vim hinzu, um die Protokollierung zu aktivieren:

 vim . lsp . set_log_level ( " debug " )

Versuchen Sie, den Sprachserver auszuführen, und öffnen Sie das Protokoll mit:

 :LspLog

In den meisten Fällen liegt die Fehlerursache in den Protokollen.

Befehle

• :LspInfo (veralteter Alias ​​von :che lspconfig ) zeigt den Status aktiver und konfigurierter Sprachserver an.
• :LspStart Starten Sie den angeforderten Servernamen. Wird nur erfolgreich gestartet, wenn der Befehl ein Stammverzeichnis erkennt, das der aktuellen Konfiguration entspricht. Übergeben Sie autostart = false an Ihren .setup{} -Aufruf für einen Sprachserver, wenn Sie Clients ausschließlich mit diesem Befehl starten möchten. Standardmäßig werden alle Server verwendet, die dem aktuellen Pufferdateityp entsprechen.
• :LspStop Stoppt standardmäßig alle Puffer-Clients.
• :LspRestart Standardmäßig werden alle Puffer-Clients neu gestartet.

Beiträge

Wenn in configs.md ein Sprachserver fehlt, hilft es anderen, eine neue Konfiguration dafür beizutragen, insbesondere wenn der Server eine spezielle Einrichtung erfordert. Befolgen Sie diese Schritte:

1. Lesen Sie CONTRIBUTING.md.
2. Erstellen Sie eine neue Datei unter lua/lspconfig/configs/SERVER_NAME.lua .
   • Kopieren Sie eine vorhandene Konfiguration, um zu beginnen. Die meisten Konfigurationen sind einfach. Ein ausführliches Beispiel finden Sie unter texlab.lua.
3. Stellen Sie Fragen in den GitHub-Diskussionen oder im Neovim-Matrix-Raum.

Freigabeprozess

So veröffentlichen Sie eine Veröffentlichung:

• Erstellen und pushen Sie ein neues Tag.
• Nach dem Pushen des Tags verpackt eine GitHub-Aktion das Plugin automatisch und veröffentlicht die Version auf LuaRocks.

Lizenz

Copyright Neovim-Mitwirkende. Alle Rechte vorbehalten.

nvim-lspconfig ist unter den Bedingungen der Apache 2.0-Lizenz lizenziert.

Siehe LICENSE.md