aboutsummaryrefslogtreecommitdiff
path: root/runtime/lua/vim/treesitter/language.lua
diff options
context:
space:
mode:
authorThomas Vigouroux <tomvig38@gmail.com>2020-07-16 17:17:42 +0200
committerThomas Vigouroux <tomvig38@gmail.com>2020-08-13 20:30:15 +0200
commit18c0e775286aa6621d9190db8cf02e65a3f3d61f (patch)
tree8a53b4e0c7dc4bf78a310878a61bac00a4da08a1 /runtime/lua/vim/treesitter/language.lua
parent613068071e02ddf5958fa82974373c370112c5e6 (diff)
downloadrneovim-18c0e775286aa6621d9190db8cf02e65a3f3d61f.tar.gz
rneovim-18c0e775286aa6621d9190db8cf02e65a3f3d61f.tar.bz2
rneovim-18c0e775286aa6621d9190db8cf02e65a3f3d61f.zip
treesitter(docs): update and refresh docs
Diffstat (limited to 'runtime/lua/vim/treesitter/language.lua')
-rw-r--r--runtime/lua/vim/treesitter/language.lua13
1 files changed, 12 insertions, 1 deletions
diff --git a/runtime/lua/vim/treesitter/language.lua b/runtime/lua/vim/treesitter/language.lua
index b4817de91e..a7e36a0b89 100644
--- a/runtime/lua/vim/treesitter/language.lua
+++ b/runtime/lua/vim/treesitter/language.lua
@@ -2,6 +2,12 @@ local a = vim.api
local M = {}
+--- Asserts that the provided language is installed, and optionnaly provide a path for the parser
+--
+-- Parsers are searched in the `parser` runtime directory.
+--
+-- @param lang The language the parser should parse
+-- @param path Optionnal path the parser is located at
function M.require_language(lang, path)
if vim._ts_has_language(lang) then
return true
@@ -11,13 +17,18 @@ function M.require_language(lang, path)
local paths = a.nvim_get_runtime_file(fname, false)
if #paths == 0 then
-- TODO(bfredl): help tag?
- error("no parser for '"..lang.."' language")
+ error("no parser for '"..lang.."' language, see :help treesitter-parsers")
end
path = paths[1]
end
vim._ts_add_language(path, lang)
end
+--- Inspects the provided language.
+--
+-- Inspecting provides some useful informations on the language like node names, ...
+--
+-- @param lang The language.
function M.inspect_language(lang)
M.require_language(lang)
return vim._ts_inspect_language(lang)