helpex.vim


Ⅰ. 插件描述

DISCONTINUED: A vim plugin providing extended elixir support. See instead:

Ⅱ. 基本信息

创建日期:  2014-06-07
使用用户:  2
Github星:  20
插件作者:  sanmiguel

Ⅲ. 安装方法

使用Vundle管理器安装

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

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

使用NeoBundle管理器安装

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

使用VimPlug管理器安装

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

使用Pathogen管理器安装

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

Ⅳ. 文档说明

Support suspended:

I no longer have the time to maintain this plugin, but @slashmili is doing great work with alchemist.vim. If you're still using helpex.vim, please consider upgrading your experience to alchemist.vim!

helpex.vim Build Status

Scripts to integrate the excellent [alchemist-server] into vim.
Currently supported features are:

  • code-completion
  • integrated docs (via [vim-ref])

Installation

Either with your favourite plugin/addon manager (I use [vim-plug]), or manually:

  • git clone --recursive https://github.com/sanmiguel/helpex.vim /path/to/helpex.vim

    • Note that [alchemist-server] is included as a git submodule, so you must use recursive clone.
  • Add /path/to/helpex.vim to your runtimepath as usual.

Dependencies

  • elixir > v1.0.4 due to this commit
  • [vimproc] NB: vimproc has a manual post-install step to build it - some plugin managers seem to deal with this OK, some do not - check the vimproc README for details of what to do
  • [vim-ref]
  • Optional: [AnsiEsc]

Usage

Completion via omni-complete: <C-x><C-o>

asciicast

-----

Documentation, via :Ref elixir ...

asciicast

NB: There is currently a problem the way ref changes the content of the buffer if you try to open a subsequent ref page from within the ref buffer. Simple workaround (for now) is to close the ref buffer between :Ref invocations.

-----

Issues

  • No error checking
  • No options

Troubleshooting

To check if helpex has even managed to start alchemist.exs, try:

:echo helpex#status()

If it's running, it should print ['run', 0]. If there's been a problem it'll print ['exit', 1]. If it prints nothing something might be chomping the output. In which case, try :echom string(helpex#status()) | messages.

If it's not running, most likely there's a problem either with vimproc (post-install build step required), or there's a problem with how erlang and elixir are available in vim's env. Check e.g. :!elixir --version to verify.

If it is running, and still doesn't work please contact me (@sanmiguel on elixir slack, gen_ale_drinker in #elixir-lang on freenode), or raise an issue here on github!

添加新评论