1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
|
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
|
