Skip to content

Commit

Permalink
Update vim plugin markdown docs with description and link to deoplete…
Browse files Browse the repository at this point in the history
… integration. (phpactor#410)
  • Loading branch information
kristijanhusak authored and dantleech committed Apr 14, 2018
1 parent f90740e commit e9db7fc
Showing 1 changed file with 28 additions and 6 deletions.
34 changes: 28 additions & 6 deletions doc/vim-plugin.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ Phpactor VIM Plugin
- [Updating](#updating)
- [Configuration](#configuration)
- [Completion](#completion)
- [Completion plugins](#completion-plugins)
- [Context Menu](#context-menu)

Installation
Expand Down Expand Up @@ -137,7 +138,7 @@ Completion

Omni-completion
([Screenshot](./screenshots.html#code-completion)) is
VIM's built-in auto-completion mechanism.
VIM's built-in auto-completion mechanism.

Add the following to your `.vimrc` in order to use Phpactor for omni-completion (for PHP files):

Expand All @@ -158,12 +159,33 @@ is <b>useful</b>. Other completion mehanisms may not provide this information.
</p>
</div>

Completion plugins
------------
Several asynchronous completion frameworks support Phpactor

### Deoplete
To use Phpactor with [deoplete.nvim](https://github.com/Shougo/deoplete.nvim) add this to your vimrc/init.vim:

*Using [vim-plug](https://github.com/junegunn/vim-plug)*
```vimL
Plug 'Shougo/deoplete.nvim'
Plug 'phpactor/phpactor', { 'do': 'composer install', 'for': ['php'] }
Plug 'kristijanhusak/deoplete-phpactor'
```

+Run `PlugInstall` and you're good to go!

### Neovim Completion Manager
To use Phpactor with [Neovim Completion Manager](https://github.com/roxma/nvim-completion-manager) add this to your vimrc/init.vim:

*Using [vim-plug](https://github.com/junegunn/vim-plug)*
```vimL
Plug 'roxma/nvim-completion-manager'
Plug 'phpactor/phpactor', { 'do': 'composer install', 'for': ['php'] }
Plug 'roxma/ncm-phpactor'
```

If you are using [Neovim](https://neovim.io/) with the [Neovim Completion
Manager](https://github.com/roxma/nvim-completion-manager) you should certainly
install [ncm-phpactor](https://github.com/roxma/ncm-phpactor) to benefit from
great asynchronous complete-as-you-type auto-completion:
+Run `PlugInstall` and you're good to go!

Context Menu
------------
Expand All @@ -177,5 +199,5 @@ should see something like the following:

```
Method "execute":
[r]eplace_references, (f)ind_references, (g)enerate_method, g(o)to_definition:
[r]eplace_references, (f)ind_references, (g)enerate_method, g(o)to_definition:
```

0 comments on commit e9db7fc

Please sign in to comment.