feature: support for mouse menus

[airtonix]

Started over here: #665 (reply in thread)

Neovim has some kind of api for right click context menu. Not surehow to use it myself, but it seems like we should be able to compose a set of commands for a variety of contexts and scenarios.

A good start might be to :

• compose a function that given some context, emits a collection of valid mousemenu entries
• create documentation that shows people how to compose their own NeoTree specific mousemenu enties

Contex should respond to the file/folder we clicked and any meta data it has that neotree knows about.

Entries to show would be anything in the ? popup that's relevant to the type of thing we're right clicking on.

[Atreyu-94]

Any advance here?

[nhat-vo]

@airtonix @Atreyu-94 Tbh we don't really have time to implement this right now. If anyone is willing to, please feel free and go ahead, this seems to be a great feature!

[Atreyu-94]

Thanks, I'm not very well on this, but maybe this can help:
https://gitlab.com/gabmus/nvpunk/-/blob/master/lua/nvpunk/internals/context_menu.lua#L131
Anyway I'll try to do it and if I get some advance, I'll share it here :)

[airtonix]

@Atreyu-94 oh wow... So yeah, as a proof of concept, i copied all these three files:

• https://gitlab.com/gabmus/nvpunk/-/blob/master/lua/nvpunk/internals/keymapper.lua
• https://gitlab.com/gabmus/nvpunk/-/blob/master/lua/nvpunk/internals/nonfile.lua
• https://gitlab.com/gabmus/nvpunk/-/blob/master/lua/nvpunk/internals/context_menu.lua

I'm using astronvim, so I copied these into:

~/.config/nvim/lua/user/core
├── context_menu.lua
├── keymapper.lua
└── nonfile.lua

• within context_menu.lua renamed the imports to user.core.keymapper, user.core.nonfile
• within the polish function in ~/.config/nvim/lua/user/init.lua inserted require("user.core.context_menu").setup()

reloaded and this is what I get now: (I am using my mouse here, but you can't see my mouse cursor because there's a bug with gnome-shell screen recording with X11)

Screencast.from.2023-05-06.09-39-08.webm

Looks like I just need to update all the commands it binds.

🎉

[airtonix]

So i cleaned it up (subjective i guess)

• Popup library: https://github.com/airtonix/mouse-peasant.nvim/blob/4f476d41d4f204f22d09e140d982297774fb96eb/core/context_menu.lua
• A menu for neotree: https://github.com/airtonix/mouse-peasant.nvim/blob/4f476d41d4f204f22d09e140d982297774fb96eb/menus/neotree.lua
• Kick it all off: https://github.com/airtonix/mouse-peasant.nvim/blob/4f476d41d4f204f22d09e140d982297774fb96eb/init.lua#L89

Not sure if this should be part of the neotree repo. I mean not until something like the above becomes some sort of ubiquitous neovim plugin, at which point neotree would just supple a menu definition that people can use to compose their own menus.