feat: allow configuration with telescope options

- add telescope compatible setup function
- attach mappings from configuration within picker creation

Author: seflue

lua/telescope-orgmode/config.lua

@@ -0,0 +1,11 @@
+local M = {}
+
+M.opts = {
+  max_depth = nil,
+}
+
+function M.setup(ext_opts)
+  M.opts = vim.tbl_extend('force', M.opts, ext_opts or {})
+end
+
+return M

lua/telescope-orgmode/init.lua

@@ -1,4 +1,5 @@
 return {
+  setup = require('telescope-orgmode.config').setup,
   refile_heading = require('telescope-orgmode.refile_heading'),
   search_headings = require('telescope-orgmode.search_headings'),
   insert_link = require('telescope-orgmode.insert_link'),

lua/telescope-orgmode/insert_link.lua

@@ -9,6 +9,7 @@ local action_state = require('telescope.actions.state')
 local OrgApi = require('orgmode.api')
 
 local utils = require('telescope-orgmode.utils')
+local config = require('telescope-orgmode.config')
 
 ---@class MatchEntry
 ---@field value OrgEntry
@@ -34,13 +35,12 @@ local function insert(prompt_bufnr)
     destination = 'file:' .. entry.value.file.filename .. '::*' .. entry.value.headline.title
   end
 
-  --print(vim.inspect(destination))
   OrgApi.insert_link(destination)
   return true
 end
 
 return function(opts)
-  opts = opts or {}
+  opts = vim.tbl_extend('force', config.opts, opts or {})
 
   pickers
     .new(opts, {
@@ -51,9 +51,14 @@ return function(opts)
       }),
       sorter = conf.generic_sorter(opts),
       previewer = conf.grep_previewer(opts),
-      attach_mappings = function(prompt_bufnr, map)
+      attach_mappings = function(_, map)
+        map('i', '<C-Space>', utils.gen_depth_toggle(opts), { desc = 'Toggle headline/file jump' })
+        for mode, mappings in pairs(opts.mappings or {}) do
+          for key, action in pairs(mappings) do
+            map(mode, key, action)
+          end
+        end
         action_set.select:replace(insert)
-        map('i', '<c-space>', utils.gen_depth_toggle(opts, prompt_bufnr))
         return true
       end,
     })

lua/telescope-orgmode/refile_heading.lua

@@ -6,6 +6,7 @@ local actions = require('telescope.actions')
 local action_state = require('telescope.actions.state')
 
 local utils = require('telescope-orgmode.utils')
+local config = require('telescope-orgmode.config')
 
 local OrgApi = require('orgmode.api')
 
@@ -32,7 +33,7 @@ end
 M.closest_headline = nil
 
 return function(opts)
-  opts = opts or {}
+  opts = vim.tbl_extend('force', config.opts, opts or {})
 
   M.closest_headline = OrgApi.current():get_closest_headline()
 
@@ -47,9 +48,14 @@ return function(opts)
       }),
       sorter = conf.generic_sorter(opts),
       previewer = conf.grep_previewer(opts),
-      attach_mappings = function(prompt_bufnr, map)
+      attach_mappings = function(_, map)
+        map('i', '<C-Space>', utils.gen_depth_toggle(opts), { desc = 'Toggle headline/orgfile' })
+        for mode, mappings in pairs(opts.mappings or {}) do
+          for key, action in pairs(mappings) do
+            map(mode, key, action)
+          end
+        end
         action_set.select:replace(M.refile)
-        map('i', '<c-space>', utils.gen_depth_toggle(opts, prompt_bufnr))
         return true
       end,
     })

lua/telescope-orgmode/search_headings.lua

@@ -3,9 +3,10 @@ local finders = require('telescope.finders')
 local conf = require('telescope.config').values
 
 local utils = require('telescope-orgmode.utils')
+local config = require('telescope-orgmode.config')
 
 return function(opts)
-  opts = opts or {}
+  opts = vim.tbl_extend('force', config.opts, opts or {})
 
   pickers
     .new(opts, {
@@ -16,6 +17,15 @@ return function(opts)
       }),
       sorter = conf.generic_sorter(opts),
       previewer = conf.grep_previewer(opts),
+      attach_mappings = function(_, map)
+        map('i', '<C-Space>', utils.gen_depth_toggle(opts), { desc = 'Toggle headline/orgfile jump' })
+        for mode, mappings in pairs(opts.mappings or {}) do
+          for key, action in pairs(mappings) do
+            map(mode, key, action)
+          end
+        end
+        return true
+      end,
     })
     :find()
 end

lua/telescope-orgmode/utils.lua

@@ -98,21 +98,24 @@ utils.make_entry = function(opts)
   end
 end
 
-utils.gen_depth_toggle = function(opts, prompt_bufnr)
-  local status = state.get_status(prompt_bufnr)
-  status._ot_current_depth = opts.max_depth
-  status._ot_next_depth = nil
-  if status._ot_current_depth ~= 0 then
-    status._ot_next_depth = 0
-  end
-
-  return function()
+utils.gen_depth_toggle = function(opts)
+  return function(prompt_bufnr)
     local current_picker = action_state.get_current_picker(prompt_bufnr)
+    local status = state.get_status(prompt_bufnr)
+
+    if status._ot_current_depth == nil and status._ot_next_depth == nil then
+      -- uninitialized state - initialize with "show files only"
+      -- Because when this function is called the first time, it is triggered
+      -- by the users and we search over headings by default, we set the state
+      -- for the first toggle already here.
+      status._ot_current_depth = 0
+      status._ot_next_depth = opts.max_depth
+    else
+      -- initalized state - swap to next state
+      status._ot_current_depth, status._ot_next_depth = status._ot_next_depth, status._ot_current_depth
+    end
 
-    local aux = status._ot_current_depth
-    status._ot_current_depth = status._ot_next_depth
-    status._ot_next_depth = aux
-
+    -- opts is used as a channel to communicate the depth state to the get_entries function
     opts.max_depth = status._ot_current_depth
     local new_finder = finders.new_table({
       results = utils.get_entries(opts),

lua/telescope/_extensions/orgmode/init.lua

@@ -3,6 +3,7 @@
 -- TODO: add highlight groups
 
 return require('telescope').register_extension({
+  setup = require('telescope-orgmode').setup,
   exports = {
     search_headings = require('telescope-orgmode').search_headings,
     refile_heading = require('telescope-orgmode').refile_heading,