feat(labels): add option to set closing tag virtual text priority (#373)

README.md

@@ -236,6 +236,9 @@ require("flutter-tools").setup {
   closing_tags = {
     highlight = "ErrorMsg", -- highlight for the closing tag
     prefix = ">", -- character to use for close tag e.g. > Widget
+    priority = 10, -- priority of virtual text in current line
+    -- consider to configure this when there is a possibility of multiple virtual text items in one line
+    -- see `priority` option in |:help nvim_buf_set_extmark| for more info
     enabled = true -- set to false to disable
   },
   dev_log = {

doc/flutter-tools.txt

@@ -272,6 +272,9 @@ both are set.
       closing_tags = {
         highlight = "ErrorMsg", -- highlight for the closing tag
         prefix = ">", -- character to use for close tag e.g. > Widget
+        priority = 10, -- priority of virtual text in current line
+        -- consider to configure this when there is a possibility of multiple virtual text items in one line
+        -- see `priority` option in |:help nvim_buf_set_extmark| for more info
         enabled = true -- set to false to disable
       },
       dev_log = {

lua/flutter-tools/config.lua

@@ -109,6 +109,7 @@ local config = {
   closing_tags = {
     highlight = "Comment",
     prefix = "// ",
+    priority = 10,
     enabled = true,
   },
   lsp = {

lua/flutter-tools/labels.lua

@@ -12,6 +12,7 @@ local function render_labels(labels, opts)
   opts = opts or {}
   local highlight = opts and opts.highlight or "Comment"
   local prefix = opts and opts.prefix or "// "
+  local priority = opts and opts.priority or 10
 
   for _, item in ipairs(labels) do
     local line = tonumber(item.range["end"].line)
@@ -23,6 +24,7 @@ local function render_labels(labels, opts)
         } },
         virt_text_pos = "eol",
         hl_mode = "combine",
+        priority = priority,
       })
     end
   end