Custom mapping prefix (#330)

Author: jgollenz

DOCS.md

@@ -481,7 +481,7 @@ Using the example above, setting this variable to `{'MYTAG'}`, second and third
 ## Mappings
 
 Mappings try to mimic some of the Orgmode mappings, but since Orgmode uses `CTRL + c` as a modifier most of the time, we have to take a different route.
-When possible, instead of `CTRL + C`, prefix `<Leader>o` is used.
+When possible, instead of `CTRL + C`, prefix `<Leader>o` is used. This is customizable via the `mappings.prefix` setting.
 
 To disable all mappings, just pass `disable_all = true` to mappings settings:
 ```lua

lua/orgmode/config/defaults.lua

@@ -51,9 +51,10 @@ return {
   },
   mappings = {
     disable_all = false,
+    prefix = '<Leader>o',
     global = {
-      org_agenda = '<Leader>oa',
-      org_capture = '<Leader>oc',
+      org_agenda = '<prefix>a',
+      org_capture = '<prefix>c',
     },
     agenda = {
       org_agenda_later = 'f',
@@ -69,80 +70,80 @@ return {
       org_agenda_goto_date = 'J',
       org_agenda_redo = 'r',
       org_agenda_todo = 't',
-      org_agenda_clock_goto = '<leader>oxj',
-      org_agenda_set_effort = '<leader>oxe',
+      org_agenda_clock_goto = '<prefix>xj',
+      org_agenda_set_effort = '<prefix>xe',
       org_agenda_clock_in = 'I',
       org_agenda_clock_out = 'O',
       org_agenda_clock_cancel = 'X',
       org_agenda_clockreport_mode = 'R',
-      org_agenda_priority = '<leader>o,',
+      org_agenda_priority = '<prefix>,',
       org_agenda_priority_up = '+',
       org_agenda_priority_down = '-',
-      org_agenda_toggle_archive_tag = '<Leader>oA',
-      org_agenda_set_tags = '<Leader>ot',
-      org_agenda_deadline = '<Leader>oid',
-      org_agenda_schedule = '<Leader>ois',
+      org_agenda_toggle_archive_tag = '<prefix>A',
+      org_agenda_set_tags = '<prefix>t',
+      org_agenda_deadline = '<prefix>id',
+      org_agenda_schedule = '<prefix>is',
       org_agenda_filter = '/',
       org_agenda_show_help = 'g?',
     },
     capture = {
       org_capture_finalize = '<C-c>',
-      org_capture_refile = '<Leader>or',
-      org_capture_kill = '<Leader>ok',
+      org_capture_refile = '<prefix>r',
+      org_capture_kill = '<prefix>k',
       org_capture_show_help = 'g?',
     },
     org = {
-      org_refile = '<Leader>or',
+      org_refile = '<prefix>r',
       org_timestamp_up_day = '<S-UP>',
       org_timestamp_down_day = '<S-DOWN>',
       org_timestamp_up = '<C-a>',
       org_timestamp_down = '<C-x>',
       org_change_date = 'cid',
-      org_priority = '<Leader>o,',
+      org_priority = '<prefix>,',
       org_priority_up = 'ciR',
       org_priority_down = 'cir',
       org_todo = 'cit',
       org_todo_prev = 'ciT',
       org_toggle_checkbox = '<C-Space>',
-      org_toggle_heading = '<Leader>o*',
-      org_open_at_point = '<Leader>oo',
-      org_edit_special = [[<Leader>o']],
+      org_toggle_heading = '<prefix>*',
+      org_open_at_point = '<prefix>o',
+      org_edit_special = [[<prefix>']],
       org_cycle = '<TAB>',
       org_global_cycle = '<S-TAB>',
-      org_archive_subtree = '<Leader>o$',
-      org_set_tags_command = '<Leader>ot',
-      org_toggle_archive_tag = '<Leader>oA',
+      org_archive_subtree = '<prefix>$',
+      org_set_tags_command = '<prefix>t',
+      org_toggle_archive_tag = '<prefix>A',
       org_do_promote = '<<',
       org_do_demote = '>>',
       org_promote_subtree = '<s',
       org_demote_subtree = '>s',
       org_meta_return = '<Leader><CR>', -- Add heading, item or row
       org_return = '<CR>',
-      org_insert_heading_respect_content = '<Leader>oih', -- Add new headling after current heading block with same level
-      org_insert_todo_heading = '<Leader>oiT', -- Add new todo headling right after current heading with same level
-      org_insert_todo_heading_respect_content = '<Leader>oit', -- Add new todo headling after current heading block on same level
-      org_move_subtree_up = '<Leader>oK',
-      org_move_subtree_down = '<Leader>oJ',
-      org_export = '<Leader>oe',
+      org_insert_heading_respect_content = '<prefix>ih', -- Add new headling after current heading block with same level
+      org_insert_todo_heading = '<prefix>iT', -- Add new todo headling right after current heading with same level
+      org_insert_todo_heading_respect_content = '<prefix>it', -- Add new todo headling after current heading block on same level
+      org_move_subtree_up = '<prefix>K',
+      org_move_subtree_down = '<prefix>J',
+      org_export = '<prefix>e',
       org_next_visible_heading = '}',
       org_previous_visible_heading = '{',
       org_forward_heading_same_level = ']]',
       org_backward_heading_same_level = '[[',
       outline_up_heading = 'g{',
-      org_deadline = '<Leader>oid',
-      org_schedule = '<Leader>ois',
-      org_time_stamp = '<Leader>oi.',
-      org_time_stamp_inactive = '<Leader>oi!',
-      org_clock_in = '<Leader>oxi',
-      org_clock_out = '<Leader>oxo',
-      org_clock_cancel = '<leader>oxq',
-      org_clock_goto = '<leader>oxj',
-      org_set_effort = '<leader>oxe',
+      org_deadline = '<prefix>id',
+      org_schedule = '<prefix>is',
+      org_time_stamp = '<prefix>i.',
+      org_time_stamp_inactive = '<prefix>i!',
+      org_clock_in = '<prefix>xi',
+      org_clock_out = '<prefix>xo',
+      org_clock_cancel = '<prefix>xq',
+      org_clock_goto = '<prefix>xj',
+      org_set_effort = '<prefix>xe',
       org_show_help = 'g?',
     },
     edit_src = {
-      org_edit_src_abort = '<Leader>ok',
-      org_edit_src_save = '<Leader>ow',
+      org_edit_src_abort = '<prefix>k',
+      org_edit_src_save = '<prefix>w',
       org_edit_src_show_help = 'g?',
     },
     text_objects = {

lua/orgmode/config/init.lua

@@ -191,6 +191,10 @@ function Config:setup_mappings(category, bufnr)
     opts.buffer = bufnr
   end
 
+  if self.opts.mappings.prefix then
+    opts.prefix = self.opts.mappings.prefix
+  end
+
   for name, map_entry in pairs(map_entries) do
     map_entry:attach(default_mappings[name], user_mappings[name], opts)
   end

lua/orgmode/config/mappings/map_entry.lua

@@ -85,7 +85,16 @@ function MapEntry:attach(default_mapping, user_mapping, opts)
 
   local map_opts = vim.tbl_extend('force', self.opts, opts or {})
 
+  local prefix = ''
+  if map_opts.prefix then
+    prefix = map_opts.prefix
+    map_opts.prefix = nil
+  end
+
   for _, map in ipairs(mapping) do
+    if prefix ~= '' then
+      map = map:gsub('<prefix>', prefix)
+    end
     vim.keymap.set(self.modes, map, self.handler, map_opts)
     if self.type == 'operator' then
       vim.keymap.set('o', map, (':normal v%s<CR>'):format(map), map_opts)

tests/plenary/ui/mappings_spec.lua

@@ -1624,4 +1624,29 @@ describe('Mappings', function()
       '- [ ] checkbox item',
     }, vim.api.nvim_buf_get_lines(0, 0, 6, false))
   end)
+
+  it('should respect custom  mapping prefix', function()
+    config:extend({
+      mappings = {
+        prefix = '<Leader>f',
+      },
+    })
+
+    helpers.load_file_content({
+      '* DONE top level todo :WORK:',
+      'content for top level todo',
+    })
+    assert.are.same({
+      '* DONE top level todo :WORK:',
+      'content for top level todo',
+    }, vim.api.nvim_buf_get_lines(0, 0, 2, false))
+    vim.fn.cursor(3, 1)
+    vim.cmd([[norm ,fit]])
+    assert.are.same({
+      '* DONE top level todo :WORK:',
+      'content for top level todo',
+      '',
+      '* TODO ',
+    }, vim.api.nvim_buf_get_lines(0, 0, 4, false))
+  end)
 end)