feat: improve completion source

## Details

Continue to provide completions once inside of square brackets and not
just when starting a list item or block quote.

Requires handling a generic `paragraph` node which is the type of the
body for both and handling different scenarios for the node. So as not
to provide bad completions do not return anything if the user is typing
outside of the start of the handled node types.

This does mean we no longer have suggestions before starting a marker,
meaning going to the next line in an existing list now returns nothing
as we do not know if you want to continue the list and handling this
behavior well is complicated.

In theory anytime the user goes to a new line outside of few contexts
they could start a new list or a block quote, so empty lines could
always be provided with completions, but IMO this is pretty bad
behavior. So as not to over-complicate things we now always require
intent from the user, meaning starting a list item (via `-`, `*`, or
`+`) or a block quote (via `>`) is what triggers completions, otherwise
do not provide completions.

Create unit tests for completions source to validate behavior.

Author: MeanderingProgrammer

CHANGELOG.md

@@ -7,6 +7,7 @@
 - enabled flag for link footnote [#362](https://github.com/MeanderingProgrammer/render-markdown.nvim/pull/362)
   [9721ffe](https://github.com/MeanderingProgrammer/render-markdown.nvim/commit/9721ffe230ec90e49c49ee33b5ca44c3fc689214)
 - blink.cmp source registration [b8d93e8](https://github.com/MeanderingProgrammer/render-markdown.nvim/commit/b8d93e83a02dadddc6a566b1f60dab87190c1296)
+  [62d6681](https://github.com/MeanderingProgrammer/render-markdown.nvim/commit/62d6681332365cfddbe916c888752834d9f7ad0c)
 
 ### Bug Fixes
 

doc/render-markdown.txt

@@ -1,4 +1,4 @@
-*render-markdown.txt*           For 0.10.0          Last change: 2025 March 19
+*render-markdown.txt*           For 0.10.0          Last change: 2025 March 22
 
 ==============================================================================
 Table of Contents                          *render-markdown-table-of-contents*

lua/render-markdown/health.lua

@@ -5,7 +5,7 @@ local state = require('render-markdown.state')
 local M = {}
 
 ---@private
-M.version = '8.1.6'
+M.version = '8.1.7'
 
 function M.check()
     M.start('version')

lua/render-markdown/integ/source.lua

@@ -3,10 +3,11 @@ local manager = require('render-markdown.manager')
 local state = require('render-markdown.state')
 local util = require('render-markdown.core.util')
 
-local list_markers = {
+local markers = {
     list_marker_minus = '-',
     list_marker_star = '*',
     list_marker_plus = '+',
+    block_quote_marker = '>',
 }
 
 ---@class render.md.Source
@@ -19,8 +20,7 @@ end
 
 ---@return string[]
 function M.trigger_characters()
-    local characters = vim.tbl_values(list_markers)
-    return vim.list_extend(characters, { '>', ' ' })
+    return vim.list_extend(vim.tbl_values(markers), { ' ', '[', '!', ']' })
 end
 
 ---@param buf integer 0 for current buffer
@@ -29,26 +29,35 @@ end
 ---@return lsp.CompletionItem[]?
 function M.items(buf, row, col)
     buf = buf == 0 and util.current('buf') or buf
-    local node = M.get_node(buf, row, col)
-    if node == nil then
+    local node = M.node(buf, row, col)
+    if node == nil or node:range() ~= row then
         return nil
     end
-    local result, config = {}, state.get(buf)
+
+    local marker_node = node:named_child(0)
+    if marker_node == nil then
+        return nil
+    end
+
+    local marker = vim.treesitter.get_node_text(marker_node, buf)
+    local text = vim.treesitter.get_node_text(node, buf)
+    if M.ignore(marker, text:gsub('\n$', '')) then
+        return nil
+    end
+
+    local result = {}
+    local config = state.get(buf)
+    local prefix = Str.spaces('end', marker) == 0 and ' ' or ''
     if node:type() == 'block_quote' then
-        local quote_row = node:range()
-        if quote_row == row then
-            local prefix = M.space_prefix(buf, node)
-            for _, component in pairs(config.callout) do
-                table.insert(result, M.item(prefix .. component.raw, component.rendered, nil))
-            end
+        for _, component in pairs(config.callout) do
+            table.insert(result, M.item(prefix, component.raw, component.rendered, nil))
         end
     elseif node:type() == 'list_item' then
         local checkbox = config.checkbox
-        local prefix = M.list_prefix(buf, row, node)
-        table.insert(result, M.item(prefix .. '[ ] ', checkbox.unchecked.icon, 'unchecked'))
-        table.insert(result, M.item(prefix .. '[x] ', checkbox.checked.icon, 'checked'))
+        table.insert(result, M.item(prefix, '[ ] ', checkbox.unchecked.icon, 'unchecked'))
+        table.insert(result, M.item(prefix, '[x] ', checkbox.checked.icon, 'checked'))
         for name, component in pairs(checkbox.custom) do
-            table.insert(result, M.item(prefix .. component.raw .. ' ', component.rendered, name))
+            table.insert(result, M.item(prefix, component.raw .. ' ', component.rendered, name))
         end
     end
     return result
@@ -59,7 +68,7 @@ end
 ---@param row integer
 ---@param col integer
 ---@return TSNode?
-function M.get_node(buf, row, col)
+function M.node(buf, row, col)
     -- Parse current row to get up to date node
     local has_parser, parser = pcall(vim.treesitter.get_parser, buf)
     if not has_parser or parser == nil then
@@ -72,55 +81,53 @@ function M.get_node(buf, row, col)
         lang = 'markdown',
         pos = { row, col },
     })
-    local children = vim.tbl_keys(list_markers)
-    vim.list_extend(children, { 'block_quote_marker', 'block_continuation' })
+    if node ~= nil and node:type() == 'paragraph' then
+        node = node:prev_sibling()
+    end
+    local children = vim.list_extend(vim.tbl_keys(markers), { 'block_continuation' })
     if node ~= nil and vim.tbl_contains(children, node:type()) then
         node = node:parent()
     end
     return node
 end
 
 ---@private
----@param buf integer
----@param row integer
----@param node TSNode
----@return string
-function M.list_prefix(buf, row, node)
-    local marker_node = node:named_child(0)
-    if marker_node == nil then
-        return ''
-    end
-    local marker_row = marker_node:range()
-    if marker_row == row then
-        return M.space_prefix(buf, marker_node)
+---@param marker string
+---@param text string
+---@return boolean
+function M.ignore(marker, text)
+    local prefix = vim.pesc(vim.trim(marker)) .. '%s+'
+    local patterns = {
+        -- The first non-space after the marker is not '['
+        prefix .. '[^%[]',
+        -- After '[' there is another '[' or a space
+        prefix .. '%[.*[%[%s]',
+        -- There is already text enclosed by '[' ']'
+        prefix .. '%[.*%]',
+    }
+    for _, pattern in ipairs(patterns) do
+        if text:find(pattern) ~= nil then
+            return true
+        end
     end
-    local marker = list_markers[marker_node:type()]
-    return marker ~= nil and marker .. ' ' or ''
+    return false
 end
 
 ---@private
----@param buf integer
----@param node TSNode
----@return string
-function M.space_prefix(buf, node)
-    local text = vim.treesitter.get_node_text(node, buf)
-    return Str.spaces('end', text) == 0 and ' ' or ''
-end
-
----@private
----@param raw string
----@param rendered string
----@param name? string
+---@param prefix string
+---@param label string
+---@param detail string
+---@param description? string
 ---@return lsp.CompletionItem
-function M.item(raw, rendered, name)
+function M.item(prefix, label, detail, description)
     ---@type lsp.CompletionItem
     return {
-        label = raw,
+        kind = 12,
+        label = prefix .. label,
         labelDetails = {
-            detail = rendered,
-            description = name,
+            detail = detail,
+            description = description,
         },
-        kind = 12,
     }
 end
 

tests/comp_spec.lua

@@ -0,0 +1,105 @@
+---@module 'luassert'
+
+local util = require('tests.util')
+
+---@param row integer
+---@param col integer
+---@param expected lsp.CompletionItem[]
+local function assert_items(row, col, expected)
+    local source = require('render-markdown.integ.source')
+    local actual = source.items(0, row, col) or {}
+    table.sort(actual, function(a, b)
+        return a.label < b.label
+    end)
+    assert.are.same(expected, actual)
+end
+
+---@param prefix string
+---@param label string
+---@param detail string
+---@param description? string
+---@return lsp.CompletionItem
+local function item(prefix, label, detail, description)
+    ---@type lsp.CompletionItem
+    return {
+        kind = 12,
+        label = prefix .. label,
+        labelDetails = {
+            detail = detail,
+            description = description,
+        },
+    }
+end
+
+describe('comp.md', function()
+    it('checkbox', function()
+        util.setup('tests/data/comp.md')
+
+        ---@param prefix string
+        ---@return lsp.CompletionItem[]
+        local function items(prefix)
+            return {
+                item(prefix, '[ ] ', '󰄱 ', 'unchecked'),
+                item(prefix, '[-] ', '󰥔 ', 'todo'),
+                item(prefix, '[x] ', '󰱒 ', 'checked'),
+            }
+        end
+
+        assert_items(2, 1, items(' '))
+        assert_items(4, 2, items(''))
+        assert_items(6, 3, items(''))
+        assert_items(8, 4, items(''))
+        assert_items(10, 5, {})
+        assert_items(12, 6, {})
+        assert_items(14, 10, {})
+        assert_items(16, 6, {})
+        assert_items(17, 0, {})
+    end)
+
+    it('callout', function()
+        util.setup('tests/data/comp.md')
+
+        ---@param prefix string
+        ---@return lsp.CompletionItem[]
+        local function items(prefix)
+            return {
+                item(prefix, '[!ABSTRACT]', '󰨸 Abstract'),
+                item(prefix, '[!ATTENTION]', '󰀪 Attention'),
+                item(prefix, '[!BUG]', '󰨰 Bug'),
+                item(prefix, '[!CAUTION]', '󰳦 Caution'),
+                item(prefix, '[!CHECK]', '󰄬 Check'),
+                item(prefix, '[!CITE]', '󱆨 Cite'),
+                item(prefix, '[!DANGER]', '󱐌 Danger'),
+                item(prefix, '[!DONE]', '󰄬 Done'),
+                item(prefix, '[!ERROR]', '󱐌 Error'),
+                item(prefix, '[!EXAMPLE]', '󰉹 Example'),
+                item(prefix, '[!FAILURE]', '󰅖 Failure'),
+                item(prefix, '[!FAIL]', '󰅖 Fail'),
+                item(prefix, '[!FAQ]', '󰘥 Faq'),
+                item(prefix, '[!HELP]', '󰘥 Help'),
+                item(prefix, '[!HINT]', '󰌶 Hint'),
+                item(prefix, '[!IMPORTANT]', '󰅾 Important'),
+                item(prefix, '[!INFO]', '󰋽 Info'),
+                item(prefix, '[!MISSING]', '󰅖 Missing'),
+                item(prefix, '[!NOTE]', '󰋽 Note'),
+                item(prefix, '[!QUESTION]', '󰘥 Question'),
+                item(prefix, '[!QUOTE]', '󱆨 Quote'),
+                item(prefix, '[!SUCCESS]', '󰄬 Success'),
+                item(prefix, '[!SUMMARY]', '󰨸 Summary'),
+                item(prefix, '[!TIP]', '󰌶 Tip'),
+                item(prefix, '[!TLDR]', '󰨸 Tldr'),
+                item(prefix, '[!TODO]', '󰗡 Todo'),
+                item(prefix, '[!WARNING]', '󰀪 Warning'),
+            }
+        end
+
+        assert_items(20, 1, items(' '))
+        assert_items(22, 2, items(''))
+        assert_items(24, 3, items(''))
+        assert_items(26, 4, items(''))
+        assert_items(28, 7, items(''))
+        assert_items(30, 8, {})
+        assert_items(32, 15, {})
+        assert_items(34, 6, {})
+    end)
+end)

tests/data/comp.md

@@ -0,0 +1,35 @@
+# Heading
+
+-
+
+- 
+
+- [
+
+- [-
+
+- [-]
+
+- [-] 
+
+- [-] todo
+
+- text
+
+# Heading
+
+>
+
+> 
+
+> [
+
+> [!
+
+> [!TIP
+
+> [!TIP]
+
+> [!TIP] My Tip
+
+> text