Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/dpretet/vim-leader-mapper
Vim plugin to create Neovim leader key menu
https://github.com/dpretet/vim-leader-mapper
fzf leader-key neovim nvim vim-leader-mapper vim-plugin vim-script viml
Last synced: 3 months ago
JSON representation
Vim plugin to create Neovim leader key menu
- Host: GitHub
- URL: https://github.com/dpretet/vim-leader-mapper
- Owner: dpretet
- License: mit
- Created: 2019-12-10T08:27:00.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2023-12-09T13:00:03.000Z (11 months ago)
- Last Synced: 2024-06-16T09:34:02.913Z (5 months ago)
- Topics: fzf, leader-key, neovim, nvim, vim-leader-mapper, vim-plugin, vim-script, viml
- Language: Vim Script
- Homepage:
- Size: 27.3 KB
- Stars: 43
- Watchers: 2
- Forks: 2
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# vim-leader-mapper
## Introduction
Vim-Leader-Mapper is a Neovim plugin to create leader key mapping and a visual
menu to display them. It's basically a copy of Spacemacs interactive menu,
relying on leader key to toggle it.
- Easy to use: the user can simply add his own commands with few setup and map
them to leader key.
- Configurable: the user can associate any command (internal or external command).
- Fast: the plugin is very small, written in pure vimL.
It's also inspired from
[vim-leader-guide](https://github.com/hecal3/vim-leader-guide) but it's simpler
and use floating window to display leader menu.
[Vim-which-key](https://github.com/liuchengxu/vim-which-key) offers similar
features.
Please note this plug-in is for Neovim and is not compatible with Vim because it
relies on the floating window API of Neovim.ur fork, so you can send a pull
## Installation
Use [Vim-Plug](https://github.com/junegunn/vim-plug) or any other plugin
manager to install it.
```vim
Plug 'dpretet/vim-leader-mapper'
```
## Configuration
Follows a configuration example, binding regular Vim commands and FZF calls:
```vim
" Define the menu content with a Vim dictionary
let g:leaderMenu = {'name': "",
\'f': [":Files", "FZF file search"],
\'b': [":Buffers", "FZF buffer search"],
\'s': [":BLines", "FZF text search into current buffer"],
\'S': [":Lines", "FZF text search across loaded buffers"],
\'g': [":BCommits", "FZF git commits of the current buffer"],
\'G': [":Commits", "FZF git commits of the repository"],
\'v': [':vsplit', 'Split buffer vertically'],
\'h': [':split', 'Split buffer horizontally'],
\'d': [':bd', 'Close buffer'],
\'r': [':so $MYVIMRC', 'Reload vimrc without restarting Vim'],
\'l': [':ls', 'List opened buffers'],
\'t': [':Tags', 'FZF tag search'],
\'o': [':normal gf', 'Open file under cursor'],
\}
```
Finally to bind leader key to space and toggle the menu on each space pressure:
```vim
" Define leader key to space and call vim-leader-mapper
nnoremap
let mapleader = "\"
nnoremap :LeaderMapper ""
vnoremap :LeaderMapper ""
```
One could want to specify the position of the window. This can be done with two
parameters.
To define the vertical placement of the window. Can be `top`, `bottom` or
`center` (default is `center`):
```vim
let g:leaderMapperPos = "center"
```
To define the window's width, in percentage of the Vim window (default is
`70%`):
```vim
let g:leaderMapperWidth = 70
```
It's also possible to add submenu binded with a key. Here is an example:
```vim
" Define the menu dedicated to FZF
let fzfMenu = {'name': "FZF Menu",
\'f': [":Files", "FZF file search"],
\'b': [":Buffers", "FZF buffer search"],
\'s': [":BLines", "FZF text search into current buffer"],
\'S': [":Lines", "FZF text search across loaded buffers"],
\'g': [":BCommits", "FZF git commits of the current buffer"],
\'G': [":Commits", "FZF git commits of the repository"],
\}
" Define the menu content including the above menu
let g:leaderMenu = {'name': "Global Menu",
\'f': [fzfMenu, "FZF menu"],
\'v': [':vsplit', 'Split buffer vertically'],
\'h': [':split', 'Split buffer horizontally'],
\'d': [':bd', 'Close buffer'],
\'r': [':so $MYVIMRC', 'Reload vimrc without restarting Vim'],
\'l': [':ls', 'List opened buffers'],
\'t': [':Tags', 'FZF tag search'],
\'o': [':normal gf', 'Open file under cursor'],
\}
```
Pressing 'f' key will open the dedicated menu to FZF.
In case your function/command binded needs to access the lines range of a
visual selection, vim-leader-mapper setup two variables: `leaderMapperLineStart`
and `leaderMapperLineEnd`. These variables are setup to line numbers as long the
plugin is executed. When closing, it will setup them to `-1`.
## License
This plugin is under MIT license. Do whatever you want with it, and don't
hesitate to fork it and contribute!