Migration from contexts to functions

[ruicsh]

hi, are there any general guidelines on how to migrate code from old contexts configs to the new functions?

Example, I have a custom buffer context with an integration with snacks.picker.

contexts = {
    buffer = {
      description = "Pick a buffer to include in chat context.",
      input = function(callback)
          local chat_winid = vim.api.nvim_get_current_win()
          Snacks.picker.buffers({
              confirm = function(picker, item)
                  picker:close()
                  -- Return focus to the chat window
                  if vim.api.nvim_win_is_valid(chat_winid) then
                      vim.api.nvim_set_current_win(chat_winid)
                      vim.cmd("normal! a")
                  end
                  vim.schedule(function()
                      callback(item.buf)
                  end)
              end,
          })
       end,
    },
}

How do I migrate this to functions?

[deathbeam]

You have examples on how to transform callback functions to async functions in utils.lua, for this case I think it would look something like this:

functions = {
  buffer = {
    description = "Pick a buffer to include in chat context.",
    schema = {
      type = 'object',
      required = { 'name' },
      properties = {
        name = {
          type = 'string',
          description = 'Buffer number to include in chat context.',
          enum = function()
            local chat_winid = vim.api.nvim_get_current_win()
            local async = require('plenary.async')
            local fn = async.wrap(function(callback)
                Snacks.picker.buffers({
                  confirm = function(picker, item)
                      picker:close()
                      -- Return focus to the chat window
                      if vim.api.nvim_win_is_valid(chat_winid) then
                          vim.api.nvim_set_current_win(chat_winid)
                          vim.cmd("normal! a")
                      end
                      vim.schedule(function()
                          callback(item.buf)
                      end)
                  end,
              })
            end, 1)

            return fn()
          end,
        },
      },
    },
  }
}

and then ofc resolve function that accepts the input buffer number as input.name property.

I dont really want to bring back input because it was heavily limiting the plugin as it only supported single choices, where schema supports multiple, optional arguemnts etc (and that is important for tool calling but also for more advanced functions)

[ruicsh]

thanks, I got further with your help. But the return of that enum, still gets fed to a vim.ui.select. I already picked my buffer on the snacks.picker, don't need another picker. Maybe don't show the vim.ui.select if the enum returns only 1 value?

[deathbeam]

Ah i see what you mean. Yea i can just auto accept when enum returns only 1 item but this is quite weird use case, any reason why you arent just overriding vim.ui.select instead in this case?

[deathbeam]

Either way, your use case should now be supported: e632470

[ruicsh]

because I would like to use snacks.picker.buffers where I have a preview of the buffer's contents and some other customizations

[deathbeam]

Hmm makes sense i guess, the vim.ui.select api isnt the most flexible thing ever

[ruicsh]

hey, this was working for me yesterday night, now it stopped calling my custom enum with snacks.picker. Maybe have an optional customm value feeder function, sibling of enum?

Another reason why I'd like to use a custom picker, is because the default doesn't list hidden buffers only the active and the alternative.

[SamSaffron]

In case it is helpful, this is how I got telescope going, not sure if there is an easier way, I find the UI way nicer that stock config.

https://github.com/SamSaffron/dotfiles/blob/master/nvim/lua/plugins/ai.lua

functions = {
				file = {
					group = "copilot",
					uri = "file://{path}",
					description = "Reads content from a specified file path",
					schema = {
						type = "object",
						required = { "path" },
						properties = {
							path = {
								type = "string",
								description = "Path to file to include in chat context.",
								enum = function(source)
									local chat_winid = vim.api.nvim_get_current_win()
									local async = require("plenary.async")
									local fn = async.wrap(function(callback)
										local telescope = require("telescope.builtin")
										local actions = require("telescope.actions")
										local action_state = require("telescope.actions.state")

										telescope.find_files({
											cwd = source.cwd(), -- Use source working directory
											attach_mappings = function(prompt_bufnr)
												actions.select_default:replace(function()
													actions.close(prompt_bufnr)
													local selection = action_state.get_selected_entry()

													-- Return focus to the chat window
													if vim.api.nvim_win_is_valid(chat_winid) then
														vim.api.nvim_set_current_win(chat_winid)
														vim.cmd("normal! a")
													end

													vim.schedule(function()
														callback(selection)
													end)
												end)
												return true
											end,
										})
									end, 1)

									return fn()
								end,
							},
						},
					},
					resolve = function(input, source)
						local utils = require("CopilotChat.utils")
						local resources = require("CopilotChat.resources")

						-- Handle relative path - make it absolute for reading
						local full_path = input.path
						if not vim.startswith(full_path, "/") then
							full_path = source.cwd() .. "/" .. input.path
						end

						utils.schedule_main()
						local data, mimetype = resources.get_file(full_path)
						if not data then
							error("File not found: " .. input.path)
						end

						return {
							{
								uri = "file://" .. input.path, -- Keep relative path in URI
								mimetype = mimetype,
								data = data,
							},
						}
					end,

Note that telescope has an API for multiple file picking but I am not sure if this API can support it cause enum needs to return only 1 thing, and we would need something in the engine to go from:

#file:....

⏬

#file:file1
#file:file2
#file:file3

cause multi files in one line would be very noise visually.