Skip to content

feat: add keybinding to open dashboard#14

Open
jara505 wants to merge 1 commit intoaikhe:masterfrom
jara505:feat/add-keybinding-to-open-dashboard
Open

feat: add keybinding to open dashboard#14
jara505 wants to merge 1 commit intoaikhe:masterfrom
jara505:feat/add-keybinding-to-open-dashboard

Conversation

@jara505
Copy link
Contributor

@jara505 jara505 commented Mar 15, 2026

Overview

Add a global keybinding to open the Wrapped dashboard without typing the :WrappedNvim command manually.

This change addresses the need for a more efficient workflow, as Neovim users typically prefer keyboard shortcuts over typing commands manually.

Key Changes

  • Added <leader>gw as a global keybinding in plugin/wrapped.lua
  • Updated README.md with the new mapping in the Mappings table

Impact

  • plugin/wrapped.lua — Added keymap
  • README.md — Documentation update

@aikhe aikhe self-assigned this Mar 16, 2026
@aikhe
Copy link
Owner

aikhe commented Mar 17, 2026

hello @jara505! really appreciate the PR

regarding the predefined keybindings: i think it's better practice to leave those entirely up to the user. neovim users usually have very specific setups, and hardcoded mappings (especially using <leader>) often clash with existing configs.

since wrapped already exposes its API via require("wrapped").run() and provides the :WrappedNvim command, users have everything they need to set up their own preferred shortcuts.

for example, they can map the lua API:

-- mapping it to a key 
vim.keymap.set("n", "<leader>gw", function()
    require("wrapped").run()
end, { desc = "run wrapped" })

or use a mapping that utilizes the command as you did in the PR.

instead, i think it would be more handy to add a "Recommended Keybindings" section to the README. this is especially important as i’m planning to add a new feature for calling wrapped on specific projects rather than just the neovim configuration, which is why keeping the keybindings flexible is important.

Copy link
Owner

@aikhe aikhe left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants