nvimdev / nvimdev/lspsaga.nvim

Keymap help/reference list for the various modules

Open
#1,545 0 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement
Dominant language
Lua
Stars
3.8k
Forks
308
PR merge metrics
No merged PRs in 30d

Description

Hey @nvimdev. First and foremost, thanks a lot for your work on this awesome plugin. I've only recently started using lspsaga extensively and I am really enjoying it.

Is your feature request related to a problem? Please describe.
However, when using modules that open floating windows (and have a bunch of keymaps) I tend to forget the default keymaps and have to constantly check the documentation. I know that I can just remap the keys, but I will probably just forget all but the most commonly feature keymaps. Also, I think the default keymaps are quite sensible, its just that I just keep forgetting most of them over time.

Describe the solution you'd like
I was wondering if it would be possible to add some sort of keymap reference list/menu similar to that offered by neogit or which-key. Perhaps a similar small list of keymaps displayed somewhere in the (floating) windows would help.

Describe alternatives you've considered
neogit also has a ? binding that shows the full keymap reference menu. An alternative could be an additional keybind (<C-?> for example) to bring up another (floating) window consisting of the keymap list/reference.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reviewing the existing documentation and default keymaps for the modules that open floating windows, then compare the reference behavior offered by neogit and which-key. Done means users can open a keymap reference from those modules, with the displayed bindings covering the relevant defaults.

Written by the indexing model from the issue text.

Assessment

Tech stack
lua, neovim
Domain
developer-experience, tooling
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.