feat(highlights): Add highlights for priorities (nvim-orgmode#687)

Author: kristijanhusak

DOCS.md

@@ -1329,14 +1329,17 @@ Most of the highlight groups are linked to treesitter highlights where applicabl
 
 The following highlight groups are used:
 
-  * `@org.headline.level1`: Headline at level 1 - `linked to Title`
-  * `@org.headline.level2`: Headline at level 2 - `linked to Constant`
-  * `@org.headline.level3`: Headline at level 3 - `linked to Identifier`
-  * `@org.headline.level4`: Headline at level 4 - `linked to Statement`
-  * `@org.headline.level5`: Headline at level 5 - `linked to PreProc`
-  * `@org.headline.level6`: Headline at level 6 - `linked to Type`
-  * `@org.headline.level7`: Headline at level 7 - `linked to Special`
-  * `@org.headline.level8`: Headline at level 8 - `linked to String`
+  * `@org.headline.level1`: Headline at level 1 - linked to `Title`
+  * `@org.headline.level2`: Headline at level 2 - linked to `Constant`
+  * `@org.headline.level3`: Headline at level 3 - linked to `Identifier`
+  * `@org.headline.level4`: Headline at level 4 - linked to `Statement`
+  * `@org.headline.level5`: Headline at level 5 - linked to `PreProc`
+  * `@org.headline.level6`: Headline at level 6 - linked to `Type`
+  * `@org.headline.level7`: Headline at level 7 - linked to `Special`
+  * `@org.headline.level8`: Headline at level 8 - linked to `String`
+  * `@org.priority.highest`: Highest priority marker - linked to `@comment.error`
+  * `@org.priority.default`: Default priority marker - Not linked to anything, defaults to normal text
+  * `@org.priority.lowest`: Lowest priority marker - Not linked to anything, defaults to normal text
   * `@org.timestamp.active`: An active timestamp - linked to `@keyword`
   * `@org.timestamp.inactive`: An inactive timestamp - linked to `@comment`
   * `@org.keyword.todo`: TODO keywords color - Parsed from `Error` (see note below)

lua/orgmode/agenda/agenda_item.lua

@@ -83,6 +83,7 @@ function AgendaItem:_generate_data()
     table.insert(self.highlights, highlight)
   end
   self:_add_keyword_highlight()
+  self:_add_priority_highlight()
 end
 
 function AgendaItem:_is_valid_for_today()
@@ -260,4 +261,22 @@ function AgendaItem:_add_keyword_highlight()
   end
 end
 
+function AgendaItem:_add_priority_highlight()
+  local priority, priority_node = self.headline:get_priority()
+  if not priority_node then
+    return
+  end
+  local hlgroup = hl_map.priority[priority].hl_group
+  local last_hl = self.highlights[#self.highlights]
+  local start_col = 2
+  if last_hl and last_hl.todo_keyword then
+    start_col = start_col + last_hl.todo_keyword:len()
+  end
+  table.insert(self.highlights, {
+    hlgroup = hlgroup,
+    priority = priority,
+    start_col = start_col,
+  })
+end
+
 return AgendaItem

lua/orgmode/agenda/views/agenda.lua

@@ -309,6 +309,10 @@ function AgendaView.build_agenda_item_content(agenda_item, longest_category, lon
         hl.range.start_col = todo_keyword_pos + 1
         hl.range.end_col = todo_keyword_pos + hl.todo_keyword:len() + 1
       end
+      if hl.priority then
+        hl.range.start_col = todo_keyword_pos + hl.start_col
+        hl.range.end_col = todo_keyword_pos + hl.start_col + 4
+      end
       return hl
     end, agenda_item.highlights)
   end
@@ -321,7 +325,7 @@ function AgendaView.build_agenda_item_content(agenda_item, longest_category, lon
         start_col = 1,
         end_col = 0,
       }),
-      hl_group = 'Visual',
+      hlgroup = 'Visual',
       whole_line = true,
     })
   end

lua/orgmode/agenda/views/todos.lua

@@ -82,8 +82,9 @@ function AgendaTodosView.generate_todo_item(headline, longest_category, line_nr)
   local todo_keyword, _, todo_type = headline:get_todo()
   todo_keyword = todo_keyword or ''
   local todo_keyword_padding = todo_keyword ~= '' and ' ' or ''
-  local line =
-    string.format('  %s%s%s %s', category, todo_keyword_padding, todo_keyword, headline:get_title_with_priority())
+  local title_with_priority = headline:get_title_with_priority()
+  local todo_keyword_len = todo_keyword:len()
+  local line = string.format('  %s%s%s %s', category, todo_keyword_padding, todo_keyword, title_with_priority)
   if #headline:get_tags() > 0 then
     local tags_string = headline:tags_to_string()
     local padding_length =
@@ -100,7 +101,20 @@ function AgendaTodosView.generate_todo_item(headline, longest_category, line_nr)
         start_line = line_nr,
         end_line = line_nr,
         start_col = todo_keyword_pos,
-        end_col = todo_keyword_pos + todo_keyword:len(),
+        end_col = todo_keyword_pos + todo_keyword_len,
+      }),
+    })
+  end
+  local priority = headline:get_priority()
+  if priority and hl_map.priority[priority] then
+    local col_start = todo_keyword_pos + (todo_keyword_len > 0 and todo_keyword_len + 1 or 0)
+    table.insert(highlights, {
+      hlgroup = hl_map.priority[priority].hl_group,
+      range = Range:new({
+        start_line = line_nr,
+        end_line = line_nr,
+        start_col = col_start,
+        end_col = col_start + 4,
       }),
     })
   end
@@ -112,7 +126,7 @@ function AgendaTodosView.generate_todo_item(headline, longest_category, line_nr)
         start_col = 1,
         end_col = 0,
       }),
-      hl_group = 'Visual',
+      hlgroup = 'Visual',
       whole_line = true,
     })
   end

lua/orgmode/colors/highlights.lua

@@ -21,6 +21,8 @@ function M.link_highlights()
     ['@org.headline.level7'] = 'Special',
     ['@org.headline.level8'] = 'String',
 
+    ['@org.priority.highest'] = '@comment.error',
+
     -- Headline tags
     ['@org.tag'] = '@tag.attribute',
 
@@ -172,6 +174,7 @@ function M.get_agenda_hl_map()
     deadline = '@org.agenda.deadline',
     ok = '@org.agenda.scheduled',
     warning = '@org.agenda.scheduled_past',
+    priority = config:get_priorities(),
   }, faces)
 end
 

lua/orgmode/colors/init.lua

@@ -80,7 +80,7 @@ M.highlight = function(highlights, clear)
   for _, hl in ipairs(highlights) do
     if hl.whole_line then
       vim.api.nvim_buf_set_extmark(0, namespace, hl.range.start_line - 1, hl.range.start_col - 1, {
-        hl_group = hl.hl_group,
+        hl_group = hl.hlgroup,
         end_line = hl.range.start_line,
         hl_eol = true,
       })

lua/orgmode/config/init.lua

@@ -345,8 +345,17 @@ function Config:get_inheritable_tags(headline)
   end, headline.tags)
 end
 
+function Config:get_priorities()
+  return {
+    [self.opts.org_priority_highest] = { type = 'highest', hl_group = '@org.priority.highest' },
+    [self.opts.org_priority_default] = { type = 'default', hl_group = '@org.priority.default' },
+    [self.opts.org_priority_lowest] = { type = 'lowest', hl_group = '@org.priority.lowest' },
+  }
+end
+
 function Config:setup_ts_predicates()
   local todo_keywords = self:get_todo_keywords().KEYS
+  local valid_priorities = self:get_priorities()
 
   vim.treesitter.query.add_predicate('org-is-todo-keyword?', function(match, _, source, predicate)
     local node = match[predicate[2]]
@@ -358,6 +367,41 @@ function Config:setup_ts_predicates()
     return false
   end, true)
 
+  vim.treesitter.query.add_predicate('org-is-valid-priority?', function(match, _, source, predicate)
+    local node = match[predicate[2]]
+    local type = predicate[3]
+    if not node then
+      return false
+    end
+
+    local text = vim.treesitter.get_node_text(node, source)
+    local is_valid = valid_priorities[text] and valid_priorities[text].type == type
+    if not is_valid then
+      return false
+    end
+    local priority_text = '[#' .. text .. ']'
+    local full_node_text = vim.treesitter.get_node_text(node:parent(), source)
+    if priority_text ~= full_node_text then
+      return false
+    end
+
+    local prev_sibling = node:parent():prev_sibling()
+    -- If first child, consider it valid
+    if not prev_sibling then
+      return true
+    end
+
+    -- If prev sibling has more prev siblings, it means that the prev_sibling is not a todo keyword
+    -- so this priority is not valid
+    if prev_sibling:prev_sibling() then
+      return false
+    end
+
+    local todo_text = vim.treesitter.get_node_text(prev_sibling, source)
+    local is_prev_sibling_todo_keyword = todo_keywords[todo_text] and true or false
+    return is_prev_sibling_todo_keyword
+  end, true)
+
   vim.treesitter.query.add_directive('org-set-block-language!', function(match, _, bufnr, pred, metadata)
     local lang_node = match[pred[2]]
     if not lang_node then

lua/orgmode/files/headline.lua

@@ -66,8 +66,26 @@ end
 memoize('get_priority')
 ---@return string, TSNode | nil
 function Headline:get_priority()
-  local node, priority = self:_parse_title_part('%[#(%w+)%]')
-  return priority, node
+  local _, todo_node = self:get_todo()
+  local item = self:_get_child_node('item')
+
+  local priority_node = item and item:named_child(1)
+
+  if not todo_node then
+    priority_node = item and item:named_child(0)
+  end
+
+  if priority_node then
+    local text = self.file:get_node_text(priority_node)
+    local priority = text:match('%[#(%w+)%]')
+    if priority then
+      local priorities = config:get_priorities()
+      if priorities[priority] then
+        return priority, priority_node
+      end
+    end
+  end
+  return '', nil
 end
 
 ---@param amount number

queries/org/highlights.scm

@@ -11,6 +11,9 @@
 (headline (item) @spell)
 (item . (expr) @org.keyword.todo @nospell (#org-is-todo-keyword? @org.keyword.todo "TODO"))
 (item . (expr) @org.keyword.done @nospell (#org-is-todo-keyword? @org.keyword.done "DONE"))
+(item (expr "[" "#" "str" @_priority "]") @org.priority.highest (#org-is-valid-priority? @_priority "highest"))
+(item (expr "[" "#" "str" @_priority "]") @org.priority.default (#org-is-valid-priority? @_priority "default"))
+(item (expr "[" "#" "str" @_priority "]") @org.priority.lowest (#org-is-valid-priority? @_priority "lowest"))
 (list (listitem (paragraph) @spell))
 (body (paragraph) @spell)
 (bullet) @org.bullet