hawtkeys.nvim

What is this?

hawtkeys.nvim is a nvim plugin for finding and suggesting memorable and easy to press keys for your nvim shortcuts. It takes into consideration keyboard layout, easy to press combinations and memorable phrases, and excludes already mapped combinations to provide you with suggested keys for your commands

Getting Started

Installation instructions to follow, but as usual with package managers

return {
"tris203/hawtkeys.nvim",
config = true,
}

Config

The default config is below, but can be changed by passing a table in config with the options

• leader is your current leader key (This will be automatic in future
• homerow is the numerical representation of the home row in your keyboard layout
• powerFingers contains which fingers are prefered for keystrokes, counted from a 0 index reading left to right. 0, 1, 2 ..9.
• keyboardLayout is the layout, currently only QWERTY is defined. More to follow
• keymap, duh

{
    leader = " "
    homerow = 2
    powerFingers = { 2, 3, 6, 7 }
    keyboardLayout = "qwerty",
}

Usage

Searching New Keymaps

There are two interfaces to hawtkeys, the first allows you to Search For Keymaps:

:Hawtkeys

This will allow you to search keybinds as below:

Show All Existing Keymaps

:HawtkeysAll

This will launch a window showing all existing keymaps collected from Neovim bindings and from anlysis of your config file.

Showing Duplicate Keymaps

HawtkeysDupes

Will show potential duplicate keymaps, where you have accidently set the same key for two different things. This can be useful for tracking down issues with plugins not functioning correctly

Current Issues

• Currently on large configs, the search can take a while to iterate through your config.
• Where a custom remap function is used, keymaps may be missed.

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

If there is something specific you want to work on then, please open an issue/discussion first to avoid duplication of efforts

Outstanding items are currently in the TODO.md file.

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

Pre-Push Hook

There is a pre-push hook present in .githooks/pre-push.sh. This can be symlinked to .git/hooks/pre-push.

This will ensure that the same checks that will be run in CI are run when you push.