feat(treesitter)!: remove silent option from language.add()

Simply use `pcall` if you want to silence an error.
This commit is contained in:
Lewis Russell 2023-02-24 09:50:59 +00:00 committed by GitHub
parent 306e673583
commit c57af5d41c
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
4 changed files with 14 additions and 30 deletions

View File

@ -686,11 +686,6 @@ add({lang}, {opts}) *vim.treesitter.language.add()*
• path (string|nil) Optional path the parser is located at
• symbol_name (string|nil) Internal symbol name for the
language to load
• silent (boolean|nil) Don't throw an error if language not
found
Return: ~
(boolean) If the specified language is installed
get_lang({filetype}) *vim.treesitter.language.get_lang()*
Parameters: ~

View File

@ -13,11 +13,19 @@ end
---@deprecated
function M.require_language(lang, path, silent, symbol_name)
return M.add(lang, {
local opts = {
silent = silent,
path = path,
symbol_name = symbol_name,
})
}
if silent then
local installed = pcall(M.add, lang, opts)
return installed
end
M.add(lang, opts)
return true
end
---@class treesitter.RequireLangOpts
@ -38,20 +46,16 @@ end
--- Defaults to lang.
--- - path (string|nil) Optional path the parser is located at
--- - symbol_name (string|nil) Internal symbol name for the language to load
--- - silent (boolean|nil) Don't throw an error if language not found
---@return boolean If the specified language is installed
function M.add(lang, opts)
---@cast opts treesitter.RequireLangOpts
opts = opts or {}
local path = opts.path
local silent = opts.silent
local filetype = opts.filetype or lang
local symbol_name = opts.symbol_name
vim.validate({
lang = { lang, 'string' },
path = { path, 'string', true },
silent = { silent, 'boolean', true },
symbol_name = { symbol_name, 'string', true },
filetype = { filetype, { 'string', 'table' }, true },
})
@ -64,32 +68,18 @@ function M.add(lang, opts)
if path == nil then
if not (lang and lang:match('[%w_]+') == lang) then
if silent then
return false
end
error("'" .. lang .. "' is not a valid language name")
end
local fname = 'parser/' .. lang .. '.*'
local paths = a.nvim_get_runtime_file(fname, false)
if #paths == 0 then
if silent then
return false
end
error("no parser for '" .. lang .. "' language, see :help treesitter-parsers")
end
path = paths[1]
end
if silent then
if not pcall(vim._ts_add_language, path, lang, symbol_name) then
return false
end
else
vim._ts_add_language(path, lang, symbol_name)
end
return true
vim._ts_add_language(path, lang, symbol_name)
end
--- Register a lang to be used for a filetype (or list of filetypes).

View File

@ -184,7 +184,7 @@ function LanguageTree:parse()
local seen_langs = {} ---@type table<string,boolean>
for lang, injection_ranges in pairs(injections_by_lang) do
local has_lang = language.add(lang, { silent = true })
local has_lang = pcall(language.add, lang)
-- Child language trees should just be ignored if not found, since
-- they can depend on the text of a node. Intermediate strings

View File

@ -20,10 +20,9 @@ describe('treesitter language API', function()
matches("Failed to load parser for language 'borklang': uv_dlopen: .+",
pcall_err(exec_lua, "parser = vim.treesitter.add('borklang', { path = 'borkbork.so' })"))
-- Should not throw an error when silent
eq(false, exec_lua("return vim.treesitter.add('borklang', { silent = true })"))
eq(false, exec_lua("return pcall(vim.treesitter.add, 'borklang')"))
eq(false, exec_lua("return vim.treesitter.add('borklang', { path = 'borkbork.so', silent = true })"))
eq(false, exec_lua("return pcall(vim.treesitter.add, 'borklang', { path = 'borkbork.so' })"))
eq(".../language.lua:0: no parser for 'borklang' language, see :help treesitter-parsers",
pcall_err(exec_lua, "parser = vim.treesitter.inspect_language('borklang')"))