feat(capture): Make sure tags are written as :tag: and not just plain text.

Author: Alec Stewart

lua/orgmode/capture/template/init.lua

@@ -5,6 +5,89 @@ local Calendar = require('orgmode.objects.calendar')
 local Promise = require('orgmode.utils.promise')
 local Input = require('orgmode.ui.input')
 
+---@description Make sure to deduplicate the tags grabbed by `get_target_tags` and `get_all_tags`
+---@param tags string[]
+---@return string[]
+local function uniq_tags(tags)
+  local unique = {}
+  for _, tag in ipairs(tags or {}) do
+    if tag ~= '' then
+      unique[tag] = true
+    end
+  end
+  local list = vim.tbl_keys(unique)
+  table.sort(list)
+  return list
+end
+
+---@description For `%^g` expansion in capture templates: gets all tags in the targeted file.
+---@param template? table
+---@return string[]
+local function get_target_tags(template)
+  local org = require('orgmode')
+  if not org.files or not template or template.target == '' then
+    return {}
+  end
+
+  local ok, file = pcall(function()
+    return org.files:get(template:get_target())
+  end)
+
+  if not ok or not file then
+    return {}
+  end
+
+  local tags = {}
+  for _, tag in ipairs(file:get_filetags()) do
+    table.insert(tags, tag)
+  end
+  for _, headline in ipairs(file:get_headlines()) do
+    local own_tags = headline:get_own_tags()
+    for _, tag in ipairs(own_tags) do
+      table.insert(tags, tag)
+    end
+  end
+
+  return uniq_tags(tags)
+end
+
+---@description For `%^G` expansion in capture templates: gets all tags in all agenda files.
+---@return string[]
+local function get_all_tags()
+  local org = require('orgmode')
+  if not org.files then
+    return {}
+  end
+  return org.files:get_tags()
+end
+
+---@param single boolean
+---@param tags_source string[]
+---@return OrgPromise<string>
+local function prompt_tags(single, tags_source)
+  local completion = function(arg_lead)
+    return vim.tbl_filter(function(tag)
+      return tag:match('^' .. vim.pesc(arg_lead))
+    end, tags_source)
+  end
+  local prompt = single and 'Tag: ' or 'Tags: '
+  return Input.open(prompt, '', completion):next(function(input)
+    if input == nil then
+      return nil
+    end
+    if input == '' then
+      return ''
+    end
+
+    local tags = utils.parse_tags_string(input)
+    if single then
+      return tags[1] and utils.tags_to_string({ tags[1] }) or ''
+    end
+
+    return utils.tags_to_string(tags)
+  end)
+end
+
 local expansions = {
   ['%%f'] = function()
     return vim.fn.expand('%')
@@ -73,6 +156,12 @@ local expansions = {
       return date and date:to_wrapped_string(false) or nil
     end)
   end,
+  ['%%%^g'] = function(_, template)
+    return prompt_tags(true, get_target_tags(template))
+  end,
+  ['%%%^G'] = function()
+    return prompt_tags(false, get_all_tags())
+  end,
   ['%%a'] = function()
     return string.format('[[file:%s::%s]]', utils.current_file_path(), vim.api.nvim_win_get_cursor(0)[1])
   end,

tests/plenary/capture/templates_spec.lua

@@ -1,5 +1,8 @@
 local Template = require('orgmode.capture.template')
 local Date = require('orgmode.objects.date')
+local helpers = require('tests.plenary.helpers')
+local Input = require('orgmode.ui.input')
+local Promise = require('orgmode.utils.promise')
 
 describe('Capture template', function()
   it('should compile expression', function()
@@ -87,4 +90,105 @@ describe('Capture template', function()
     end)
     assert.is.Nil(template:compile():wait())
   end)
+
+  it('should prompt for single tag with %^g', function()
+    helpers.with_var(Input, 'open', function(_prompt, _default, _completion)
+      return Promise.resolve('mytag')
+    end, function()
+      local template = Template:new({
+        template = '* TODO %^g',
+      })
+      assert.are.same({ '* TODO :mytag:' }, template:compile():wait())
+    end)
+  end)
+
+  it('should prompt for multiple tags with %^G', function()
+    helpers.with_var(Input, 'open', function(_prompt, _default, _completion)
+      return Promise.resolve('tag1:tag2')
+    end, function()
+      local template = Template:new({
+        template = '* TODO %^G',
+      })
+      assert.are.same({ '* TODO :tag1:tag2:' }, template:compile():wait())
+    end)
+  end)
+
+  it('should prompt for restricted tags with %^{tag1|tag2}G', function()
+    helpers.with_var(Input, 'open', function(_prompt, _default, _completion)
+      return Promise.resolve('tag1')
+    end, function()
+      local template = Template:new({
+        template = '* TODO %^{tag1|tag2}G',
+      })
+      assert.are.same({ '* TODO :tag1:' }, template:compile():wait())
+    end)
+  end)
+
+  it('should not cancel capture when %^g input is empty', function()
+    helpers.with_var(Input, 'open', function(_prompt, _default, _completion)
+      return Promise.resolve('')
+    end, function()
+      local template = Template:new({
+        template = '* TODO %^g',
+      })
+      assert.are.same({ '* TODO ' }, template:compile():wait())
+    end)
+  end)
+
+  it('should complete %^g from target file tags only', function()
+    local files = helpers.create_agenda_files({
+      {
+        filename = 'target.org',
+        content = {
+          '#+FILETAGS: :target_file:',
+          '* TODO target item :target_headline:',
+        },
+      },
+      {
+        filename = 'other.org',
+        content = {
+          '* TODO other item :other_headline:',
+        },
+      },
+    })
+
+    helpers.with_var(Input, 'open', function(_prompt, _default, completion)
+      assert.are.same({ 'target_file', 'target_headline' }, completion(''))
+      return Promise.resolve('target_headline')
+    end, function()
+      local template = Template:new({
+        template = '* TODO %^g',
+        target = files['target.org'],
+      })
+      assert.are.same({ '* TODO :target_headline:' }, template:compile():wait())
+    end)
+  end)
+
+  it('should complete %^G from all loaded agenda file tags', function()
+    helpers.create_agenda_files({
+      {
+        filename = 'target.org',
+        content = {
+          '#+FILETAGS: :target_file:',
+          '* TODO target item :target_headline:',
+        },
+      },
+      {
+        filename = 'other.org',
+        content = {
+          '* TODO other item :other_headline:',
+        },
+      },
+    })
+
+    helpers.with_var(Input, 'open', function(_prompt, _default, completion)
+      assert.are.same({ 'other_headline', 'target_file', 'target_headline' }, completion(''))
+      return Promise.resolve('target_headline:other_headline')
+    end, function()
+      local template = Template:new({
+        template = '* TODO %^G',
+      })
+      assert.are.same({ '* TODO :target_headline:other_headline:' }, template:compile():wait())
+    end)
+  end)
 end)