feat(nui): allow callbacks in nui input with option

[pysan3]

We already have an option to default to normal mode in nui inputs.
config.enable_normal_mode_for_inputs

However, it looks like users want more power of customization to the details. (#1371)

So why not just let users do whatever they want with absolute power?

All function/string/table are considered true-thy so this will cover backwards compatibility.

[pysan3]

Usecase:

Move cursor right before the extension and start insert mode.

config.enable_normal_mode_for_inputs = ":exe 'norm F.' | :startinsert"

[cseickel]

Usecase:

Move cursor right before the extension and start insert mode.

config.enable_normal_mode_for_inputs = ":exe 'norm F.' | :startinsert"

😱 In this example you're using an option called enable_normal_mode_for_inputs to startinsert mode. 😱

I think we already have a generic solution that would be perfect, which is the event system. In a quick attempt I could not get the existing NEO_TREE_POPUP_BUFFER_ENTER event to work for this situation, but I think either modifying the timing of NEO_TREE_POPUP_BUFFER_ENTER or adding a new event which fires at the appropriate time is the correct way to create a generic solution. Maybe NEO_TREE_POPUP_INPUT_READY would be a good event name.

[pysan3]

Usecase:
Move cursor right before the extension and start insert mode.

config.enable_normal_mode_for_inputs = ":exe 'norm F.' | :startinsert"

😱 In this example you're using an option called enable_normal_mode_for_inputs to startinsert mode. 😱

Yeah 🎉 That's what I mean by absolute power lol. I plan to not document this anywhere so it's absolutely to the users own risk to do anything.

I think we already have a generic solution that would be perfect, which is the event system. In a quick attempt I could not get the existing NEO_TREE_POPUP_BUFFER_ENTER event to work for this situation, but I think either modifying the timing of NEO_TREE_POPUP_BUFFER_ENTER or adding a new event which fires at the appropriate time is the correct way to create a generic solution. Maybe NEO_TREE_POPUP_INPUT_READY would be a good event name.

NEO_TREE_POPUP_BUFFER_ENTER This won't work as stopinsert is called way after buffer creation or even input:mount, and it's inside a vim.schedule which will delay it even more. The only way would be to defer_fn a couple of ms but that's really not good...

Creating a new event is also a good option, but the codebase is the same for confirm (used with eg delete (y/n) or change_cwd) and input (like add, copy etc).
I don't want to run the same event for those cases..

[pysan3]

@cseickel Updated.

Regarding this change, I deprecated the enable_normal_mode_for_inputs option and added it to migrations.

As I wanted to give more information on how to migrate, I changed the migration module to be able to add descriptions in the buffer.

Besides, now bullet point for each change doesn't make much sense, so I changed it to use level 2 header ## Header 2 instead for each value.

[cseickel]

It is definitely nice to be able to add a longer description to deprecations.

One thing I was considering is that I think it is more standard for plugins to have a start_in_insert_mode configuration for these situations. Maybe we should do the same and change the config option to start_inputs_in_insert_mode = false instead? Then we can keep the event for more advanced configuration but also have the simple one which is pretty standard.

What do you think?

[pysan3]

I don't quite like when behavior before event handler execution changes by a different option in the config.

If you have an option to alter the behavior other than NEO_TREE_POPUP_INPUT_READY, I'd need to mention that in the docs with if ... otherwise ...

When people asks how to do xxx in the popup, I need to instruct; if you have config.start_inputs_in_insert_mode to true, then set this handler, and if false, set this handler.

I'd prefer to have the handler start consistently, either always from insert mode or always from normal mode.

[cseickel]

When people asks how to do xxx in the popup, I need to instruct; if you have config.start_inputs_in_insert_mode to true, then set this handler, and if false, set this handler.

OK, fair enough. In that case, we stick with your idea.

[cseickel]

Sorry for the delay on this one. LGTM.

[Sologala]

@pysan3 Hello, I update to release 3.19. The prompted NeoTree migrations reports some Error

E5108: Error executing lua ...m/lazy/neo-tree.nvim/lua/neo-tree/setup/deprecations.lua:18: Invalid option name: 'wrap'
stack traceback:
        [C]: in function 'nvim_buf_set_option'
        ...m/lazy/neo-tree.nvim/lua/neo-tree/setup/deprecations.lua:18: in function 'show_migrations'
        ...re/nvim/lazy/neo-tree.nvim/lua/neo-tree/command/init.lua:51: in function 'execute'
        ...re/nvim/lazy/neo-tree.nvim/lua/neo-tree/command/init.lua:169: in function '_command'
        [string ":lua"]:1: in main chunk

Do you know how to fix it or find more clues?

[pysan3]

@Sologala
I'm so sorry: #1387

Please wait for the next release (which should happen right away).

You should see something like this so please follow the instructions.

[cseickel]

The fix was just released as 3.20.

[Sologala]

@pysan3 @cseickel Thx for update, My neo-tree work delicately again!

[rrrix]

@pysan3 I think you forgot to remove enable_normal_mode_for_inputs from defaults.lua. I'm still getting a deprecation/migration notification on every startup, despite no use of this key in any configuration file.

The only location I can find where enable_normal_mode_for_inputs is being set is in defaults.lua:

neo-tree.nvim/lua/neo-tree/defaults.lua

Line 22 in d8b4687

enable_normal_mode_for_inputs = false, -- Enable normal mode for input dialogs.

I believe this is because the removed(key, desc) checks for nil, and false is not nil.

neo-tree.nvim/lua/neo-tree/setup/deprecations.lua

Lines 61 to 68 in d8b4687

	local removed = function(key, desc)
	local value = utils.get_value(config, key)
	if type(value) ~= "nil" then
	utils.set_value(config, key, nil)
	migrations[#migrations + 1] =
	string.format("The `%s` option has been removed.\n%s", key, desc or "")
	end
	end

$ lua
Lua 5.4.6  Copyright (C) 1994-2023 Lua.org, PUC-Rio
> foo = false
> foo ~= nil
true
> foo = nil
> foo ~= nil
false

Commenting out enable_normal_mode_for_inputs fixes the erroneous migration notification.

[pysan3]

My bad. Thank you @rrrix

[davawen]

I may be missing a basic command, but can I make it such that I enter the popup in insert mode, but pressing escape puts me in normal mode (instead of leaving the popup) ?

That's the behavior I'm getting from other popups.

[pysan3]

@davawen

Map "i", "<Esc>" to vim.cmd.stopinsert in the event. There's the exact example in :h neo-tree-events for you but you need to update to the latest main branch (not yet include in the latest release iirc).