nvim lspconfig.php

nvim-lspconfig.php

nvim-lspconfig เป็น repo "ข้อมูลเท่านั้น" ที่ให้การกำหนดค่าไคลเอ็นต์ Nvim LSP พื้นฐานที่เป็นค่าเริ่มต้นสำหรับเซิร์ฟเวอร์ LSP ต่างๆ

ดูเอกสารประกอบสำหรับการกำหนดค่าทั้งหมดหรือ :help lspconfig-all จาก Nvim

สำคัญ

• หากคุณพบจุดบกพร่องในฟังก์ชันการทำงานของ Nvim LSP ( :help lsp ) ให้รายงานจุดบกพร่องนั้นไปยัง Neovim core
  • อย่า รายงานที่นี่ มีเพียงข้อมูลการกำหนดค่าเท่านั้นที่นี่
• การกำหนดค่าเหล่านี้เป็น ความพยายามอย่างดีที่สุดและได้รับการสนับสนุนจากชุมชน ดูการมีส่วนร่วม
• หมายเหตุ: repo นี้จัดเตรียมเฉพาะ การกำหนดค่า เท่านั้น API แบบเป็นโปรแกรมเลิกใช้งานแล้วและไม่ควรใช้ภายนอก
  • งานได้รับการวางแผนไว้เพื่อเลือกอัปสตรีมส่วน "เฟรมเวิร์ก" ( ไม่ใช่ การกำหนดค่า) ของ nvim-lspconfig ไปยัง Nvim core และเลิกใช้งานใน nvim-lspconfig

ติดตั้ง

• ต้องใช้ Nvim 0.9 ขึ้นไป อัปเดต Nvim และ nvim-lspconfig ก่อนที่จะรายงานปัญหา
• ติดตั้ง nvim-lspconfig โดยใช้คุณสมบัติ "แพ็คเกจ" ของ Vim:

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

• หรือใช้ตัวจัดการปลั๊กอินของบริษัทอื่น (ดูเอกสารประกอบสำหรับตัวจัดการปลั๊กอินของคุณ)

เริ่มต้นอย่างรวดเร็ว

1. ติดตั้งเซิร์ฟเวอร์ภาษา เช่น pyright

   npm i -g pyright

2. เพิ่มการตั้งค่าเซิร์ฟเวอร์ภาษาให้กับ init.lua ของคุณ

    require ' lspconfig ' . pyright . setup {}

3. ตรวจสอบให้แน่ใจว่าโปรเจ็กต์/พื้นที่ทำงานของคุณมีเครื่องหมายรูทซึ่งตรงกับข้อกำหนดของเซิร์ฟเวอร์ที่ระบุใน :help lspconfig-all
4. เปิดไฟล์โค้ดใน Nvim LSP จะแนบและจัดให้มีการวินิจฉัย

    nvim main.py
   

5. รัน :checkhealth lsp เพื่อดูสถานะหรือแก้ไขปัญหา

อ่าน :help lspconfig เพื่อดูรายละเอียด อ่าน :help lspconfig-all สำหรับรายการรายละเอียดเฉพาะเซิร์ฟเวอร์ทั้งหมด สำหรับเซิร์ฟเวอร์ที่ไม่ได้อยู่ใน $PATH ของคุณ (เช่น jdtls , elixirls ) คุณต้องตั้งค่าพารามิเตอร์ cmd ด้วยตนเองเมื่อเรียก setup()

การกำหนดค่า

Nvim ตั้งค่าตัวเลือกเริ่มต้นและการแมปเมื่อบัฟเฟอร์แนบกับ LSP (ดู :help lsp-config ) โดยเฉพาะ:

• 'tagfunc'
  • เปิดใช้งานความสามารถ "ไปที่คำจำกัดความ" โดยใช้ และคำสั่งแท็กอื่นๆ
• 'omnifunc'
  • เปิดใช้งานโหมด Omni (ด้วยตนเอง) ให้เสร็จสิ้นด้วย ในโหมดแทรก สำหรับการเติม ข้อความอัตโนมัติ จำเป็นต้องมีปลั๊กอินเติมข้อความอัตโนมัติ
• 'formatexpr'
  • เปิดใช้งานการจัดรูปแบบ LSP ด้วย gq
• K แมปกับ vim.lsp.buf.hover() ในโหมดปกติ
• [d และ ]d แมปกับ vim.diagnostic.goto_prev() และ vim.diagnostic.goto_next() ตามลำดับ
• d แผนที่ไปยัง vim.diagnostic.open_float()

การปรับแต่งเพิ่มเติมสามารถทำได้โดยใช้เหตุการณ์คำสั่งอัตโนมัติ LspAttach เหตุการณ์คำสั่งอัตโนมัติ LspDetach สามารถใช้ในการแมป "ล้างข้อมูล" หากบัฟเฟอร์ถูกแยกออกจากเซิร์ฟเวอร์ LSP ดู :h LspAttach และ :h LspDetach สำหรับรายละเอียดและตัวอย่าง ดู :h lsp-buf สำหรับรายละเอียดเกี่ยวกับฟังก์ชัน LSP อื่นๆ

สามารถจัดเตรียมตัวเลือกการกำหนดค่าเพิ่มเติมสำหรับเซิร์ฟเวอร์ LSP แต่ละตัวได้โดยส่งอาร์กิวเมนต์ไปยังฟังก์ชัน setup ดู :h lspconfig-setup สำหรับรายละเอียด ตัวอย่าง:

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

การแก้ไขปัญหา

สาเหตุที่พบบ่อยที่สุดที่เซิร์ฟเวอร์ภาษาไม่เริ่มทำงานหรือแนบมาคือ:

1. ไม่ได้ติดตั้งเซิร์ฟเวอร์ภาษา nvim-lspconfig ไม่ได้ติดตั้งเซิร์ฟเวอร์ภาษาให้คุณ คุณควรจะสามารถรัน cmd ที่กำหนดในโมดูล Lua ของแต่ละเซิร์ฟเวอร์ได้จากบรรทัดคำสั่งและดูว่าเซิร์ฟเวอร์ภาษาเริ่มทำงาน หาก cmd เป็นชื่อที่เรียกใช้งานได้แทนที่จะเป็นเส้นทางที่แน่นอนไปยังไฟล์ที่เรียกใช้งานได้ ให้ตรวจสอบให้แน่ใจว่าชื่อนั้นอยู่บนเส้นทางของคุณ
2. ปลั๊กอินประเภทไฟล์หายไป Vim/Nvim ตรวจไม่พบภาษาบางภาษา เนื่องจากยังไม่ได้เพิ่มเข้าไปในระบบตรวจจับประเภทไฟล์ ตรวจสอบให้แน่ใจว่า :set ft? แสดงประเภทไฟล์และไม่ใช่ค่าว่าง
3. ไม่กระตุ้นการตรวจจับรูท เซิร์ฟเวอร์ภาษา บางแห่ง จะเริ่มทำงานก็ต่อเมื่อมีการเปิดในไดเร็กทอรีหรือไดเร็กทอรีลูกซึ่งมีไฟล์ที่ส่งสัญญาณถึง ราก ของโปรเจ็กต์ โดยส่วนใหญ่ นี่คือโฟลเดอร์ .git แต่แต่ละเซิร์ฟเวอร์จะกำหนดการกำหนดค่ารูทในไฟล์ lua ดู doc/configs.md หรือแหล่งที่มาสำหรับรายการไดเรกทอรีราก
4. คุณต้องผ่าน capabilities สำหรับการตั้งค่า แต่ละ setup {} หากคุณต้องการให้สิ่งเหล่านี้มีผล
5. อย่าเรียก setup {} สองครั้งสำหรับเซิร์ฟเวอร์เดียวกัน การเรียกครั้งที่สองเพื่อ setup {} จะเขียนทับการเรียกครั้งแรก

รายงานข้อผิดพลาด

หากคุณพบข้อบกพร่องเกี่ยวกับฟังก์ชัน LSP ให้รายงานไปยัง Neovim core

ก่อนที่จะรายงานจุดบกพร่อง ให้ตรวจสอบบันทึกและผลลัพธ์ของ :LspInfo เพิ่มสิ่งต่อไปนี้ใน init.vim ของคุณเพื่อเปิดใช้งานการบันทึก:

 vim . lsp . set_log_level ( " debug " )

พยายามเรียกใช้เซิร์ฟเวอร์ภาษา และเปิดบันทึกด้วย:

 :LspLog

โดยส่วนใหญ่ สาเหตุของความล้มเหลวจะแสดงอยู่ในบันทึก

คำสั่ง

• :LspInfo (นามแฝงที่เลิกใช้แล้ว :che lspconfig ) แสดงสถานะของเซิร์ฟเวอร์ภาษาที่ใช้งานอยู่และกำหนดค่าไว้
• :LspStart เริ่มต้นชื่อเซิร์ฟเวอร์ที่ร้องขอ จะเริ่มทำงานได้สำเร็จก็ต่อเมื่อคำสั่งตรวจพบไดเรกทอรีรากที่ตรงกับการกำหนดค่าปัจจุบัน ส่งผ่าน autostart = false ไปยังการเรียก .setup{} สำหรับเซิร์ฟเวอร์ภาษาของคุณ หากคุณต้องการเปิดใช้ไคลเอ็นต์ด้วยคำสั่งนี้เพียงอย่างเดียว ตั้งค่าเริ่มต้นให้กับเซิร์ฟเวอร์ทั้งหมดที่ตรงกับประเภทไฟล์บัฟเฟอร์ปัจจุบัน
• :LspStop ค่าเริ่มต้นคือการหยุดบัฟเฟอร์ไคลเอ็นต์ทั้งหมด
• :LspRestart ค่าเริ่มต้นในการรีสตาร์ทไคลเอ็นต์บัฟเฟอร์ทั้งหมด

ผลงาน

หากเซิร์ฟเวอร์ภาษาหายไปจาก configs.md การสนับสนุนการกำหนดค่าใหม่จะช่วยให้ผู้อื่น โดยเฉพาะอย่างยิ่งหากเซิร์ฟเวอร์ต้องการการตั้งค่าพิเศษ ทำตามขั้นตอนเหล่านี้:

1. อ่าน CONTRIBUTING.md
2. สร้างไฟล์ใหม่ที่ lua/lspconfig/configs/SERVER_NAME.lua
   • คัดลอกการกำหนดค่าที่มีอยู่เพื่อเริ่มต้น การกำหนดค่าส่วนใหญ่ทำได้ง่าย สำหรับตัวอย่างเพิ่มเติม โปรดดูที่ texlab.lua
3. ถามคำถามเกี่ยวกับการสนทนา GitHub หรือในห้อง Neovim Matrix

กระบวนการวางจำหน่าย

หากต้องการเผยแพร่รุ่น:

• สร้างและพุชแท็กใหม่
• หลังจากกดแท็ก การกระทำของ GitHub จะรวมปลั๊กอินและเผยแพร่การเปิดตัวไปยัง LuaRocks โดยอัตโนมัติ

ใบอนุญาต

ลิขสิทธิ์ของผู้มีส่วนร่วม Neovim สงวนลิขสิทธิ์.

nvim-lspconfig ได้รับอนุญาตภายใต้เงื่อนไขของใบอนุญาต Apache 2.0

ดู LICENSE.md