mirror of
https://github.com/nvim-treesitter/nvim-treesitter
synced 2024-09-16 14:34:05 +02:00
99ddf57353
Problem: Allowing undocumented "secret" (sub)captures makes it harder to write comprehensive colorschemes and catch inconsistent captures. Solution: Only allow captures listed in CONTRIBUTING.md. Add useful (cross-language) subcaptures and drop language-specific or too niche ones. Follow-up: Adding further `*.builtin` captures and changing queries to use them. Language-specific subcaptures should instead be added in user config or a custom language plugin.
123 lines
3.6 KiB
Lua
Executable file
123 lines
3.6 KiB
Lua
Executable file
#!/usr/bin/env -S nvim -l
|
|
vim.opt.rtp:prepend "./"
|
|
|
|
-- Equivalent to print(), but this will ensure consistent output regardless of
|
|
-- operating system.
|
|
local function io_print(text)
|
|
if not text then
|
|
text = ""
|
|
end
|
|
io.write(text, "\n")
|
|
end
|
|
|
|
local function extract_captures()
|
|
local lines = vim.fn.readfile "CONTRIBUTING.md"
|
|
local captures = {}
|
|
local current_query
|
|
|
|
for _, line in ipairs(lines) do
|
|
if vim.startswith(line, "### ") then
|
|
current_query = vim.fn.tolower(line:sub(5))
|
|
elseif vim.startswith(line, "@") and current_query then
|
|
if not captures[current_query] then
|
|
captures[current_query] = {}
|
|
end
|
|
|
|
table.insert(captures[current_query], vim.split(line:sub(2), " ", true)[1])
|
|
end
|
|
end
|
|
|
|
-- Complete captures for injections.
|
|
local parsers = vim.tbl_keys(require("nvim-treesitter.parsers").list)
|
|
for _, lang in pairs(parsers) do
|
|
table.insert(captures["injections"], lang)
|
|
end
|
|
|
|
return captures
|
|
end
|
|
|
|
local function do_check()
|
|
local timings = {}
|
|
local queries = require "nvim-treesitter.query"
|
|
local parsers = #_G.arg > 0 and { unpack(_G.arg) } or require("nvim-treesitter.info").installed_parsers()
|
|
local query_types = queries.built_in_query_groups
|
|
|
|
local captures = extract_captures()
|
|
local errors = {}
|
|
|
|
io_print "::group::Check parsers"
|
|
|
|
for _, lang in pairs(parsers) do
|
|
timings[lang] = {}
|
|
for _, query_type in pairs(query_types) do
|
|
local before = vim.loop.hrtime()
|
|
local ok, query = pcall(queries.get_query, lang, query_type)
|
|
local after = vim.loop.hrtime()
|
|
local duration = after - before
|
|
table.insert(timings, { duration = duration, lang = lang, query_type = query_type })
|
|
io_print("Checking " .. lang .. " " .. query_type .. string.format(" (%.02fms)", duration * 1e-6))
|
|
if not ok then
|
|
local err_msg = lang .. " (" .. query_type .. "): " .. query
|
|
errors[#errors + 1] = err_msg
|
|
else
|
|
if query then
|
|
for _, capture in ipairs(query.captures) do
|
|
local is_valid = (
|
|
vim.startswith(capture, "_") -- Helpers.
|
|
or vim.tbl_contains(captures[query_type], capture)
|
|
)
|
|
if not is_valid then
|
|
local error = string.format("(x) Invalid capture @%s in %s for %s.", capture, query_type, lang)
|
|
errors[#errors + 1] = error
|
|
end
|
|
end
|
|
end
|
|
end
|
|
end
|
|
end
|
|
|
|
io_print "::endgroup::"
|
|
|
|
if #errors > 0 then
|
|
io_print "\nCheck failed!\nErrors:"
|
|
for _, err in ipairs(errors) do
|
|
print(err)
|
|
end
|
|
error()
|
|
end
|
|
return timings
|
|
end
|
|
|
|
local ok, result = pcall(do_check)
|
|
local allowed_to_fail = vim.split(vim.env.ALLOWED_INSTALLATION_FAILURES or "", ",", true)
|
|
|
|
for k, v in pairs(require("nvim-treesitter.parsers").get_parser_configs()) do
|
|
if not require("nvim-treesitter.parsers").has_parser(k) then
|
|
-- On CI all parsers that can be installed from C files should be installed
|
|
if
|
|
vim.env.CI
|
|
and not v.install_info.requires_generate_from_grammar
|
|
and not vim.tbl_contains(allowed_to_fail, k)
|
|
then
|
|
io_print("Error: parser for " .. k .. " is not installed")
|
|
vim.cmd "cq"
|
|
else
|
|
io_print("Warning: parser for " .. k .. " is not installed")
|
|
end
|
|
end
|
|
end
|
|
|
|
if ok then
|
|
io_print "::group::Timings"
|
|
table.sort(result, function(a, b)
|
|
return a.duration < b.duration
|
|
end)
|
|
for i, val in ipairs(result) do
|
|
io_print(string.format("%i. %.02fms %s %s", #result - i + 1, val.duration * 1e-6, val.lang, val.query_type))
|
|
end
|
|
io_print "::endgroup::"
|
|
io_print "Check successful!"
|
|
vim.cmd "q"
|
|
else
|
|
vim.cmd "cq"
|
|
end
|