- Documentation support for Godot using LSP (inside Neovim or Godot).
- Search documentation class (with auto completion)
- Jump to declaration, definition, or documentation (
gdby default) - Jump to file on
res://resource/pathwithgf - Telescope and snacks integration (search for documentation class)
Showcase.gdscript-extended-lsp.mp4
It simply attaches and sets a keymap for "go to definition" (gd by default). This way you can customize your own keybindings in your LSP configuration.
While viewing documentation in Neovim, use gf to open the class under the cursor.
-- lazy.nvim
{
"teatek/gdscript-extended-lsp.nvim", opts = {}
}{
doc_file_extension = ".txt", -- Documentation file extension (can allow a better search in buffers list with telescope)
view_type = "vsplit", -- Options : "current", "split", "vsplit", "tab", "floating"
split_side = false, -- (For split and vsplit only) Open on the right or top on false and on the left or bottom on true
keymaps = {
declaration = "gd", -- Keymap to go to definition
close = { "q", "<Esc>" }, -- Keymap for closing the documentation
},
floating_win_size = 0.8, -- Floating window size
picker = "telescope" -- Options : "telescope", "snacks"
}If you prefer viewing documentation in the Godot editor, toggle on: network/language_server/show_native_symbols_in_editor in the godot editor settings.
:GodotDoc <symbol> : Open class documentation
Exposed functions :
require('gdscript-extended-lsp').get_classes() -- get list of godot classes
require('gdscript-extended-lsp').request_doc_class(symbol) -- get documentation for a class
require('gdscript-extended-lsp').picker() -- Search for doc with a picker (set by picker setting in the config)After the plugin setup, you can load the telescope extension.
require('telescope').load_extension('gdscript-extended-lsp'):Telescope gdscript-extended-lsp class : Search class documentation with telescope