nvim lspconfig

nvim-lspconfig

nvim-lspconfig est un référentiel « données uniquement », fournissant des configurations client Nvim LSP de base par défaut pour divers serveurs LSP.

Consultez la documentation pour toutes les configurations ou :help lspconfig-all de Nvim.

Important ⚠️

• Si vous avez trouvé un bug dans la fonctionnalité Nvim LSP ( :help lsp ), signalez-le au noyau Neovim.
  • Ne le signalez pas ici. Seules les données de configuration résident ici.
• Ces configurations sont basées sur les meilleurs efforts et prises en charge par la communauté. Voir les contributions.
• Remarque : ce référentiel fournit uniquement des configurations . Son API programmatique est obsolète et ne doit pas être utilisée en externe.
  • Des travaux sont prévus pour amont sélectivement les parties "framework" ( et non les configurations) de nvim-lspconfig, vers le noyau Nvim, et les déprécier dans nvim-lspconfig.

Installer

• Nécessite Nvim 0.9 ci-dessus. Mettez à jour Nvim et nvim-lspconfig avant de signaler un problème.
• Installez nvim-lspconfig à l'aide de la fonctionnalité "packages" de Vim :

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

• Ou utilisez un gestionnaire de plugins tiers (consultez la documentation de votre gestionnaire de plugins).

Démarrage rapide

1. Installer un serveur de langue, par exemple pyright

   npm i -g pyright

2. Ajoutez la configuration du serveur de langue à votre init.lua.

    require ' lspconfig ' . pyright . setup {}

3. Assurez-vous que votre projet/espace de travail contient un marqueur racine qui correspond aux exigences du serveur spécifiées dans :help lspconfig-all .
4. Ouvrez un fichier de code dans Nvim. LSP se joindra et fournira des diagnostics.

    nvim main.py
   

5. Exécutez :checkhealth lsp pour voir l’état ou pour dépanner.

Lisez :help lspconfig pour plus de détails. Lisez :help lspconfig-all pour la liste complète des détails spécifiques au serveur. Pour les serveurs qui ne sont pas sur votre $PATH (par exemple, jdtls , elixirls ), vous devez définir manuellement le paramètre cmd lors de l'appel setup() .

Configuration

Nvim définit certaines options et mappages par défaut lorsqu'un tampon s'attache à LSP (voir :help lsp-config ). En particulier:

• 'tagfunc'
  • Active les fonctionnalités « aller à la définition » à l'aide de <C-]> et d'autres commandes de balise.
• 'omnifunc'
  • Active la complétion (manuelle) du mode omni avec <CX><CO> en mode Insertion. Pour la saisie semi-automatique , un plugin de saisie semi-automatique est requis.
• 'formatexpr'
  • Active le formatage LSP avec gq .
• K correspond à vim.lsp.buf.hover() en mode Normal.
• [d et ]d correspondent respectivement à vim.diagnostic.goto_prev() et vim.diagnostic.goto_next() .
• <CW>d correspond à vim.diagnostic.open_float() .

Une personnalisation plus poussée peut être réalisée à l'aide de l'événement de commande automatique LspAttach . L'événement de commande automatique LspDetach peut être utilisé pour « nettoyer » les mappages si un tampon se détache d'un serveur LSP. Voir :h LspAttach et :h LspDetach pour plus de détails et des exemples. Voir :h lsp-buf pour plus de détails sur les autres fonctions LSP.

Des options de configuration supplémentaires peuvent être fournies pour chaque serveur LSP en transmettant des arguments à la fonction setup . Voir :h lspconfig-setup pour plus de détails. Exemple:

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

Dépannage

Les raisons les plus courantes pour lesquelles un serveur de langue ne démarre pas ou ne se connecte pas sont :

1. Le serveur de langue n'est pas installé. nvim-lspconfig n'installe pas les serveurs de langue pour vous. Vous devriez pouvoir exécuter le cmd défini dans le module Lua de chaque serveur à partir de la ligne de commande et voir que le serveur de langue démarre. Si le cmd est un nom d'exécutable au lieu d'un chemin absolu vers l'exécutable, assurez-vous qu'il se trouve sur votre chemin.
2. Plugins de type de fichier manquants. Certaines langues ne sont pas détectées par Vim/Nvim car elles n'ont pas encore été ajoutées au système de détection de type de fichier. Assurez-vous :set ft? affiche le type de fichier et non une valeur vide.
3. Ne déclenche pas la détection de racine. Certains serveurs de langage ne démarreront que s'ils sont ouverts dans un répertoire, ou répertoire enfant, contenant un fichier qui signale la racine du projet. La plupart du temps, il s'agit d'un dossier .git , mais chaque serveur définit la configuration racine dans le fichier lua. Voir doc/configs.md ou la source pour la liste des répertoires racine.
4. Vous devez transmettre capabilities pour chaque setup {} si vous souhaitez qu'elles prennent effet.
5. N'appelez pas setup {} deux fois pour le même serveur . Le deuxième appel à setup {} écrasera le premier.

Rapports de bogues

Si vous avez trouvé un bug avec la fonctionnalité LSP, signalez-le au noyau Neovim.

Avant de signaler un bug, vérifiez vos journaux et la sortie de :LspInfo . Ajoutez ce qui suit à votre init.vim pour activer la journalisation :

 vim . lsp . set_log_level ( " debug " )

Essayez d'exécuter le serveur de langue et ouvrez le journal avec :

 :LspLog

La plupart du temps, la raison de l’échec est présente dans les logs.

Commandes

• :LspInfo (alias obsolète de :che lspconfig ) affiche l'état des serveurs de langue actifs et configurés.
• :LspStart <config_name> Démarre le nom de serveur demandé. Ne démarrera avec succès que si la commande détecte un répertoire racine correspondant à la configuration actuelle. Passez autostart = false à votre appel .setup{} pour un serveur de langue si vous souhaitez lancer des clients uniquement avec cette commande. La valeur par défaut est tous les serveurs correspondant au type de fichier tampon actuel.
• :LspStop <client_id> Arrête par défaut tous les clients tampon.
• :LspRestart <client_id> Redémarre par défaut tous les clients tampon.

Cotisations

Si un serveur de langue est absent de configs.md, le fait de contribuer à une nouvelle configuration aide les autres, surtout si le serveur nécessite une configuration spéciale. Suivez ces étapes :

1. Lisez CONTRIBUTION.md.
2. Créez un nouveau fichier sur lua/lspconfig/configs/SERVER_NAME.lua .
   • Copiez une configuration existante pour commencer. La plupart des configurations sont simples. Pour un exemple détaillé, voir texlab.lua.
3. Posez des questions sur les discussions GitHub ou dans la salle Neovim Matrix.

Processus de libération

Pour publier une version :

• Créez et poussez une nouvelle balise.
• Après avoir poussé la balise, une action GitHub empaquetera automatiquement le plugin et publiera la version sur LuaRocks.

Licence

Copyright Contributeurs de Neovim. Tous droits réservés.

nvim-lspconfig est sous licence selon les termes de la licence Apache 2.0.

Voir LICENSE.md