feat: add tree-sitter ABI version info to health check

MeanderingProgrammer · MeanderingProgrammer · commit 3d84dbc1f80a · 2025-08-07T13:23:29.000-07:00
diff --git a/doc/render-markdown.txt b/doc/render-markdown.txt
@@ -1,4 +1,4 @@
-*render-markdown.txt*       For NVIM v0.11.3       Last change: 2025 August 04
+*render-markdown.txt*       For NVIM v0.11.3       Last change: 2025 August 07
 
 ==============================================================================
 Table of Contents                          *render-markdown-table-of-contents*
diff --git a/lua/render-markdown/health.lua b/lua/render-markdown/health.lua
@@ -5,12 +5,13 @@ local state = require('render-markdown.state')
 local M = {}
 
 ---@private
-M.version = '8.6.11'
+M.version = '8.6.12'
 
 function M.check()
-    M.start('version')
-    vim.health.ok('plugin ' .. M.version)
+    M.start('versions')
     M.neovim('0.9', '0.11')
+    vim.health.ok('tree-sitter ABI: ' .. vim.treesitter.language_version)
+    vim.health.ok('plugin: ' .. M.version)
 
     M.start('configuration')
     local errors = state.validate()
@@ -25,17 +26,13 @@ function M.check()
     local latex = config.latex
     local html = config.html
 
-    M.start('treesitter')
-    M.parser('markdown', true)
-    M.highlights('markdown')
-    M.highlighter('markdown')
-    M.parser('markdown_inline', true)
-    M.highlights('markdown_inline')
+    M.ts_info('markdown', true, true)
+    M.ts_info('markdown_inline', true, false)
     if latex.enabled then
-        M.parser('latex', false)
+        M.ts_info('latex', false, false)
     end
     if html.enabled then
-        M.parser('html', false)
+        M.ts_info('html', false, false)
     end
 
     M.start('icons')
@@ -88,48 +85,59 @@ end
 ---@private
 ---@param language string
 ---@param required boolean
-function M.parser(language, required)
-    local ok, parser = pcall(vim.treesitter.get_parser, 0, language)
-    if ok and parser then
-        vim.health.ok(language .. ': parser installed')
+---@param active boolean
+function M.ts_info(language, required, active)
+    M.start('tree-sitter ' .. language)
+
+    local has_parser, parser = pcall(vim.treesitter.get_parser, 0, language)
+    if has_parser and parser then
+        vim.health.ok('parser: installed')
     else
-        local message = language .. ': parser not installed'
+        local message = 'parser: not installed'
         if not required then
             vim.health.warn(message, M.disable(language))
         else
             vim.health.error(message)
         end
     end
-end
 
----@private
----@param language string
-function M.highlights(language)
-    local files = vim.treesitter.query.get_files(language, 'highlights')
-    if #files > 0 then
-        for _, file in ipairs(files) do
-            local path = vim.fn.fnamemodify(file, ':~')
-            vim.health.ok(language .. ': highlights ' .. path)
-        end
+    local has_info, info = pcall(vim.treesitter.language.inspect, language)
+    if has_info and info then
+        vim.health.ok('ABI: ' .. info.abi_version)
     else
-        vim.health.error(language .. ': highlights missing')
+        local message = 'ABI: unknown'
+        if not required then
+            vim.health.warn(message, M.disable(language))
+        else
+            vim.health.error(message)
+        end
     end
-end
 
----@private
----@param language string
-function M.highlighter(language)
-    -- create a temporary buffer to check if vim.treesitter.start gets called
-    local buf = vim.api.nvim_create_buf(false, true)
-    vim.bo[buf].filetype = language
-    local ok = vim.treesitter.highlighter.active[buf] ~= nil
-    vim.api.nvim_buf_delete(buf, { force = true })
-    if ok then
-        vim.health.ok(language .. ': highlighter enabled')
-    else
-        vim.health.error(language .. ': highlighter not enabled', {
-            ('call vim.treesitter.start on %s buffers'):format(language),
-        })
+    if required then
+        local files = vim.treesitter.query.get_files(language, 'highlights')
+        if #files > 0 then
+            for _, file in ipairs(files) do
+                local path = vim.fn.fnamemodify(file, ':~')
+                vim.health.ok('highlights: ' .. path)
+            end
+        else
+            vim.health.error('highlights: unknown')
+        end
+    end
+
+    if active then
+        -- create a temporary buffer to check if vim.treesitter.start gets called
+        local buf = vim.api.nvim_create_buf(false, true)
+        vim.bo[buf].filetype = language
+        local ok = vim.treesitter.highlighter.active[buf] ~= nil
+        vim.api.nvim_buf_delete(buf, { force = true })
+        if ok then
+            vim.health.ok('highlighter: enabled')
+        else
+            vim.health.error('highlighter: not enabled', {
+                ('call vim.treesitter.start on %s buffers'):format(language),
+            })
+        end
     end
 end
 
diff --git a/scripts/generate.py b/scripts/generate.py
@@ -1,28 +1,20 @@
-import abc
 import argparse
 from dataclasses import dataclass
 from pathlib import Path
-from typing import override
+from typing import Protocol
 
 
-@dataclass(frozen=True)
-class Generator(abc.ABC):
-    @abc.abstractmethod
-    def name(self, size: str) -> str:
-        pass
+class Generator(Protocol):
+    def name(self, size: str) -> str: ...
 
-    @abc.abstractmethod
-    def create(self, n: int) -> list[list[str]]:
-        pass
+    def create(self, n: int) -> list[list[str]]: ...
 
 
 @dataclass(frozen=True)
-class Heading(Generator):
-    @override
+class Heading:
     def name(self, size: str) -> str:
         return f"{size}.md"
 
-    @override
     def create(self, n: int) -> list[list[str]]:
         sections: list[list[str]] = []
         for i in range(10 * n):
@@ -31,12 +23,10 @@ def create(self, n: int) -> list[list[str]]:
 
 
 @dataclass(frozen=True)
-class Table(Generator):
-    @override
+class Table:
     def name(self, size: str) -> str:
         return f"{size}-table.md"
 
-    @override
     def create(self, n: int) -> list[list[str]]:
         sections: list[list[str]] = []
         for i in range(n // 2):
@@ -46,19 +36,18 @@ def create(self, n: int) -> list[list[str]]:
 
     def table(self, n: int) -> list[str]:
         rows: list[str] = []
-        rows.append(f"| `Column 1`     | **Column 2**     | *Column 3*     |")
-        rows.append(f"| -------------- | :--------------- | -------------: |")
+        rows.append("| `Column 1`     | **Column 2**     | *Column 3*     |")
+        rows.append("| -------------- | :--------------- | -------------: |")
         for i in range(n):
             rows.append(f"| Row {i:<4} Col 1 | `Row {i:<4} Col 2` | Row {i:<4} Col 3 |")
         return rows
 
 
 def main(force: bool) -> None:
-    sizes: list[str] = ["small", "medium", "large"]
     generators: list[Generator] = [Heading(), Table()]
-    for i, size in enumerate(sizes):
-        n: int = 10 ** (i + 1)
-        for generator in generators:
+    sizes: dict[str, int] = dict(small=10, medium=100, large=1000)
+    for generator in generators:
+        for size, n in sizes.items():
             path = Path("temp").joinpath(generator.name(size))
             if not path.exists() or force:
                 sections = generator.create(n)
@@ -67,9 +56,7 @@ def main(force: bool) -> None:
 
 
 if __name__ == "__main__":
-    parser = argparse.ArgumentParser(
-        description="Generate sample data for benchmarking"
-    )
+    parser = argparse.ArgumentParser(description="Generate data for benchmarking")
     parser.add_argument("--force", action="store_true")
     args = parser.parse_args()
     main(args.force)
diff --git a/scripts/update.py b/scripts/update.py
@@ -2,12 +2,26 @@
 from dataclasses import dataclass, field
 from pathlib import Path
 from textwrap import indent
+from typing import Protocol
 
 import tree_sitter_lua
 import tree_sitter_markdown
 from tree_sitter import Language, Parser
 
 
+class LuaType(Protocol):
+    @property
+    def value(self) -> str: ...
+
+    def add(self, value: str) -> None: ...
+
+    def name(self) -> str: ...
+
+    def to_user(self) -> str | None: ...
+
+    def to_str(self) -> str: ...
+
+
 @dataclass(frozen=True)
 class LuaAlias:
     value: str
@@ -21,21 +35,17 @@ def name(self) -> str:
         return self.value.split()[1]
 
     def to_user(self) -> str | None:
-        if not self.config():
+        simple = self.name().split(".")[-1]
+        if simple != "Configs":
             return None
 
-        def user(s: str) -> str:
-            return s.replace(".Config", ".UserConfig")
-
-        lines: list[str] = [user(self.value)]
-        for s in self.options:
-            option = user(s)
-            lines.append(option)
+        lines: list[str] = []
+        values = [self.value] + self.options
+        for value in values:
+            value = value.replace(".Config", ".UserConfig")
+            lines.append(value)
         return "\n".join(lines)
 
-    def config(self) -> bool:
-        return self.name().split(".")[-1] == "Configs"
-
     def to_str(self) -> str:
         return "\n".join([self.value] + self.options)
 
@@ -55,27 +65,22 @@ def name(self) -> str:
         return self.value.split(":")[0].split()[-1]
 
     def to_user(self) -> str | None:
-        if not self.exact() or not self.config():
+        kind = self.value.split()[1]
+        simple = self.name().split(".")[-1]
+        if kind != "(exact)" or simple != "Config":
             return None
 
-        def user(s: str) -> str:
-            return s.replace(".Config", ".UserConfig")
-
-        lines: list[str] = [user(self.value)]
-        for s in self.fields:
-            field = user(s)
-            name = field.split()[1]
-            if not name.endswith("?"):
-                field = field.replace(f" {name} ", f" {name}? ")
-            lines.append(field)
+        lines: list[str] = []
+        values = [self.value] + self.fields
+        for i, value in enumerate(values):
+            value = value.replace(".Config", ".UserConfig")
+            if i > 0:
+                name = value.split()[1]
+                if not name.endswith("?"):
+                    value = value.replace(f" {name} ", f" {name}? ")
+            lines.append(value)
         return "\n".join(lines)
 
-    def exact(self) -> bool:
-        return self.value.split()[1] == "(exact)"
-
-    def config(self) -> bool:
-        return self.name().split(".")[-1] == "Config"
-
     def to_str(self) -> str:
         return "\n".join([self.value] + self.fields)
 
@@ -91,14 +96,14 @@ def update_types(root: Path) -> None:
     files: list[Path] = [root.joinpath("init.lua")]
     files.extend(sorted(root.joinpath("config").iterdir()))
 
-    classes: list[str] = ["---@meta"]
-    for definition in get_definitions(files):
-        user = definition.to_user()
+    sections: list[str] = ["---@meta"]
+    for lua_type in get_lua_types(files):
+        user = lua_type.to_user()
         if user is not None:
-            classes.append(user)
+            sections.append(user)
 
     types = root.joinpath("types.lua")
-    types.write_text("\n\n".join(classes) + "\n")
+    types.write_text("\n\n".join(sections) + "\n")
 
 
 def update_readme(root: Path) -> None:
@@ -148,7 +153,7 @@ def update_handlers(root: Path) -> None:
         root.joinpath("config/handlers.lua"),
         root.joinpath("lib/marks.lua"),
     ]
-    name_lua = {lua.name(): lua for lua in get_definitions(files)}
+    lua_types = {lua_type.name(): lua_type for lua_type in get_lua_types(files)}
     names = [
         "render.md.Handler",
         "render.md.handler.Context",
@@ -158,17 +163,17 @@ def update_handlers(root: Path) -> None:
         "render.md.mark.Text",
         "render.md.mark.Hl",
     ]
-    definitions = [name_lua[name] for name in names]
+    sections = [lua_types[name].to_str() for name in names]
 
     handlers = Path("doc/custom-handlers.md")
-    old = get_code_block(handlers, definitions[0].value, 1)
-    new = "\n".join([lua.to_str() + "\n" for lua in definitions])
+    old = get_code_block(handlers, names[0], 1)
+    new = "\n\n".join(sections) + "\n"
     text = handlers.read_text().replace(old, new)
     handlers.write_text(text)
 
 
-def get_definitions(files: list[Path]) -> list[LuaAlias | LuaClass]:
-    result: list[LuaAlias | LuaClass] = []
+def get_lua_types(files: list[Path]) -> list[LuaType]:
+    result: list[LuaType] = []
     for file in files:
         for comment in get_comments(file):
             # ---@class md.Init: md.Api        -> class
@@ -178,12 +183,12 @@ def get_definitions(files: list[Path]) -> list[LuaAlias | LuaClass]:
             # ---@type md.Config               -> type
             # ---@param opts? md.UserConfig    -> param
             # -- Inlined with 'image' elements -> --
-            annotation = comment.split()[0].split("@")[-1]
-            if annotation == "alias":
+            kind = comment.split()[0].split("@")[-1]
+            if kind == "alias":
                 result.append(LuaAlias(comment))
-            elif annotation == "class":
+            elif kind == "class":
                 result.append(LuaClass(comment))
-            elif annotation in ["field", "---|"]:
+            elif kind in ["field", "---|"]:
                 result[-1].add(comment)
     return result
 

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-render-markdown.txt For NVIM v0.11.3 Last change: 2025 August 04`
	`1`	`+render-markdown.txt For NVIM v0.11.3 Last change: 2025 August 07`
`2`	`2`
`3`	`3`	`==============================================================================`
`4`	`4`	`Table of Contents render-markdown-table-of-contents`