jokajak / keyseer.nvim

Neovim plugin to display which keys have keymaps assigned

Hi there 👋

• 🔭 I’m currently working on automating my home services following gitops principles.

keyseer.nvim's Issues

Add key highlighting if the key has a mapping assigned to it for the selected mode

When displaying the keyboard, color keys that have a mapping for the selected mode ("normal") by default.

feature: add key usage statistics

Describe the problem

Add a key usage statistics output so I know how many keys I have used or have available.

Describe the solution

Something that shows X keys used out of Y total available.

Multiple Errors when trying to run `:KeySeer`

Description

three different errors/messages, (the first one multiple times), and then the popup window from keyseer is completely empty.

   Info  15:20:51 notify.info keyseer.nvim Found more than one keycode in a keystring, this shouldn't happen.
   Info  15:20:51 notify.info keyseer.nvim Found more than one keycode in a keystring, this shouldn't happen.
   Info  15:20:51 notify.info keyseer.nvim Found more than one keycode in a keystring, this shouldn't happen.
   Info  15:20:51 notify.info keyseer.nvim Found more than one keycode in a keystring, this shouldn't happen.
   Info  15:20:51 notify.info keyseer.nvim Found more than one keycode in a keystring, this shouldn't happen.
   Info  15:20:51 notify.info keyseer.nvim Found more than one keycode in a keystring, this shouldn't happen.
   Info  15:20:51 notify.info keyseer.nvim Found more than one keycode in a keystring, this shouldn't happen.
   Info  15:20:51 notify.info keyseer.nvim Found more than one keycode in a keystring, this shouldn't happen.
   Info  15:20:51 notify.info keyseer.nvim Found more than one keycode in a keystring, this shouldn't happen.
   Info  15:20:51 notify.info keyseer.nvim Found more than one keycode in a keystring, this shouldn't happen.
   Info  15:20:51 notify.info keyseer.nvim Found more than one keycode in a keystring, this shouldn't happen.
   Info  15:20:51 notify.info keyseer.nvim Found more than one keycode in a keystring, this shouldn't happen.
   Info  15:20:51 notify.info keyseer.nvim Found more than one keycode in a keystring, this shouldn't happen.
   Info  15:20:51 notify.info keyseer.nvim Found more than one keycode in a keystring, this shouldn't happen.
   Info  15:20:51 notify.info keyseer.nvim Found more than one keycode in a keystring, this shouldn't happen.
   Info  15:20:51 notify.info keyseer.nvim Found more than one keycode in a keystring, this shouldn't happen.
   Info  15:20:51 notify.info keyseer.nvim Found more than one keycode in a keystring, this shouldn't happen.
   Info  15:20:51 notify.info keyseer.nvim Found more than one keycode in a keystring, this shouldn't happen.
   Info  15:20:51 notify.info keyseer.nvim Found more than one keycode in a keystring, this shouldn't happen.
   Info  15:20:51 notify.info keyseer.nvim No keycode found for <BS>
   Error  15:20:51 msg_show.lua_error    KeySeer Error executing Lua callback: ...hare/nvim/lazy/keyseer.nvim/lua/keyseer/keymaps/init.lua:243: table index is nil
stack traceback:
	...hare/nvim/lazy/keyseer.nvim/lua/keyseer/keymaps/init.lua:243: in function 'get_current_keycaps'
	...are/nvim/lazy/keyseer.nvim/lua/keyseer/ui/panes/home.lua:25: in function 'render'
	...l/share/nvim/lazy/keyseer.nvim/lua/keyseer/ui/render.lua:34: in function 'update'
	...cal/share/nvim/lazy/keyseer.nvim/lua/keyseer/ui/init.lua:158: in function 'update'
	...cal/share/nvim/lazy/keyseer.nvim/lua/keyseer/ui/init.lua:77: in function 'show'
	....local/share/nvim/lazy/keyseer.nvim/lua/keyseer/init.lua:47: in function <....local/share/nvim/lazy/keyseer.nvim/lua/keyseer/init.lua:24>

Steps to reproduce

• default options
• Run :KeySeer

I have a lot of keybindings ( ~ 1000 lines), which probably matters here

Expected behavior

no errors

Environment

neovim 0.9.1 (homebrew)
neovide 0.10.4 (homebrew)
macOS 13.4.1 (M1)
keyseer: latest

Make movement in the window more natural

Navigating through the window should be natural, specifically movement should be between keycaps rather than individual characters.

Add vim command to display the window

Invalid mode specifed on running KeySeer command

my lazy.nvim setting

  { "jokajak/keyseer.nvim", version = "*", cmd = "KeySeer", config = true },

fix highlight padding

When highlight padding includes rows above and below a keycap character the highlights are not always correct.

In the diagram, the w key is highlighted correctly but the row above the w key is not.

Make the display prettier by adding a border around it

Make the display look nicer by adding a border around it.

Enhance display window to allow selecting a key to display a pop-up window with keymapping information

It would be nice if I could press on a key to have it display information about the mapping that's associated:

• description
• ??

Add space row to layout

Add a space row to the layout to capture keymaps that start with space.

┌─────┬───┬───┬───┬───┬───┬───┬───┬───┬───┬───┬───┬───┬────────┐
│  `  │ 1 │ 2 │ 3 │ 4 │ 5 │ 6 │ 7 │ 8 │ 9 │ 0 │ - │ = │  <BS>  │
├─────┴───┼───┼───┼───┼───┼───┼───┼───┼───┼───┼───┼───┼───┬────┤
│  <TAB>  │ q │ w │ e │ r │ t │ y │ u │ i │ o │ p │ [ │ ] │  \ │
├────────┬┴──┬┴──┬┴──┬┴──┬┴──┬┴──┬┴──┬┴──┬┴──┬┴──┬┴──┬┴───┴────┤
│ <CAPS> │ a │ s │ d │ f │ g │ h │ j │ k │ l │ ; │ ' │ <ENTER> │
├────────┴──┬┴──┬┴──┬┴──┬┴──┬┴──┬┴──┬┴──┬┴──┬┴──┬┴──┬┴─────────┤
│  <SHIFT>  │ z │ x │ c │ v │ b │ n │ m │ , │ . │ / │  <SHIFT> │
├────────┬──┴───┴──┬┴───┴──┬┴───┴───┴───┴───┴─┬─┴───┴─┬────────┤
│ <CTRL> │ <SUPER> │ <ALT> │     <SPACE>      │ <ALT> │ <CTRL> │
└────────┴─────────┴───────┴──────────────────┴───────┴────────┘

Add display option to combine different modes together

It would be neat if the keyboard could indicate how many modes have a mapping for the same key.

Perhaps it could be a gradient from red to green where the number of mappings controls the color:

• green = 0 mappings
• red = all the mappings

Refactor layouts

Refactor the layouts.lua so it's easier to understand the phases of the rendering.

I think it would be nice to define a keyboard layout, e.g. the number of characters on each row and the number of rows separate from the keycaps on each key.