Merge pull request #304 from jgollenz/fix/multi-hyphen-todo-keyword

Handle multiple substitutions in custom todo keyword

Author: kristijanhusak

lua/orgmode/treesitter/headline.lua

@@ -124,7 +124,9 @@ function Headline:todo()
 
   local text = query.get_node_text(todo_node, 0)
   for _, word in ipairs(keywords) do
-    local todo = text:match(word:gsub('-', '%%-'))
+    -- there may be multiple substitutions necessary
+    escaped_word = vim.pesc(word)
+    local todo = text:match(escaped_word)
     if todo then
       return todo_node, word, vim.tbl_contains(done_keywords, word)
     end

tests/plenary/object/todo_state_spec.lua

@@ -18,11 +18,22 @@ describe('Todo state', function()
 
   it('should properly cycle through all defined custom states', function()
     config:extend({
-      org_todo_keywords = { 'TODO', 'WAITING', 'PROCESSING', '|', 'CONFIRM', 'DONE' },
+      org_todo_keywords = {
+        'TODO',
+        'WAITING',
+        'PROCESSING',
+        'HYPHEN-KEYWORD',
+        'MULTI-HYPHEN-KEYWORD',
+        '|',
+        'CONFIRM',
+        'DONE',
+      },
     })
     local next_state = TodoState:new({ current_state = 'TODO' })
     assert.are.same({ value = 'WAITING', type = 'TODO', hl = 'OrgTODO' }, next_state:get_next())
     assert.are.same({ value = 'PROCESSING', type = 'TODO', hl = 'OrgTODO' }, next_state:get_next())
+    assert.are.same({ value = 'HYPHEN-KEYWORD', type = 'TODO', hl = 'OrgTODO' }, next_state:get_next())
+    assert.are.same({ value = 'MULTI-HYPHEN-KEYWORD', type = 'TODO', hl = 'OrgTODO' }, next_state:get_next())
     assert.are.same({ value = 'CONFIRM', type = 'DONE', hl = 'OrgDONE' }, next_state:get_next())
     assert.are.same({ value = 'DONE', type = 'DONE', hl = 'OrgDONE' }, next_state:get_next())
     assert.are.same({ value = '', type = '' }, next_state:get_next())
@@ -32,6 +43,8 @@ describe('Todo state', function()
     assert.are.same({ value = '', type = '' }, prev_state:get_prev())
     assert.are.same({ value = 'DONE', type = 'DONE', hl = 'OrgDONE' }, prev_state:get_prev())
     assert.are.same({ value = 'CONFIRM', type = 'DONE', hl = 'OrgDONE' }, prev_state:get_prev())
+    assert.are.same({ value = 'MULTI-HYPHEN-KEYWORD', type = 'TODO', hl = 'OrgTODO' }, prev_state:get_prev())
+    assert.are.same({ value = 'HYPHEN-KEYWORD', type = 'TODO', hl = 'OrgTODO' }, prev_state:get_prev())
     assert.are.same({ value = 'PROCESSING', type = 'TODO', hl = 'OrgTODO' }, prev_state:get_prev())
     assert.are.same({ value = 'WAITING', type = 'TODO', hl = 'OrgTODO' }, prev_state:get_prev())
     assert.are.same({ value = 'TODO', type = 'TODO', hl = 'OrgTODO' }, prev_state:get_prev())