chore(refactor): update order that nodes are processed in

## Details

Previously we used the `LanguageTree:for_each_tree` API to iterate over
and generate decorations for each language root (for supported
languages), with a special case to handle `markdown` after the others.

This works for the most part but I have some ideas on the back-burner
that could benefit from generalizing this approach a little more as well
as providing additional information to the various decoration providers.

So now in the `for_each_tree` callback we store a language to `TSNode[]`
map for "valid" nodes. After that we sort the set of languages in the
order of: other, latex, markdown. Note: currently latex being after
other is not necessary, while markdown MUST be last.

Then we process all the nodes within each language, before moving on to
the others, so there is no longer any interleaving when it comes to the
language nodes are associated with. The processing after this is
essentially identical to before.

The main difference is we now also provide whether this is the last node
for this particular language. Note: last is in the context of the
current render cycle, not necessarily the last node in the document. With
this information we can do clever things like storing all the nodes in a
list and only generating decorations once we reach the last node. For
example this would allow us to process all `latex` nodes in one batch
and we could take advantage of `async` tasks to really speed things up.

Unrelated schema validation changes:

- update `map` class definition
- rename `Fields` -> `Record`

Author: MeanderingProgrammer

CHANGELOG.md

@@ -16,8 +16,6 @@
   [b7dad79](https://github.com/MeanderingProgrammer/render-markdown.nvim/commit/b7dad793f4750b7e95884c0db374b917898a979b)
 - allow nested markdown to be skipped [#510](https://github.com/MeanderingProgrammer/render-markdown.nvim/issues/510)
   [c203eae](https://github.com/MeanderingProgrammer/render-markdown.nvim/commit/c203eae127bd3397985408038f4d74fc952532e2)
-- scope and autolink highlights conflict [#518](https://github.com/MeanderingProgrammer/render-markdown.nvim/issues/518)
-  [7fd9116](https://github.com/MeanderingProgrammer/render-markdown.nvim/commit/7fd911692e5bc705c5487ae1c390d0b6d9738d87)
 
 ### Bug Fixes
 
@@ -27,6 +25,8 @@
 - use display width for latex formula alignment [c4ff9ac](https://github.com/MeanderingProgrammer/render-markdown.nvim/commit/c4ff9acddcf0f79b3187393319adb5cac5865bd3)
 - anti-conceal ignore modes [8074a9c](https://github.com/MeanderingProgrammer/render-markdown.nvim/commit/8074a9cc9a6f737320b7a0d76b2c4c3485155688)
 - component level render modes [84d4928](https://github.com/MeanderingProgrammer/render-markdown.nvim/commit/84d4928cb4b508847294002835989880da4ce13b)
+- scope and autolink highlights conflict [#518](https://github.com/MeanderingProgrammer/render-markdown.nvim/issues/518)
+  [7fd9116](https://github.com/MeanderingProgrammer/render-markdown.nvim/commit/7fd911692e5bc705c5487ae1c390d0b6d9738d87)
 
 ### Collaborator Shoutouts
 

doc/custom-handlers.md

@@ -19,6 +19,7 @@ Each handler must conform to the following interface:
 ---@class (exact) render.md.handler.Context
 ---@field buf integer
 ---@field root TSNode
+---@field last boolean
 
 ---@class (exact) render.md.Mark
 ---@field modes? render.md.Modes
@@ -48,6 +49,7 @@ The `parse` function takes a `ctx` parameter whose fields are:
 
 - `buf`: The buffer containing the root node
 - `root`: The root treesitter node for the specified language
+- `last`: Whether this is the last treesitter root for the specified language
 
 The `extends` parameter defines whether the builtin handler should still be run in
 conjunction with this one. Defaults to `false`.

lua/render-markdown/config/anti_conceal.lua

@@ -77,7 +77,7 @@ function M.schema()
             disabled_modes = modes,
             above = { type = 'number' },
             below = { type = 'number' },
-            ignore = { map = { key = { enum = Element }, value = modes } },
+            ignore = { map = { { enum = Element }, modes } },
         },
     }
 end

lua/render-markdown/config/base.lua

@@ -7,18 +7,18 @@
 ---@class render.md.base.Cfg
 local M = {}
 
----@param additional_fields render.md.schema.Fields
+---@param child render.md.schema.Record
 ---@return render.md.Schema
-function M.schema(additional_fields)
-    ---@type render.md.schema.Fields
-    local fields = {
+function M.schema(child)
+    ---@type render.md.schema.Record
+    local parent = {
         enabled = { type = 'boolean' },
         render_modes = {
             union = { { list = { type = 'string' } }, { type = 'boolean' } },
         },
     }
     ---@type render.md.Schema
-    return { record = vim.tbl_deep_extend('error', fields, additional_fields) }
+    return { record = vim.tbl_deep_extend('error', parent, child) }
 end
 
 return M

lua/render-markdown/config/callout.lua

@@ -64,7 +64,7 @@ function M.schema()
         },
     }
     ---@type render.md.Schema
-    return { map = { key = { type = 'string' }, value = callout } }
+    return { map = { { type = 'string' }, callout } }
 end
 
 return M

lua/render-markdown/config/checkbox.lua

@@ -85,7 +85,7 @@ function M.schema()
         right_pad = { type = 'number' },
         unchecked = component,
         checked = component,
-        custom = { map = { key = { type = 'string' }, value = custom } },
+        custom = { map = { { type = 'string' }, custom } },
     })
 end
 

lua/render-markdown/config/handlers.lua

@@ -5,6 +5,7 @@
 ---@class (exact) render.md.handler.Context
 ---@field buf integer
 ---@field root TSNode
+---@field last boolean
 
 ---@class render.md.handlers.Cfg
 local M = {}
@@ -25,7 +26,7 @@ function M.schema()
         },
     }
     ---@type render.md.Schema
-    return { map = { key = { type = 'string' }, value = handler } }
+    return { map = { { type = 'string' }, handler } }
 end
 
 return M

lua/render-markdown/config/heading.lua

@@ -182,7 +182,7 @@ function M.schema()
         below = { type = 'string' },
         backgrounds = { list = { type = 'string' } },
         foregrounds = { list = { type = 'string' } },
-        custom = { map = { key = { type = 'string' }, value = custom } },
+        custom = { map = { { type = 'string' }, custom } },
     })
 end
 

lua/render-markdown/config/html.lua

@@ -52,7 +52,7 @@ function M.schema()
                 highlight = { type = 'string' },
             },
         },
-        tag = { map = { key = { type = 'string' }, value = tag } },
+        tag = { map = { { type = 'string' }, tag } },
     })
 end
 

lua/render-markdown/config/injections.lua

@@ -34,7 +34,7 @@ function M.schema()
         },
     }
     ---@type render.md.Schema
-    return { map = { key = { type = 'string' }, value = injection } }
+    return { map = { { type = 'string' }, injection } }
 end
 
 return M