feat(capture): Add on_compile hook for templates

Author: kristijanhusak

lua/orgmode/capture/template/init.lua

@@ -34,7 +34,7 @@ local expansions = {
   end,
 }
 
----@class OrgCaptureTemplate
+---@class OrgCaptureTemplateOpts
 ---@field description? string
 ---@field template? string|string[]
 ---@field target? string
@@ -43,9 +43,12 @@ local expansions = {
 ---@field regexp? string
 ---@field properties? OrgCaptureTemplateProperties
 ---@field subtemplates? table<string, OrgCaptureTemplate>
+
+---@class OrgCaptureTemplate:OrgCaptureTemplateOpts
+---@field private _compile_hooks (fun(content:string):string)[]
 local Template = {}
 
----@param opts OrgCaptureTemplate
+---@param opts OrgCaptureTemplateOpts
 ---@return OrgCaptureTemplate
 function Template:new(opts)
   opts = opts or {}
@@ -94,6 +97,12 @@ function Template:setup()
   end
 end
 
+function Template:on_compile(hook)
+  self._compile_hooks = self._compile_hooks or {}
+  table.insert(self._compile_hooks, hook)
+  return self
+end
+
 function Template:validate_options()
   self:_validate_regexp()
   if self.datetree then
@@ -204,6 +213,11 @@ function Template:_compile(content)
   content = self:_compile_expansions(content)
   content = self:_compile_expressions(content)
   content = self:_compile_prompts(content)
+  if self._compile_hooks then
+    for _, hook in ipairs(self._compile_hooks) do
+      content = hook(content)
+    end
+  end
   return content
 end
 

tests/plenary/capture/templates_spec.lua

@@ -60,4 +60,16 @@ describe('Capture template', function()
 
     assert.are.same(date:to_string(), template:get_datetree_opts().date:to_string())
   end)
+
+  it('should process custom compile hooks', function()
+    local template = Template:new({
+      template = '* This is a test {title} and {slug} in headline',
+    })
+    template:on_compile(function(content)
+      content = content:gsub('{title}', 'Org Test')
+      content = content:gsub('{slug}', 'org-test')
+      return content
+    end)
+    assert.are.same({ '* This is a test Org Test and org-test in headline' }, template:compile())
+  end)
 end)