Handle fallback <CR> mapping that is mapped as expression

Author: kristijanhusak

lua/orgmode/config/init.lua

@@ -176,7 +176,7 @@ end
 
 function Config:setup_mappings(category)
   if not self.old_cr_mapping then
-    self.old_cr_mapping = vim.fn.maparg('<CR>', 'i')
+    self.old_cr_mapping = vim.fn.maparg('<CR>', 'i', false, true)
   end
   if self.opts.mappings.disable_all then
     return

lua/orgmode/org/mappings.lua

@@ -443,12 +443,22 @@ function OrgMappings:org_return()
     end
   end
 
-  local fallback_mapping = '<CR>'
-  if config.old_cr_mapping and config.old_cr_mapping ~= '' then
-    fallback_mapping = config.old_cr_mapping
+  if not config.old_cr_mapping or vim.tbl_isempty(config.old_cr_mapping) then
+    return vim.api.nvim_feedkeys(utils.esc('<CR>'), 'n', true)
   end
 
-  return vim.api.nvim_feedkeys(utils.esc(fallback_mapping), 'n', true)
+  local rhs = config.old_cr_mapping.rhs
+
+  if config.old_cr_mapping.expr > 0 then
+    vim.api.nvim_feedkeys(utils.esc(string.format('<C-r>=%s<CR>', rhs)), 'n', true)
+    -- Echo empty message to remove the register feedkeys output
+    vim.schedule(function()
+      vim.cmd([[echo '']])
+    end)
+    return
+  end
+
+  return vim.api.nvim_feedkeys(utils.esc(rhs), 'n', true)
 end
 
 function OrgMappings:handle_return(suffix)

tests/plenary/ui/table_spec.lua

@@ -53,4 +53,28 @@ describe('Tables', function()
       '| fifth      | sixth       | seventh |',
     }, vim.api.nvim_buf_get_lines(0, 0, -1, false))
   end)
+
+  it('should add new row on enter', function()
+    helpers.load_file_content({
+      '| test |',
+    })
+    vim.fn.cursor({ 1, 6 })
+    vim.cmd([[exe "norm a\<CR>"]])
+    assert.are.same({
+      '| test |',
+      '|      |',
+    }, vim.api.nvim_buf_get_lines(0, 0, -1, false))
+
+    helpers.load_file_content({
+      '| test | col |',
+      '|      | value',
+    })
+    vim.fn.cursor({ 2, 13 })
+    vim.cmd([[exe "norm a\<CR>"]])
+    assert.are.same({
+      '| test | col   |',
+      '|      | value |',
+      '|      |       |',
+    }, vim.api.nvim_buf_get_lines(0, 0, -1, false))
+  end)
 end)