Feat: Keymaps and Keys App - Githubissues

tconbeer / harlequin

The SQL IDE for Your Terminal.

https://harlequin.sh

MIT License

3.3k stars 76 forks source link

Feat: Keymaps and Keys App #580

Closed tconbeer closed 1 week ago

tconbeer commented 1 week ago

Closes #541

What are the key elements of this solution?

This ended up being a huge feature:

Refactored (and improved typing of) Config files + types
Created named "actions" that can be referenced by key bindings
Created key bindings and key map types
Replaced static BINDINGS class vars with dynamic binding mechanism
Discover keymap plug-ins and user-defined (TOML) keymaps
Load (and merge) the keymap(s) depending on config
Bind keys to actions on widgets as they are mounted
Create a vscode keymap plug-in for harlequin defaults
Create a (kind of complicated) app to create keymaps
Update the help screen and the online docs

Does this PR require a change to Harlequin's docs?

[ ] No.
[x] Yes, and I have opened a PR at tconbeer/harlequin-web.
[ ] Yes; I haven't opened a PR, but the gist of the change is: ...

Did you add or update tests for this change?

[x] Yes.
[ ] No, I believe tests aren't necessary.
[ ] No, I need help with testing this change.

Please complete the following checklist:

[x] I have added an entry to CHANGELOG.md, under the [Unreleased] section heading. That entry references the issue closed by this PR.