aboutsummaryrefslogtreecommitdiff
path: root/runtime/lua/vim
diff options
context:
space:
mode:
authorJongwook Choi <wookayin@gmail.com>2024-01-06 07:18:13 -0500
committerLewis Russell <me@lewisr.dev>2024-01-08 09:27:03 +0000
commitfbe40caa7cc1786dc58210a82901307417ba0654 (patch)
treec577b7efd70ca2e13519c1fa1540dd5525a90271 /runtime/lua/vim
parent367e52cc79a786bbee4456b30f9ec5db7e28d6a5 (diff)
downloadrneovim-fbe40caa7cc1786dc58210a82901307417ba0654.tar.gz
rneovim-fbe40caa7cc1786dc58210a82901307417ba0654.tar.bz2
rneovim-fbe40caa7cc1786dc58210a82901307417ba0654.zip
docs(treesitter): improve 'no parser' error message for InspectTree
Improve error messages for `:InspectTree`, when no parsers are available for the current buffer and filetype. We can show more informative and helpful error message for users (e.g., which lang was searched for): ``` ... No parser available for the given buffer: +... no parser for 'custom_ft' language, see :help treesitter-parsers ``` Also improve the relevant docs for *treesitter-parsers*.
Diffstat (limited to 'runtime/lua/vim')
-rw-r--r--runtime/lua/vim/treesitter/dev.lua3
-rw-r--r--runtime/lua/vim/treesitter/language.lua4
2 files changed, 6 insertions, 1 deletions
diff --git a/runtime/lua/vim/treesitter/dev.lua b/runtime/lua/vim/treesitter/dev.lua
index 870761b7c7..399d0ef03e 100644
--- a/runtime/lua/vim/treesitter/dev.lua
+++ b/runtime/lua/vim/treesitter/dev.lua
@@ -75,7 +75,8 @@ end
function TSTreeView:new(bufnr, lang)
local ok, parser = pcall(vim.treesitter.get_parser, bufnr or 0, lang)
if not ok then
- return nil, 'No parser available for the given buffer'
+ local err = parser --[[ @as string ]]
+ return nil, 'No parser available for the given buffer:\n' .. err
end
-- For each child tree (injected language), find the root of the tree and locate the node within
diff --git a/runtime/lua/vim/treesitter/language.lua b/runtime/lua/vim/treesitter/language.lua
index 2056c337c8..2105a1d992 100644
--- a/runtime/lua/vim/treesitter/language.lua
+++ b/runtime/lua/vim/treesitter/language.lua
@@ -119,6 +119,10 @@ local function ensure_list(x)
end
--- Register a parser named {lang} to be used for {filetype}(s).
+---
+--- Note: this adds or overrides the mapping for {filetype}, any existing mappings from other
+--- filetypes to {lang} will be preserved.
+---
--- @param lang string Name of parser
--- @param filetype string|string[] Filetype(s) to associate with lang
function M.register(lang, filetype)