feat(ask): end prompt with \n or press <C-CR> to append instead of submit

also consolidates the `opts.select.prompts` default ask entries into
just one because this captures that flexibility better

Author: nickjvandyke

README.md

@@ -34,7 +34,7 @@ Integrate the [opencode](https://github.com/sst/opencode) AI assistant with Neov
   config = function()
     ---@type opencode.Opts
     vim.g.opencode_opts = {
-      -- Your configuration, if any — see `lua/opencode/config.lua`, or "goto definition" on the type or field.
+      -- Your configuration, if any. Goto definition on the type or field for details.
     }
 
     -- Required for `opts.events.reload`.
@@ -266,7 +266,10 @@ Input a prompt for `opencode`.
 - Press `<Up>` to browse recent asks.
 - Highlights and completes contexts and `opencode` subagents.
   - Press `<Tab>` to trigger built-in completion.
-  - Registers `opts.ask.blink_cmp_sources` when using `snacks.input` and `blink.cmp`.
+- End the prompt with `\n` to append instead of submit.
+- Additionally, when using `snacks.input`:
+  - Press `<C-CR>` to append instead of submit. 
+  - When using `blink.cmp`, registers `opts.ask.blink_cmp_sources`.
 
 ### 📝 Select — `require("opencode").select()`
 

lua/opencode.lua

@@ -6,7 +6,10 @@ local M = {}
 --- - Press the up arrow to browse recent asks.
 --- - Highlights and completes contexts and `opencode` subagents.
 ---   - Press `<Tab>` to trigger built-in completion.
----   - Registers `opts.ask.blink_cmp_sources` when using `snacks.input` and `blink.cmp`.
+--- - End the prompt with `\n` to append instead of submit.
+--- - Additionally, when using `snacks.input`:
+---   - Press `<C-CR>` to append instead of submit.
+---   - When using `blink.cmp`, registers `opts.ask.blink_cmp_sources`.
 ---
 ---@param default? string Text to pre-fill the input with.
 ---@param opts? opencode.api.prompt.Opts Options for `prompt()`.
@@ -17,6 +20,16 @@ M.ask = function(default, opts)
   return require("opencode.ui.ask")
     .ask(default, opts.context)
     :next(function(input) ---@param input string
+      -- TODO: Should we remove `opts.clear` and `opts.submit` in favor of just checking if the input ends with `\n`?
+      -- (maybe even in `prompt()` itself?)
+      -- Confusing to have both.
+      -- I think it's better, but don't love the breaking change.
+      -- Although for most users, I imagine they just use `opts.submit = false` and thus won't be affected.
+      if input:sub(-2) == "\\n" then
+        input = input:sub(1, -3)
+        opts.clear = false
+        opts.submit = false
+      end
       opts.context:clear()
       return require("opencode.api.prompt").prompt(input, opts)
     end)

lua/opencode/config.lua

@@ -58,8 +58,7 @@ local defaults = {
     ["@grapple"] = function(context) return context:grapple_tags() end,
   },
   prompts = {
-    ask_append = { prompt = "", ask = true }, -- Handy to insert context mid-prompt. Simpler than exposing every context as a prompt by default.
-    ask_this = { prompt = "@this: ", ask = true, submit = true },
+    ask = { prompt = "", ask = true, submit = true },
     diagnostics = { prompt = "Explain @diagnostics", submit = true },
     diff = { prompt = "Review the following git diff for correctness and readability: @diff", submit = true },
     document = { prompt = "Add comments documenting @this", submit = true },
@@ -80,6 +79,23 @@ local defaults = {
         relative = "cursor",
         row = -3, -- Row above the cursor
         col = 0, -- Align with the cursor
+        keys = {
+          i_cr = {
+            desc = "submit",
+          },
+          i_c_cr = {
+            "<c-cr>",
+            function(win)
+              -- Append `\n` to leverage `ask()`'s auto-append behavior in that case
+              local text = win:text() .. "\\n"
+              vim.api.nvim_buf_set_lines(win.buf, 0, -1, false, { text })
+              win:execute("confirm")
+            end,
+            mode = "i",
+            desc = "append",
+          },
+        },
+        footer_keys = { "<cr>", "<c-cr>" },
       },
     },
   },
@@ -174,6 +190,15 @@ local defaults = {
 ---@type opencode.Opts
 M.opts = vim.tbl_deep_extend("force", vim.deepcopy(defaults), vim.g.opencode_opts or {})
 
+local snacks_ok, snacks = pcall(require, "snacks")
+---@cast snacks Snacks
+if not snacks_ok or not snacks.config.get("input", {}).enabled then
+  -- Even though it has no effect, passing these opts to the native `vim.ui.input` will error because
+  -- they mix string and integer keys which Neovim doesn't support in `vim.g` (see comment on `vim.g.opencode_opts`),
+  -- and Neovim's native `vim.ui.select` implementation apparently uses those.
+  M.opts.ask.snacks = {}
+end
+
 -- Allow removing default `contexts` and `prompts` by setting them to `false` in your user config.
 -- TODO: Add to type definition, and apply to `opts.select.commands`.
 local user_opts = vim.g.opencode_opts or {}

lua/opencode/provider/snacks.lua

@@ -21,11 +21,12 @@ end
 ---Check if `snacks.terminal` is available and enabled.
 function Snacks.health()
   local snacks_ok, snacks = pcall(require, "snacks")
+  ---@cast snacks Snacks
   if not snacks_ok then
     return "`snacks.nvim` is not available.", {
       "Install `snacks.nvim` and enable `snacks.terminal.`",
     }
-  elseif not snacks and snacks.config.get("terminal", {}).enabled then
+  elseif not snacks.config.get("terminal", {}).enabled then
     return "`snacks.terminal` is not enabled.",
       {
         "Enable `snacks.terminal` in your `snacks.nvim` configuration.",