mirror of
https://github.com/neovim/neovim
synced 2025-07-16 01:01:49 +00:00
The following top level Treesitter functions have been moved: - vim.treesitter.inspect_language() -> vim.treesitter.language.inspect() - vim.treesitter.get_query_files() -> vim.treesitter.query.get_files() - vim.treesitter.set_query() -> vim.treesitter.query.set() - vim.treesitter.query.set_query() -> vim.treesitter.query.set() - vim.treesitter.get_query() -> vim.treesitter.query.get() - vim.treesitter.query.get_query() -> vim.treesitter.query.get() - vim.treesitter.parse_query() -> vim.treesitter.query.parse() - vim.treesitter.query.parse_query() -> vim.treesitter.query.parse() - vim.treesitter.add_predicate() -> vim.treesitter.query.add_predicate() - vim.treesitter.add_directive() -> vim.treesitter.query.add_directive() - vim.treesitter.list_predicates() -> vim.treesitter.query.list_predicates() - vim.treesitter.list_directives() -> vim.treesitter.query.list_directives() - vim.treesitter.query.get_range() -> vim.treesitter.get_range() - vim.treesitter.query.get_node_text() -> vim.treesitter.get_node_text()
131 lines
3.3 KiB
Lua
131 lines
3.3 KiB
Lua
local a = vim.api
|
|
|
|
---@class TSLanguageModule
|
|
local M = {}
|
|
|
|
---@type table<string,string>
|
|
local ft_to_lang = {}
|
|
|
|
---@param filetype string
|
|
---@return string|nil
|
|
function M.get_lang(filetype)
|
|
return ft_to_lang[filetype]
|
|
end
|
|
|
|
---@deprecated
|
|
function M.require_language(lang, path, silent, symbol_name)
|
|
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
|
|
---@field path? string
|
|
---@field silent? boolean
|
|
---@field filetype? string|string[]
|
|
---@field symbol_name? string
|
|
|
|
--- Asserts that a parser for the language {lang} is installed.
|
|
---
|
|
--- Parsers are searched in the `parser` runtime directory, or the provided {path}
|
|
---
|
|
---@param lang string Language the parser should parse (alphanumerical and `_` only)
|
|
---@param opts (table|nil) Options:
|
|
--- - filetype (string|string[]) Filetype(s) that lang can be parsed with.
|
|
--- Note this is not strictly the same as lang since a single lang can
|
|
--- parse multiple filetypes.
|
|
--- 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
|
|
function M.add(lang, opts)
|
|
---@cast opts treesitter.RequireLangOpts
|
|
opts = opts or {}
|
|
local path = opts.path
|
|
local filetype = opts.filetype or lang
|
|
local symbol_name = opts.symbol_name
|
|
|
|
vim.validate({
|
|
lang = { lang, 'string' },
|
|
path = { path, 'string', true },
|
|
symbol_name = { symbol_name, 'string', true },
|
|
filetype = { filetype, { 'string', 'table' }, true },
|
|
})
|
|
|
|
M.register(lang, filetype or lang)
|
|
|
|
if vim._ts_has_language(lang) then
|
|
return
|
|
end
|
|
|
|
if path == nil then
|
|
if not (lang and lang:match('[%w_]+') == lang) then
|
|
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
|
|
error("no parser for '" .. lang .. "' language, see :help treesitter-parsers")
|
|
end
|
|
path = paths[1]
|
|
end
|
|
|
|
vim._ts_add_language(path, lang, symbol_name)
|
|
end
|
|
|
|
--- Register a lang to be used for a filetype (or list of filetypes).
|
|
---@param lang string Language to register
|
|
---@param filetype string|string[] Filetype(s) to associate with lang
|
|
function M.register(lang, filetype)
|
|
vim.validate({
|
|
lang = { lang, 'string' },
|
|
filetype = { filetype, { 'string', 'table' } },
|
|
})
|
|
|
|
local filetypes ---@type string[]
|
|
if type(filetype) == 'string' then
|
|
filetypes = { filetype }
|
|
else
|
|
filetypes = filetype
|
|
end
|
|
|
|
for _, f in ipairs(filetypes) do
|
|
if f ~= '' then
|
|
ft_to_lang[f] = lang
|
|
end
|
|
end
|
|
end
|
|
|
|
--- Inspects the provided language.
|
|
---
|
|
--- Inspecting provides some useful information on the language like node names, ...
|
|
---
|
|
---@param lang string Language
|
|
---@return table
|
|
function M.inspect(lang)
|
|
M.add(lang)
|
|
return vim._ts_inspect_language(lang)
|
|
end
|
|
|
|
---@deprecated
|
|
function M.inspect_language(...)
|
|
vim.deprecate(
|
|
'vim.treesitter.language.inspect_language()',
|
|
'vim.treesitter.language.inspect()',
|
|
'0.10'
|
|
)
|
|
return M.inspect(...)
|
|
end
|
|
|
|
return M
|