Add description to key binds

[Moerliy]

Describe your PR, what does it fix/add?

I'm bad at remembering key binds and was always a fan of nvim plugins like which key. For something like this, a way of describing your key binds is necessary.

My proposal would look something like this:

bind = SUPER, T, "open my terminal", exec, kitty

but obviously, it should be backward compatible so this should also be no problem:

bind = SUPER, T, exec, kitty

Is there anything you want to mention? (unchecked code, possible bugs, found problems, breaking compatibility, etc.)

Working with any bind the description would always come after the KEY (so at index 2) and the indicator would be double quotes. I think some kind of indicator is needed to distinguish it from the dispatcher options.

Is it ready for merging, or does it need work?

Feedback is wanted but it's merge ready from my end.

closes #6357

[vaxerski]

why not add a flag for description like bindd?

Also, this will break with descriptions with ,

[Moerliy]

why not add a flag for description like bindd?

Good idea, to get ridge of " inside the key bind itself

Also, this will break with descriptions with ,

Yeah. had that in the back of my mind too. First reaction was to just use the docs to let the users know they shouldn't use the delimiter in the description.
I couldn't come up with a solution. It's the delimiter.
As far as I'm aware you can only get away with using the delimiter in the args part of the bind.
@vaxerski

[vaxerski]

yes, because we limit the amount of arguments to 4, so anything after the 3rd , is treated as one. With this, you can't do it. I'm fine with mentioning that , is not allowed in descriptions, but a flag would be nice.

Also, no need to ping, I have notifications on, you know.

[Moerliy]

I've added hyprctl functionality too now but I have a question on how you want the description to be handled.

1. It can either be always in the printout and if there is no description it will have an empty value. Similar to args.
2. Or we use the description flag to find out if there should be a description Key-Value pair or not.

Pro of the lather: Would be more in line with how it should be in my opinion, especially with the JSON out.
Con: more complex code where it isn't needed and people don't care if it's an empty string or no Key-Value pair.

The current implementation is the first.

[vaxerski]

for json you can omit the k-v if it's not set, but it doesn't matter.

Request review when you've done it the way you prefer

[Moerliy]

for json you can omit the k-v if it's not set, but it doesn't matter.

then it's fine with me 👍

I did the docs real quick too so I would say this PR and the docs PR are ready to review.
I can't assign a review tho or maybe I'm just too blind.

[Moerliy]

Alright, let's try this again.

[vaxerski]

rest lgtm

[vaxerski]

thanks!

[gksudolol]

I get an invalid dispatcher error when firing up hyprland from this commit with:

bindm = $mainMod, mouse:273, resizewindow

specifically with resizewindow, any other dispatcher works fine (this doesn't occur with the commit before)

[Moerliy]

I'm not sure here, but there really is no dispatcher called resizewindow but one resizewindowpixel.
Does the second one do what you are after?

[MightyPlaza]

I'm not sure here, but there really is no dispatcher called resizewindow but one resizewindowpixel. Does the second one do what you are after?

mouse dispatcher

[nonetrix]

Yep same

[Moerliy]

Oh yeah, my bad. Found it. I did a push to my fork and I can also provide a patch if you want.