21

GitHub - damofthemoon/vim-leader-mapper: Vim plugin to create Neovim leader key...

 4 years ago
source link: https://github.com/damofthemoon/vim-leader-mapper
Go to the source link to view the article. You can view the picture content, updated content and better typesetting reading experience. If the link is broken, please click the button below to view the snapshot at that time.
neoserver,ios ssh client

README.md

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.
  • No intrusion: no change on user mapping & configuration.

It's also inspired from vim-leader-guide but it's simpler and use floating window to display leader menu.

68747470733a2f2f61736369696e656d612e6f72672f612f37684768654766327a7331336d395a7777303476644c6253412e737667

Installation

Use Vim-Plug or any other plugin manager to install it.

Plug 'damofthemoon/vim-leader-mapper'

Follows a configuration example, binding regular Vim commands and FZF calls:

" 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:

" Define leader key to space and call vim-leader-mapper
nnoremap <Space> <Nop>
let mapleader = "\<Space>"
nnoremap <silent> <leader> :call leaderMapper#start() "<Space>"<CR>
vnoremap <silent> <leader> :call leaderMapper#start() "<Space>"<CR>

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):

let g:leaderMapperPos = "center"

To define the window's width, in percentage of the Vim window (default is 70%):

let g:leaderMapperWidth = 70

TODO

  • Enhance display: provide color
  • Support sub-menu
  • Support Vim 8

License

This plugin is under MIT license. Do whatever you want with it, and don't hesitate to fork it and contribute!


report

Recommend

About Joyk


Aggregate valuable and interesting links.
Joyk means Joy of geeK