https://github.com/anuvyklack/keymap-amend.nvim

Amend the existing keymap in Neovim
https://github.com/anuvyklack/keymap-amend.nvim

keybinding neovim neovim-plugin

Last synced: about 2 months ago
JSON representation

Amend the existing keymap in Neovim

• Host: GitHub
• URL: https://github.com/anuvyklack/keymap-amend.nvim
• Owner: anuvyklack
• Created: 2022-04-30T10:51:01.000Z (about 2 years ago)
• Default Branch: master
• Last Pushed: 2023-08-23T06:48:37.000Z (10 months ago)
• Last Synced: 2024-01-24T10:44:39.927Z (4 months ago)
• Topics: keybinding, neovim, neovim-plugin
• Language: Lua
• Homepage:
• Size: 8.79 KB
• Stars: 55
• Watchers: 2
• Forks: 1
• Open Issues: 3
• Metadata Files:
  • Readme: README.md

Lists

• awesome-neovim - anuvyklack/keymap-amend.nvim - Amend the existing keymap. (Keybinding / Treesitter Based)
• awesome-stars - anuvyklack/keymap-amend.nvim - Amend the existing keymap in Neovim (Lua)
• awesome-stars - anuvyklack/keymap-amend.nvim - Amend the existing keymap in Neovim (Lua)
• awesome-neovim - anuvyklack/keymap-amend.nvim - Amend the existing keymap. (Keybinding / Treesitter Based)
• awesome-neovim - anuvyklack/keymap-amend.nvim - Amend the existing keymap. (Keybinding / Treesitter Based)

README

        
# keymap-amend.nvim

**Neovim v0.7 or higher is required**

This plugin allows to amend the exisintg keybinding in Neovim. It is done with the

function which is required from the `keymap-amend` module.  The signature of this function

is equal to **vim.keymap.set** function (`:help vim.keymap.set()`) with one exception: the

`rhs` parameter should be a function that receives one parameter — a function on call of

which the original keymapping will be executed. This function is constructed and passed

automaticaly.  You only need to "accept" it in your `rhs` function and call on need.

```lua

local keymap = vim.keymap

keymap.amend = require('keymap-amend')

keymap.amend(mode, lhs, function(original)

    -- your custom logic

    original() -- execute the original 'lhs' mapping

end, opts)

```

You need to watch that the amendment happens after the original keymap is set.

## Instalation

With [packer](https://github.com/wbthomason/packer.nvim):

```lua

use 'anuvyklack/keymap-amend.nvim'

```

## Examples

```lua

local keymap = vim.keymap

keymap.amend = require('keymap-amend')

keymap.amend('n', 'k', function(original)

   print('k key is amended!')

   original()

end)

```

Make `` disable highlighting of recently searched text in addition to its

original functionality:

```lua

local keymap = vim.keymap

keymap.amend = require('keymap-amend')

keymap.amend('n', '', function(original)

   if vim.v.hlsearch and vim.v.hlsearch == 1 then

      vim.cmd('nohlsearch')

   end

   original()

end, { desc = 'disable search highlight' })

```

### yank-ring with multiple-cursors

Make [yanky.nvim](https://github.com/gbprod/yanky.nvim) and

[vim-visual-multi](https://github.com/mg979/vim-visual-multi) plugins share ``

key-chord. `vim-visual-multi` should be loaded before `yanky.nvim`. In this example

[packer.nvim](https://github.com/wbthomason/packer.nvim) plugin manager is used to achive this.

```lua

use 'mg979/vim-visual-multi'

use { 'gbprod/yanky.nvim',

   after = 'vim-visual-multi',

   config = function() require('yanky').setup() end

}

keymap.amend('n', '', function(original)

   if yanky.can_cycle() then

      yanky.cycle(-1)

   else

      original()

   end

end)

keymap.amend('n', '', function(original)

   if yanky.can_cycle() then

      yanky.cycle(1)

   else

      original()

   end

end, { desc = 'yank-ring + multiple-cursors' })

```

Now `` will cycle the yank-ring only after paste, in all other cases it will activate

multiple cursors.

## Acknowledgments

This plugin was inspired with [nvim-cmp](https://github.com/hrsh7th/nvim-cmp)

fallback mechanics.