[mini.hipatterns] Better todo comments

[drowning-cat]

Related: #783

Features:

• Highlight only inside treesitter comments if a parser is available
• Support the following patterns for words (with/without surrounding spaces): NOTE, NOTE:, NOTE , NOTE:

Example

local MiniHipatterns = require("mini.hipatterns")
vim.api.nvim_create_autocmd({ "VimEnter", "ColorScheme" }, {
  group = vim.api.nvim_create_augroup("todo_highlight", { clear = true }),
  callback = function()
    local get = function(name)
      return vim.api.nvim_get_hl(0, { name = name, link = false })
    end
    local make = function(name, fg, bg)
      vim.api.nvim_set_hl(0, name, { bold = true, fg = fg, bg = bg })
    end
    make("UserHipatternsPerf", "black", get("Identifier").fg)
  end,
})
local hi_todo = function(words, hl_name)
  -- Examples: `NOTE` `NOTE:` ` NOTE ` ` NOTE:`
  local pattern = vim
    .iter(words)
    :map(function(word)
      return { "%f[%w]()" .. word .. "()%f[%W]", "() " .. word .. "[: ]()" }
    end)
    :flatten()
    :totable()
  return {
    pattern = pattern,
    group = function(b, _, m)
      -- NOTE: Highlight only inside treesitter comment nodes
      local parser = vim.treesitter.get_parser(b, nil, { error = false })
      if not parser then
        return hl_name
      end
      local node = parser:named_node_for_range({
        m.line - 1,
        m.from_col - 1,
        m.line - 1,
        m.to_col - 1,
      })
      if not node or node:type() == "comment_content" then
        return hl_name
      end
      return nil
    end,
  }
end
MiniHipatterns.setup({
  highlighters = {
    fix = hi_todo({ "FIX", "FIXME" }, "MiniHipatternsFixme"),
    note = hi_todo({ "NOTE" }, "MiniHipatternsNote"),
    todo = hi_todo({ "TODO", "FEAT" }, "MiniHipatternsTodo"),
    hack = hi_todo({ "HACK" }, "MiniHipatternsHack"),
    perf = hi_todo({ "PERF" }, "UserHipatternsPerf"),
  },
})

[echasnovski]

Thanks for sharing!

I'd maybe recommend using MiniHipatternsXxx highlight groups wherever possible for consistency.

I'd also add at least a small text description of what this does: can highlight not only a word itself but also including padding around it. This was considered when writing 'mini.hipatterns', but I don't really like how it looks a bit too much. But that's a personal taste.

[drowning-cat]

Indeed. If I recall correctly, I had a problem when enabling the listchars:trail symbol, as it somehow overrode MiniHipatternsXxx due to reverse option. After the update, it seems to work properly.

I will update the code and add more comments. To be honest, I didn’t find #783 right away, so I apologize for the duplicate.

[drowning-cat]

Oh, I remember now. It was actually the opposite. For some reason, MiniHipatternsXxx highlights work fine, but custom highlights do not behave as expected:

More info

vim.env.LAZY_STDPATH = ".repro"
load(vim.fn.system("curl -s https://raw.githubusercontent.com/folke/lazy.nvim/main/bootstrap.lua"))()

require("lazy.minit").repro({ spec = { { "nvim-mini/mini.nvim" } } })

vim.o.list = true

vim.api.nvim_create_autocmd({ "VimEnter", "ColorScheme" }, {
  group = vim.api.nvim_create_augroup("todo_highlight", { clear = true }),
  callback = function()
    -- https://github.com/nvim-mini/mini.nvim/blob/228a8c34fae1d778e895ad06e4158f65e85828bc/lua/mini/hipatterns.lua#L701-L712
    local hi_link_bold_reverse = function(to, from)
      local data = vim.api.nvim_get_hl(0, { name = from, link = false })
      data.default, data.bold, data.reverse = true, true, true
      data.cterm = { bold = true, reverse = true }
      vim.api.nvim_set_hl(0, to, data) ---@diagnostic disable-line: param-type-mismatch
    end
    hi_link_bold_reverse("@MiniHipatternsPerf", "Identifier")
  end,
})

local MiniHipatterns = require("mini.hipatterns")
MiniHipatterns.setup({
  highlighters = {
    -- NOTE: ` PERF ` has spaces at the end
    -- PERF                                
    -- FIXME                               
    perf = { pattern = " PERF ", group = "@MiniHipatternsPerf" },
    fixme = { pattern = " FIXME ", group = "MiniHipatternsFixme" },
  },
})

[pkazmier]

I still prefer the look of what I posted here. #783

But I should update it to automatically create the extra needed highlight groups as it requires me setting them for each colorscheme I want to use.

[echasnovski]

Yeah, the #783 is more straightforward for sure. And can also add different highlighting for the body.

(Re-opened the discussion because I didn't really pay attention to having "Show and tell" discussions be open for better reach).