feat(tests)!: new infrastructure based on makefile

Problem: Not easy to run all checks and tests locally. Redundant CI
workflows.

Solution: Separate CI into two workflows:
 * lint: Lua files (stylua, luals), query files (valid captures,
   predicates, directives using tsqueryls), docs
   (SUPPORTED_LANGUAGES.md) -- does not need parser installation
 * tests: parsers (ABI compatibility), query files (tsqueryls on
   Linux/macOS; nvim on Windows), highlight and indent tests (separated
   for better readability) -- needs parser installation (but only once)

Switch to https://github.com/nvim-treesitter/highlight-assertions fork
with ABI 15 support.

Run all tests (on Linux and macOS) through `make` (`formatlua`,
`checklua`, `lintquery`, `formatquery`, `checkquery`, `docs`, `tests`),
which downloads and caches all necessary dependencies.

Remove `update-readme` workflow (replaced by lint job on PRs).
This commit is contained in:
Christian Clason 2025-04-29 19:40:18 +02:00
parent 4e906caca3
commit 53dccb3a77
19 changed files with 269 additions and 272 deletions

40
scripts/check-parsers.lua Executable file
View file

@ -0,0 +1,40 @@
#!/usr/bin/env -S nvim -l
vim.opt.runtimepath:append('.')
local configs = require('nvim-treesitter.parsers')
local parsers = #_G.arg > 0 and { unpack(_G.arg) }
or require('nvim-treesitter.config').installed_parsers()
local data = {} ---@type table[]
local errors = {} ---@type string[]
for _, lang in pairs(parsers) do
if configs[lang] and configs[lang].install_info then
local ok, info = pcall(vim.treesitter.language.inspect, lang)
if not ok then
errors[#errors + 1] = string.format('%s: %s', lang, info)
else
data[#data + 1] = { lang = lang, abi = info.abi_version, state_count = info.state_count }
end
end
end
if #errors > 0 then
print('::group::Errors')
for _, err in ipairs(errors) do
print(err)
end
print('::endgroup::')
print('Check failed!\n')
vim.cmd.cq()
else
print('::group::State counts')
table.sort(data, function(a, b)
return a.state_count < b.state_count
end)
for i, val in ipairs(data) do
print(string.format('%i.\t%d\t%s (ABI %d)', #data - i + 1, val.state_count, val.lang, val.abi))
end
print('::endgroup::')
print('Check successful!')
end

View file

@ -6,29 +6,6 @@ local configs = require('nvim-treesitter.parsers')
local parsers = #_G.arg > 0 and { unpack(_G.arg) }
or require('nvim-treesitter.config').installed_parsers()
-- Extract captures from documentation for validation
local captures = {} ---@type table[]
do
local current_query ---@type string
for line in io.lines('CONTRIBUTING.md') do
if vim.startswith(line, '### ') then
current_query = line:sub(5):lower() ---@type string
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), ' ')[1])
end
end
-- Complete captures for injections.
for lang, _ in pairs(configs) do
table.insert(captures['injections'], lang)
end
end
-- Check queries for each installed parser in parsers
local errors = {} ---@type string[]
local timings = {} ---@type { duration: number, lang: string, query_type: string }[]
@ -46,19 +23,6 @@ do
print(string.format('Checking %s %s (%.02fms)', lang, query_type, duration * 1e-6))
if not ok then
errors[#errors + 1] = string.format('%s (%s): %s', lang, query_type, query)
else
if query then
for _, capture in ipairs(query.captures) do
local is_valid = (
vim.startswith(capture, '_') -- Helpers.
or vim.list_contains(captures[query_type], capture)
)
if not is_valid then
errors[#errors + 1] =
string.format('%s (%s): invalid capture "@%s"', lang, query_type, capture)
end
end
end
end
end
end

View file

@ -10,19 +10,12 @@ if [[ $os == Linux ]]; then
tar -zxf nvim-linux-x86_64.tar.gz
sudo ln -s "$PWD"/nvim-linux-x86_64/bin/nvim /usr/local/bin
rm -rf "$PWD"/nvim-linu-x86_x64/lib/nvim/parser
mkdir -p ~/.local/share/nvim/site/pack/nvim-treesitter/start
ln -s "$PWD" ~/.local/share/nvim/site/pack/nvim-treesitter/start
elif [[ $os == Darwin ]]; then
RELEASE_NAME="nvim-macos-$(uname -m)"
curl -L "https://github.com/neovim/neovim/releases/download/${NVIM_TAG}/$RELEASE_NAME.tar.gz" | tar -xz
sudo ln -s "$PWD/$RELEASE_NAME/bin/nvim" /usr/local/bin
rm -rf "$PWD/$RELEASE_NAME/lib/nvim/parser"
mkdir -p ~/.local/share/nvim/site/pack/nvim-treesitter/start
ln -s "$PWD" ~/.local/share/nvim/site/pack/nvim-treesitter/start
else
curl -L "https://github.com/neovim/neovim/releases/download/${NVIM_TAG}/nvim-win64.zip" -o nvim-win64.zip
unzip nvim-win64
mkdir -p ~/AppData/Local/nvim/pack/nvim-treesitter/start
mkdir -p ~/AppData/Local/nvim-data
cp -r "$PWD" ~/AppData/Local/nvim/pack/nvim-treesitter/start
fi

View file

@ -1,3 +1,4 @@
vim.opt.runtimepath:append(os.getenv('PLENARY'))
vim.opt.runtimepath:append('.')
vim.cmd.runtime({ 'plugin/plenary.vim', bang = true })
vim.cmd.runtime({ 'plugin/query_predicates.lua', bang = true })

View file

@ -1,16 +0,0 @@
#!/usr/bin/env bash
HERE="$(dirname "$(realpath "${BASH_SOURCE[0]}")")"
cd $HERE/..
run() {
nvim --headless --noplugin -u scripts/minimal_init.lua \
-c "PlenaryBustedDirectory $1 { minimal_init = './scripts/minimal_init.lua' }"
}
if [[ $2 = '--summary' ]]; then
## really simple results summary by filtering plenary busted output
run tests/$1 2> /dev/null | grep -E '^\S*(Testing|Success|Failed|Errors)\s*:'
else
run tests/$1
fi