feat(config): modern keymap format + mode support

[cameronr]

Here's the updated PR to have global and window keymaps be key first.

I went back and forth on it, but I currently have window permissions split out into their own table and have them action first. (but if you want it the other way, I can change it so they're also key first).

[sudo-tee]

Really great PR.

I only added some small comments about the format and about splitting input_window and output_window keymaps and using editor instead of global (the editor part is just to make it easier to transition). this should really simplify old format detection and keymap applying.

We could support custom function as well so users can plug whatever they want in there :)

I know the format changed a little bit since the last PR.. But I want to be sure we make it right and future-proof and also make it easy to maintain.

But for the rest this is a really great PR and it tackle a really core aspect of the plugin in a elegant way :).

With this last round of fixes it will be ready to merge

Thanks for your effort on this. It's really appreciated

Here is a recap of the updated format that I think we should go with

  keymap = {
    editor = {
      ['<leader>og'] = { 'toggle' }, -- I don't think we really need to support just string, it makes things more complex for nothing
      ['<leader>oi'] = { 'open_input' },
      ['<leader>oI'] = { 'open_input_new_session' },
      ['<leader>oo'] = { 'open_output' },
      ['<leader>ot'] = { 'toggle_focus' },
      ['<leader>oq'] = { 'close' },
      ['<leader>os'] = { 'select_session' },
      ['<leader>op'] = { 'configure_provider' },
      ['<leader>od'] = { 'diff_open' },
      ['<leader>o]'] = { 'diff_next' },
      ['<leader>o['] = { 'diff_prev' },
      ['<leader>oc'] = { 'diff_close' },
      ['<leader>ora'] = { 'diff_revert_all_last_prompt' },
      ['<leader>ort'] = { 'diff_revert_this_last_prompt' },
      ['<leader>orA'] = { 'diff_revert_all' },
      ['<leader>orT'] = { 'diff_revert_this' },
      ['<leader>orr'] = { 'diff_restore_snapshot_file' },
      ['<leader>orR'] = { 'diff_restore_snapshot_all' },
      ['<leader>oC'] = { 'open_configuration_file' },
      ['<leader>ox'] = { 'swap_position' },
      ['<leader>opa'] = { 'permission_accept' },
      ['<leader>opA'] = { 'permission_accept_all' },
      ['<leader>opd'] = { 'permission_deny' },
    },
    output_window = {
      ['<leader>something'] = {function () 
                   -- custom code
      end},
      ['<esc>'] = { 'close' },
      ['<C-c>'] = { 'stop' },
      [']]'] = { 'next_message' },
      ['[['] = { 'prev_message' },
      ['<tab>'] = { 'toggle_pane', mode = { 'n', 'i' } },
      ['<C-i>'] = { 'focus_input' },
      ['<leader>oS'] = { 'select_child_session' },
      ['<leader>oD'] = { 'debug_message' },
      ['<leader>oO'] = { 'debug_output' },
      ['<leader>ods'] = { 'debug_session' },
    },
    input_window = {
      ['<cr>'] = { 'submit_input_prompt', mode = { 'n', 'i' } },
      ['<esc>'] = { 'close' },
      ['<C-c>'] = { 'stop' },
      ['~'] = { 'mention_file', mode = 'i' },
      ['@'] = { 'mention', mode = 'i' },
      ['/'] = { 'slash_commands', mode = 'i' },
      ['<tab>'] = { 'toggle_pane', mode = { 'n', 'i' } },
      ['<up>'] = { 'prev_prompt_history', mode = { 'n', 'i' } },
      ['<down>'] = { 'next_prompt_history', mode = { 'n', 'i' } },
      ['<M-m>'] = { 'switch_mode' },
      ['<leader>oS'] = { 'select_child_session' },
      ['<leader>oD'] = { 'debug_message' },
      ['<leader>oO'] = { 'debug_output' },
      ['<leader>ods'] = { 'debug_session' },
    },
    permission = {
      accept = 'a',
      accept_all = 'A',
      deny = 'd',
    },

[cameronr]

Thanks for all of the comments. Totally agree on getting the format right now so it's worth extra effort to get it there. I also had the same thought about the need to support functions in keymaps (I want my submit keymap, , to also exit insert mode). I also wondered if it made sense to split input / output keymaps but wasn't sure... seeing it now, it's definitely much cleaner!

I'll take a look at all of the comments later today.

[cameronr]

@sudo-tee Ok, I think I incorporated all of the feedback. Let me know if there's anything else I should change.

[cameronr]

Oh yeah, a few notes:

1. config.lua mentions an api for open_configuration_file but it's missing so there's a warning about that keymap

2. providers and custom_commands are missing from config. I marked them as optional in types but wanted to confirm that's right. Maybe it's better to give them default settings in config?

3. There are also a number of missing fields from context. Should those fields be marked as optional or should there be defaults provided?

4. completion.file_sources is missing cache_timeout

[sudo-tee]

1. config.lua mentions an api for open_configuration_file but it's missing so there's a warning about that keymap

This is a legacy option you can remove it.

1. providers and custom_commands are missing from config. I marked them as optional in types but wanted to confirm that's right. Maybe it's better to give them default settings in config?

Also legacy stuff I forgot to remove

1. There are also a number of missing fields from context. Should those fields be marked as optional or should there be defaults provided?

This one puzzled me. It comes from another PR I merged, they can be removed they are not used.

1. completion.file_sources is missing cache_timeout

Also comes from a PR I merged without noticing.. It can be removed also

[sudo-tee]

@sudo-tee Ok, I think I incorporated all of the feedback. Let me know if there's anything else I should change.
@cameronr I only found 1 issue which is in the keymap normalization

You should filter them by using the function name from the new config. so only the relevant keymaps are applied to the window. Now both window receives all the keymaps.

you can get the function names with a function like this

--- Get function names from keymap config
local function get_function_names(keymap_config)
  local names = {}
  for _, config in pairs(keymap_config) do
    if type(config) == 'table' and config[1] then
      table.insert(names, config[1])
    end
  end
  return names
end


local function normalize_keymap(legacy_config, filter_functions)
  local converted = {}
  for func_name, key in pairs(legacy_config) do
    local api_name = func_name == 'submit' and 'submit_input_prompt' or func_name
    if not filter_functions or vim.tbl_contains(filter_functions, api_name) then
      converted[key] = { api_name }
    end
  end
  return converted
end

and apply them like this

 if opts.keymap.window then
      opts.keymap.input_window = normalize_keymap(opts.keymap.window, get_function_names(values.keymap.input_window))
      opts.keymap.output_window = normalize_keymap(opts.keymap.window, get_function_names(values.keymap.output_window))
    end

A part from that I'm ready to merge after this tiny fix.

Thanks again :)

[sudo-tee]

Amazing work I fixed a small error I was getting when migrating the old format.

I just merged the PR