Update docs, improve types in unit test, remove usage of plenary async tests

Author: MeanderingProgrammer

CHANGELOG.md

@@ -54,6 +54,9 @@
 - Code highlight border with notermguicolors [#77](https://github.com/MeanderingProgrammer/markdown.nvim/issues/77)
   [#81](https://github.com/MeanderingProgrammer/markdown.nvim/pull/81)
 - Hide cursor row in active buffer only [56d92af](https://github.com/MeanderingProgrammer/markdown.nvim/commit/56d92af432141346f2d414213726f7a45e82b2b3)
+- Remove gifs from repo, fix concel on window change [51eec4e](https://github.com/MeanderingProgrammer/markdown.nvim/commit/51eec4e4cab69faf7e37c183d23df6b9614952db)
+- Wrap get_parser in pcall [#101](https://github.com/MeanderingProgrammer/markdown.nvim/issues/101)
+  [ddb4547](https://github.com/MeanderingProgrammer/markdown.nvim/commit/ddb454792dd85c0f6039ec14006aecaee67e782d)
 
 ### Collaborator Shoutouts
 

doc/limitations.md

@@ -6,6 +6,36 @@
 
 `LaTeX` formula evaluations are placed above text rather than overlayed.
 
+A way around this is to use a separate plugin for `LaTeX` and disable that feature
+in this plugin.
+
+As an example you can use [latex.nvim](https://github.com/ryleelyman/latex.nvim):
+
+```lua
+{
+    'ryleelyman/latex.nvim',
+    config = function()
+        require('latex').setup({})
+    end,
+}
+```
+
+Then disable `LaTeX` from this plugin:
+
+```lua
+require('render-markdown').setup({
+    latex = { enabled = false },
+    win_options = {
+        conceallevel = { rendered = 2 },
+    },
+})
+```
+
+> [!NOTE]
+>
+> These plugins can rely on a specific `conceallevel` to work properly, which
+> you will need to configure in this plugin like in the example above.
+
 ## Does Not Run in Telescope Preview
 
 [ISSUE #98](https://github.com/MeanderingProgrammer/markdown.nvim/issues/98)

tests/box_dash_quote_spec.lua

@@ -1,8 +1,8 @@
-local async_tests = require('plenary.async.tests')
+---@module 'luassert'
 local util = require('tests.util')
 
-async_tests.describe('box_dash_quote.md', function()
-    async_tests.it('default', function()
+describe('box_dash_quote.md', function()
+    it('default', function()
         util.setup('demo/box_dash_quote.md')
 
         local expected = {}

tests/callout_spec.lua

@@ -1,4 +1,4 @@
-local async_tests = require('plenary.async.tests')
+---@module 'luassert'
 local util = require('tests.util')
 
 ---@param row integer
@@ -8,6 +8,7 @@ local util = require('tests.util')
 ---@param highlight string
 ---@return render.md.MarkInfo
 local function callout(row, start_col, end_col, text, highlight)
+    ---@type render.md.MarkInfo
     return {
         row = { row, row },
         col = { start_col, end_col },
@@ -16,8 +17,8 @@ local function callout(row, start_col, end_col, text, highlight)
     }
 end
 
-async_tests.describe('callout.md', function()
-    async_tests.it('default', function()
+describe('callout.md', function()
+    it('default', function()
         util.setup('demo/callout.md')
 
         local info = 'Info'

tests/custom_handler_spec.lua

@@ -1,6 +1,9 @@
-local async_tests = require('plenary.async.tests')
+---@module 'luassert'
 local util = require('tests.util')
 
+---@param namespace integer
+---@param root TSNode
+---@param buf integer
 local function render_conceal_escape(namespace, root, buf)
     local query = vim.treesitter.query.parse('markdown_inline', '(backslash_escape) @escape')
     for _, node in query:iter_captures(root, buf) do
@@ -13,12 +16,16 @@ local function render_conceal_escape(namespace, root, buf)
     end
 end
 
+---@param root TSNode
+---@param buf integer
+---@return render.md.Mark[]
 local function parse_conceal_escape(root, buf)
-    local query = vim.treesitter.query.parse('markdown_inline', '(backslash_escape) @escape')
     local marks = {}
+    local query = vim.treesitter.query.parse('markdown_inline', '(backslash_escape) @escape')
     for _, node in query:iter_captures(root, buf) do
         local start_row, start_col, end_row, _ = node:range()
-        table.insert(marks, {
+        ---@type render.md.Mark
+        local mark = {
             conceal = true,
             start_row = start_row,
             start_col = start_col,
@@ -27,7 +34,8 @@ local function parse_conceal_escape(root, buf)
                 end_col = start_col + 1,
                 conceal = '',
             },
-        })
+        }
+        table.insert(marks, mark)
     end
     return marks
 end
@@ -36,15 +44,16 @@ end
 ---@param col integer
 ---@return render.md.MarkInfo
 local function backslash(row, col)
+    ---@type render.md.MarkInfo
     return {
         row = { row, row },
         col = { col, col + 1 },
         conceal = '',
     }
 end
 
-async_tests.describe('custom_handler.md', function()
-    async_tests.it('default', function()
+describe('custom_handler.md', function()
+    it('default', function()
         util.setup('tests/data/custom_handler.md')
 
         local expected = {}
@@ -57,7 +66,7 @@ async_tests.describe('custom_handler.md', function()
         util.marks_are_equal(expected, actual)
     end)
 
-    async_tests.it('custom override deprecated render', function()
+    it('custom override deprecated render', function()
         util.setup('tests/data/custom_handler.md', {
             custom_handlers = {
                 ---@diagnostic disable-next-line: missing-fields
@@ -79,7 +88,7 @@ async_tests.describe('custom_handler.md', function()
         util.marks_are_equal(expected, actual)
     end)
 
-    async_tests.it('custom override parse', function()
+    it('custom override parse', function()
         util.setup('tests/data/custom_handler.md', {
             custom_handlers = {
                 markdown_inline = {
@@ -100,7 +109,7 @@ async_tests.describe('custom_handler.md', function()
         util.marks_are_equal(expected, actual)
     end)
 
-    async_tests.it('custom extends', function()
+    it('custom extends', function()
         util.setup('tests/data/custom_handler.md', {
             custom_handlers = {
                 markdown_inline = {

tests/ft_override_spec.lua

@@ -1,8 +1,8 @@
-local async_tests = require('plenary.async.tests')
+---@module 'luassert'
 local util = require('tests.util')
 
-async_tests.describe('ft_override.md', function()
-    async_tests.it('default', function()
+describe('ft_override.md', function()
+    it('default', function()
         util.setup('tests/data/ft_override.md')
 
         local actual = util.get_actual_marks()

tests/heading_code_spec.lua

@@ -1,8 +1,8 @@
-local async_tests = require('plenary.async.tests')
+---@module 'luassert'
 local util = require('tests.util')
 
-async_tests.describe('heading_code.md', function()
-    async_tests.it('default', function()
+describe('heading_code.md', function()
+    it('default', function()
         util.setup('demo/heading_code.md')
 
         local expected = {}

tests/latex_spec.lua

@@ -1,7 +1,6 @@
-local async_tests = require('plenary.async.tests')
+---@module 'luassert'
 local stub = require('luassert.stub')
 local util = require('tests.util')
-
 local eq = assert.are.same
 
 ---@param start_row integer
@@ -22,8 +21,8 @@ local function latex(start_row, end_row, start_col, end_col, lines)
     }
 end
 
-async_tests.describe('latex.md', function()
-    async_tests.it('default', function()
+describe('latex.md', function()
+    it('default', function()
         stub.new(vim.fn, 'executable', function(expr)
             eq('latex2text', expr)
             return 1

tests/list_table_spec.lua

@@ -1,8 +1,8 @@
-local async_tests = require('plenary.async.tests')
+---@module 'luassert'
 local util = require('tests.util')
 
-async_tests.describe('list_table.md', function()
-    async_tests.it('default', function()
+describe('list_table.md', function()
+    it('default', function()
         util.setup('demo/list_table.md')
 
         local expected = {}

tests/state_spec.lua

@@ -1,7 +1,5 @@
 ---@module 'luassert'
-
 local util = require('tests.util')
-
 local eq = assert.are.same
 
 describe('state', function()