Venu

Ⅰ. 插件描述

Simple menu for vim

Ⅱ. 基本信息

创建日期：  2018-06-29
使用用户：  2
Github星：  14
插件作者：  Tol Ida

Ⅲ. 安装方法

使用Vundle管理器安装

在你的.vimrc下添加: 
Plugin 'timoses/venu'
… 然后在Vim中运行以下命令: 
:source %
:PluginInstall

对于Vundle版本 < 0.10.2，请用上面的Bundle替换Plugin。

使用NeoBundle管理器安装

在你的.vimrc下添加: 
NeoBundle 'timoses/venu'
… 然后在Vim中运行以下命令: 
:source %
:NeoBundleInstall

使用VimPlug管理器安装

在你的.vimrc下添加: 
Plug 'timoses/venu'
… 然后在Vim中运行以下命令: 
:source %
:PlugInstall

使用Pathogen管理器安装

在终端中运行以下命令: 
cd ~/.vim/bundle
git clone https://github.com/timoses/vim-venu

Ⅳ. 文档说明

# V̂enu

<!-- vim-markdown-toc GFM -->

<!-- vim-markdown-toc -->

V̂enu is a vim plugin that allows the definition of menus for different filetypes removing the need to remember commands and key combinations.

asciicast

Install

Using vim-plug:

Plug 'Timoses/vim-venu'

Or use any other vim plugin manager.

Features

  • Submenus: Menus can contain any number of submenus.
  • Merging of menus submenus: If a menu is registered and has the same name as an already registered menu and there is a filetype collision (meaning both submenus or items have at least one filetype in common) then its contents including its submenus are merged together. This allows creating very general commands within a menu which can be extended by more specific commands for various filetypes.
  • Filetype specific commands: Each menu and menu item can be assigned a filetype or a list of filetypes. This allows creating different menus for different filetypes.
  • Position preference and ordering priority: Each menu and menu item can be assigned a preference for its position in the menu and an ordering priority. Positions are not guaranteed. If a position is assigned to more than one entry then all entries for that position are ordered by each entry's priority and are listed consecutively. This may result in subsequent entries not meeting their preferred positions. Empty entries may appear in case a menu or menu item has a position which is higher than one above the previous menu or menu item.
  • Import of native vim menus: Native menus can be imported to V̂enu. See documentation for more details.

Example Usage

Simple example

This example showcases the various cmd types that can be used in venu#addItem.

let s:menu1 = venu#create('My first V̂enu')
call venu#addItem(s:menu1, 'Item of first menu', 'echo "Called first item"')
call venu#register(s:menu1)

function! s:myfunction() abort
    echo "I called myfunction"
endfunction

let s:menu2 = venu#create('My second V̂enu')
call venu#addItem(s:menu2, 'Call a function ref', function("s:myfunction"))

let s:submenu = venu#create('My awesome subV̂enu')
call venu#addItem(s:submenu, 'Item 1', ':echo "First item of submenu!"')
call venu#addItem(s:submenu, 'Item 2', ':echo "Second item of submenu!"')

" Add the submenu to the second menu
call venu#addItem(s:menu2, 'Sub menu', s:submenu)

call venu#register(s:menu2)

Filetype example

In this example the menu Build is filled from different places (i.e. its contents are merged). Each filetype executes different commands for Compile and Compile & Run. ft1 displays Compile first (pos_pref=1) while ft2 displays Compile & Run first. However, both filetypes use the same Build -> Execute command.

.vim/ftplugin/ft1:
    let s:build = venu#create('Build')
    call venu#addItem(s:build, 'Compile', 'echo "compile ft1"', 1, 0, &ft)
    call venu#addItem(s:build, 'Compile & Run', 'echo "compile & run ft1"', 2, 0, &ft)
    call venu#register(s:build)

.vim/ftplugin/ft2:
    let s:build = venu#create('Build')
    call venu#addItem(s:build, 'Compile', 'echo "compile ft2"', 2, 0, &ft)
    call venu#addItem(s:build, 'Compile & Run', 'echo "compile & run ft2"', 1, 0, &ft)
    call venu#register(s:build)

.vimrc:
    let s:build = venu#create('Build')
    call venu#addItem(s:build, 'Execute', 'echo "execute"')
    call venu#register(s:build)

Opening the menu in vim

The following command will open the V̂enu:

:VenuPrint

Calling :VenuPrint again will close the menu without any action.

Documentation

See also:
Importing vim menus to V̂enu
|
V̂enu developer documentation

venu#create(name, [pos_pref, priority])

Creates a menu with the given name and returns a handle to it.

Optionally may contain a pos_pref (positional preference) with a priority value.
Values of 0 are ignored.

venu#addItem(menuHandle, name, cmd [,pos_pref, priority, filetype])

Add a menu item with the given name to the menu with the handle menuHandle.
cmd can be a

  • string - executed with exe <string>
  • FuncRef - executed with call <FuncRef>
  • another menu handle - a submenu is displayed

pos_pref is the positional preference with given priority. Values of 0 are ignored.

filetype can be a string or an array of strings. This argument allows showing an item only for specific filetypes. Note that when venu#register is called with filetypes which do not contain the filetype specified here then the menu will not be displayed for that filetype. Logically, the herein specified filetype argument should be a subset of the filetypes passed to venu#register.

venu#register(menuHandle [, filetype])

Register the menu so that it is displayed with venu#print.

If only one menu was registered its items are displayed directly. If several menus were registered the user can select the (sub)menu.

If a menu with the same name exists already it (and all its contained submenus) will be merged together.

venu#print()

Prints the menu.

venu#unregisterAll()

Unregisters all menus.

Contribute

If you would like to contribute feel free to create a Pull Request or mention your ideas and problems as an Issue.

Extending V̂enu

See developer documentation if you are interested in customizing the behaviour of V̂enu.

Please contribute your solutions back to the project.

If you require any additional functionality or further elements of V̂enu exposed please open an issue.

The ^ in V̂enu ?

I personally mapped :VenuPrint to the ^ key on a German keyboard which is easily reachable. Hence, the name.

Alternatives

  • quickmenu

    • opens a menu on the side, can use cmdline menu as well

添加新评论