fix(input): stop action when input prompt is canceled

Fixes #857

Author: kristijanhusak

lua/orgmode/agenda/init.lua

@@ -485,7 +485,7 @@ end
 function Agenda:filter()
   local this = self
   self.filters:parse_available_filters(self.views)
-  local filter_term = vim.fn.OrgmodeInput('Filter [+cat-tag/regexp/]: ', self.filters.value, function(arg_lead)
+  local filter_term = utils.input('Filter [+cat-tag/regexp/]: ', self.filters.value, function(arg_lead)
     return utils.prompt_autocomplete(arg_lead, this.filters:get_completion_list(), { '+', '-' })
   end)
   if filter_term == self.filters.value then

lua/orgmode/agenda/types/search.lua

@@ -1,3 +1,4 @@
+local utils = require('orgmode.utils')
 ---@diagnostic disable: inject-field
 local OrgAgendaTodosType = require('orgmode.agenda.types.todo')
 
@@ -28,7 +29,7 @@ function OrgAgendaSearchType:get_file_headlines(file)
 end
 
 function OrgAgendaSearchType:get_search_term()
-  return vim.fn.OrgmodeInput('Enter search term: ', self.headline_query or '')
+  return utils.input('Enter search term: ', self.headline_query or '')
 end
 
 function OrgAgendaSearchType:redraw()

lua/orgmode/agenda/types/tags.lua

@@ -97,7 +97,7 @@ end
 
 ---@param files? OrgFiles
 function OrgAgendaTagsType:get_tags(files)
-  local tags = vim.fn.OrgmodeInput('Match: ', self.match_query or '', function(arg_lead)
+  local tags = utils.input('Match: ', self.match_query or '', function(arg_lead)
     return utils.prompt_autocomplete(arg_lead, (files or self.files):get_tags())
   end)
   if vim.trim(tags) == '' then

lua/orgmode/api/agenda.lua

@@ -17,7 +17,7 @@ local function get_date(date, name)
     return Date.from_string(date)
   end
 
-  error(('Invalid format for "%s" date in Org Agenda'):format(name))
+  error(('Invalid format for "%s" date in Org Agenda'):format(name), 0)
 end
 
 local function get_shared_opts(options)

lua/orgmode/api/headline.lua

@@ -171,14 +171,14 @@ function OrgHeadline:set_deadline(date)
       if date_instance then
         return headline:set_deadline_date(date_instance)
       end
-      error('Invalid string format for deadline date')
+      error('Invalid string format for deadline date', 0)
     end
 
     if Date.is_date_instance(date) then
       return headline:set_deadline_date(date)
     end
 
-    error('Invalid argument to set_deadline')
+    error('Invalid argument to set_deadline', 0)
   end)
 end
 
@@ -211,14 +211,14 @@ function OrgHeadline:set_scheduled(date)
       if date_instance then
         return headline:set_scheduled_date(date_instance)
       end
-      error('Invalid string format for schedule date')
+      error('Invalid string format for schedule date', 0)
     end
 
     if Date.is_date_instance(date) then
       return headline:set_scheduled_date(date)
     end
 
-    error('Invalid argument to set_scheduled')
+    error('Invalid argument to set_scheduled', 0)
   end)
 end
 

lua/orgmode/api/init.lua

@@ -38,14 +38,14 @@ function OrgApi.load(name)
 
     return list
   end
-  error('Invalid argument to OrgApi.load')
+  error('Invalid argument to OrgApi.load', 0)
 end
 
 --- Get current org buffer file
 ---@return OrgApiFile
 function OrgApi.current()
   if vim.bo.filetype ~= 'org' then
-    error('Not an org buffer.')
+    error('Not an org buffer.', 0)
   end
   local name = vim.api.nvim_buf_get_name(0)
   return OrgApi.load(name)
@@ -62,14 +62,14 @@ function OrgApi.refile(opts)
   })
 
   if getmetatable(opts.source) ~= OrgHeadline then
-    error('Source must be an OrgApiHeadline')
+    error('Source must be an OrgApiHeadline', 0)
   end
 
   local is_file = getmetatable(opts.destination) == OrgFile
   local is_headline = getmetatable(opts.destination) == OrgHeadline
 
   if not is_file and not is_headline then
-    error('Destination must be an OrgApiFile or OrgApiHeadline')
+    error('Destination must be an OrgApiFile or OrgApiHeadline', 0)
   end
 
   local refile_opts = {

lua/orgmode/capture/init.lua

@@ -363,7 +363,7 @@ end
 function Capture:get_destination()
   local valid_destinations = self:_get_autocompletion_files()
 
-  local destination = vim.fn.OrgmodeInput('Enter destination: ', '', function(arg_lead)
+  local destination = utils.input('Enter destination: ', '', function(arg_lead)
     return self:autocomplete_refile(arg_lead, valid_destinations)
   end)
 

lua/orgmode/capture/template/init.lua

@@ -363,7 +363,7 @@ function Template:_compile_prompts(content)
     if #parts > 2 then
       local completion_items = vim.list_slice(parts, 3, #parts)
       local prompt = string.format('%s [%s]: ', title, default)
-      response = vim.fn.OrgmodeInput(prompt, '', function(arg_lead)
+      response = utils.input(prompt, '', function(arg_lead)
         return vim.tbl_filter(function(v)
           return v:match('^' .. vim.pesc(arg_lead))
         end, completion_items)

lua/orgmode/clock/init.lua

@@ -102,7 +102,7 @@ function Clock:org_set_effort()
   local item = self.files:get_closest_headline()
   -- TODO: Add Effort_ALL property as autocompletion
   local current_effort = item:get_property('Effort')
-  local effort = vim.fn.OrgmodeInput('Effort: ', current_effort or '')
+  local effort = utils.input('Effort: ', current_effort or '')
   local duration = Duration.parse(effort)
   if duration == nil then
     return utils.echo_error('Invalid duration format: ' .. effort)

lua/orgmode/config/mappings/map_entry.lua

@@ -96,7 +96,8 @@ function MapEntry:attach(default_mapping, user_mapping, opts)
 
   if type(mapping) ~= 'table' then
     error(
-      'Invalid mapping provided for ' .. tostring(self.handler) .. '. Only string and array of strings can be provided'
+      'Invalid mapping provided for ' .. tostring(self.handler) .. '. Only string and array of strings can be provided',
+      0
     )
   end
 

lua/orgmode/files/file.lua

@@ -389,7 +389,7 @@ end
 function OrgFile:get_closest_headline(cursor)
   local node = self:closest_headline_node(cursor)
   if not node then
-    error('No headline found')
+    error('No headline found', 0)
   end
   return Headline:new(node, self)
 end
@@ -504,12 +504,15 @@ end
 function OrgFile:get_valid_bufnr()
   local bufnr = vim.fn.bufnr(self.filename) or -1
   if bufnr < 0 then
-    error('[orgmode] No valid buffer for file ' .. self.filename .. ' to edit')
+    error('[orgmode] No valid buffer for file ' .. self.filename .. ' to edit', 0)
   end
   -- Do not consider unloaded buffers as valid
   -- Treesitter is not working in them
   if not vim.api.nvim_buf_is_loaded(bufnr) then
-    error('[orgmode] Cannot edit buffer ' .. tostring(bufnr) .. ' for file ' .. self.filename .. ', it is not loaded')
+    error(
+      '[orgmode] Cannot edit buffer ' .. tostring(bufnr) .. ' for file ' .. self.filename .. ', it is not loaded',
+      0
+    )
   end
   return bufnr
 end

lua/orgmode/objects/edit_special/init.lua

@@ -53,16 +53,16 @@ function EditSpecial:get_context(bufnr)
   local exists, ctx = pcall(vim.api.nvim_buf_get_var, bufnr or self.org_bufnr, self.context_var)
   ---@cast ctx table
   if not exists then
-    error({ message = 'Unable to find context for edit special action' })
+    error('Unable to find context for edit special action', 0)
   end
 
   if not vim.api.nvim_buf_is_valid(ctx.org_bufnr) then
-    error({ message = 'Org buffer associated with edit special no longer valid' })
+    error('Org buffer associated with edit special no longer valid', 0)
   end
 
   ctx.file = org.files:get(ctx.filename)
   if not ctx.file then
-    error({ message = 'Edit special callback with invalid file: ' .. (ctx.filename or '?') })
+    error('Edit special callback with invalid file: ' .. (ctx.filename or '?'), 0)
   end
 
   ctx.start_extmark_pos = vim.api.nvim_buf_get_extmark_by_id(ctx.org_bufnr, ctx.extmark_ns, ctx.start_extmark, {})

lua/orgmode/org/autocompletion/init.lua

@@ -34,7 +34,7 @@ end
 ---@param source OrgCompletionSource
 function OrgCompletion:add_source(source)
   if self.sources_by_name[source:get_name()] then
-    error('Completion source ' .. source:get_name() .. ' already exists')
+    error('Completion source ' .. source:get_name() .. ' already exists', 0)
   end
   self.sources_by_name[source:get_name()] = source
   table.insert(self.sources, source)

lua/orgmode/org/hyperlinks/init.lua

@@ -230,7 +230,7 @@ function Hyperlinks.insert_link(link_location)
     link_location = ('id:%s'):format(selected_link.url:get_id())
   end
 
-  local link_description = vim.trim(vim.fn.OrgmodeInput('Description: ', desc or ''))
+  local link_description = vim.trim(utils.input('Description: ', desc or ''))
 
   link_location = '[' .. vim.trim(link_location) .. ']'
 

lua/orgmode/org/links/init.lua

@@ -107,7 +107,7 @@ function OrgLinks:insert_link(link_location, desc)
     link_location = ('id:%s'):format(selected_link.url:get_path())
   end
 
-  local link_description = vim.trim(vim.fn.OrgmodeInput('Description: ', desc or ''))
+  local link_description = vim.trim(utils.input('Description: ', desc or ''))
 
   link_location = '[' .. vim.trim(link_location) .. ']'
 
@@ -148,7 +148,7 @@ end
 ---@param link_type OrgLinkType
 function OrgLinks:add_type(link_type)
   if self.types_by_name[link_type:get_name()] then
-    error('Link type ' .. link_type:get_name() .. ' already exists')
+    error('Link type ' .. link_type:get_name() .. ' already exists', 0)
   end
   self.types_by_name[link_type:get_name()] = link_type
   table.insert(self.types, link_type)

lua/orgmode/org/mappings.lua

@@ -9,12 +9,10 @@ local config = require('orgmode.config')
 local constants = require('orgmode.utils.constants')
 local ts_utils = require('orgmode.utils.treesitter')
 local utils = require('orgmode.utils')
-local fs = require('orgmode.utils.fs')
 local Table = require('orgmode.files.elements.table')
 local EventManager = require('orgmode.events')
 local events = EventManager.event
 local Babel = require('orgmode.babel')
-local ListItem = require('orgmode.files.elements.listitem')
 
 ---@class OrgMappings
 ---@field capture OrgCapture
@@ -48,7 +46,7 @@ function OrgMappings:set_tags(tags)
   local current_tags = utils.tags_to_string(headline:get_own_tags())
 
   if not tags then
-    tags = vim.fn.OrgmodeInput('Tags: ', current_tags, function(arg_lead)
+    tags = utils.input('Tags: ', current_tags, function(arg_lead)
       return utils.prompt_autocomplete(arg_lead, self.files:get_tags())
     end)
   elseif type(tags) == 'table' then
@@ -786,7 +784,7 @@ end
 -- currently on
 function OrgMappings:insert_link()
   local link = OrgHyperlink.at_cursor()
-  local link_location = vim.fn.OrgmodeInput('Links: ', link and link.url:to_string() or '', function(arg_lead)
+  local link_location = utils.input('Links: ', link and link.url:to_string() or '', function(arg_lead)
     return self.links:autocomplete(arg_lead)
   end)
   if vim.trim(link_location) == '' then

lua/orgmode/utils/init.lua

@@ -614,4 +614,15 @@ function utils.sorted_pairs(t)
   end
 end
 
+---@param prompt string
+---@param default? any
+---@param completion_fn? fun(arg_lead: string): string[]
+function utils.input(prompt, default, completion_fn)
+  local result = vim.fn.OrgmodeInput(prompt, default, completion_fn)
+  if result == vim.NIL then
+    error('Canceled.', 0)
+  end
+  return result
+end
+
 return utils

lua/orgmode/utils/treesitter/install.lua

@@ -87,7 +87,7 @@ function M.get_path(url)
   })
     :next(function(code)
       if code ~= 0 then
-        error('[orgmode] Failed to clone tree-sitter-org')
+        error('[orgmode] Failed to clone tree-sitter-org', 0)
       end
       return M.exe('git', {
         args = { 'checkout', ts_revision },
@@ -96,7 +96,7 @@ function M.get_path(url)
     end)
     :next(function(code)
       if code ~= 0 then
-        error('[orgmode] Failed to checkout to correct revision on tree-sitter-org')
+        error('[orgmode] Failed to checkout to correct revision on tree-sitter-org', 0)
       end
       return path
     end)
@@ -110,7 +110,7 @@ function M.run(url)
   end, M.compilers)[1]
 
   if not compiler then
-    error('[orgmode] No C compiler found for installing tree-sitter grammar')
+    error('[orgmode] No C compiler found for installing tree-sitter grammar', 0)
   end
 
   local compiler_args = M.select_compiler_args(compiler)
@@ -127,11 +127,11 @@ function M.run(url)
     end)
     :next(vim.schedule_wrap(function(code)
       if code ~= 0 then
-        error('[orgmode] Failed to compile parser')
+        error('[orgmode] Failed to compile parser', 0)
       end
       local renamed = vim.fn.rename(path .. '/parser.so', package_path .. '/parser/org.so')
       if renamed ~= 0 then
-        error('[orgmode] Failed to move generated tree-sitter parser to runtime folder')
+        error('[orgmode] Failed to move generated tree-sitter parser to runtime folder', 0)
       end
       utils.echo_info('Done!')
       return true

plugin/orgmode.vim

@@ -1,10 +1,16 @@
 " Wrapper around input() function that allows providing custom completion function
 " @see https://github.com/neovim/neovim/issues/16301#issuecomment-968247015
 function! OrgmodeInput(prompt, default, ...) abort
+  let opts = {
+        \ 'prompt': a:prompt,
+        \ 'default': a:default,
+        \ 'cancelreturn': v:null,
+        \ }
+
   if a:0 > 0
-    return input(a:prompt, a:default, 'customlist,'..get(a:1, 'name'))
+    let opts.completion = 'customlist,'..get(a:1, 'name')
   endif
-  return input(a:prompt, a:default)
+  return input(opts)
 endfunction
 
 function OrgmodeWatchDictChanges(dict, key, change_dict) abort

tests/minimal_init.lua

@@ -38,10 +38,7 @@ function M.load_plugin(plugin_name, plugin_url)
       install_destination,
     })
     if vim.v.shell_error > 0 then
-      error(
-        string.format('>> Failed to clone plugin: "%s" to "%s"!', plugin_name, install_destination),
-        vim.log.levels.ERROR
-      )
+      error(string.format('>> Failed to clone plugin: "%s" to "%s"!', plugin_name, install_destination), 0)
     end
   end
 end