Skip to content

Commit 354da78

Browse files
kristijanhusakdantleech
authored andcommitted
Use vim-plug instead of Vundle in docs and add deoplete integration to vim docs. (phpactor#411)
* Use vim-plug instead of Vundle in docs and add deoplete integration to vim docs. * Fix vim docs duplicate number and return manual composer installation instruction.
1 parent e9db7fc commit 354da78

File tree

2 files changed

+32
-14
lines changed

2 files changed

+32
-14
lines changed

doc/phpactor.txt

Lines changed: 26 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,8 @@
1010
5. Configuration |phpactor-configuration|
1111
6. Requirements |phpactor-requirements|
1212
7. Completion |phpactor-completion|
13-
8. Context Menu |phpactor-context-menu|
13+
8. Completion plugins |phpactor-completion-plugins|
14+
9. Context Menu |phpactor-context-menu|
1415

1516
================================================================================
1617
*phpactor-introduction*
@@ -22,15 +23,16 @@ website:
2223

2324
================================================================================
2425
*phpactor-installation*
25-
Install Phpactor using your favorite VIM package manager, I am using Vundle.
26+
Install Phpactor using your favorite VIM package manager.
27+
If you don't use any, I recommend vim-plug.
2628
Add the plugin to your .vimrc:
2729

28-
`Plugin 'phpactor/phpactor'`
30+
`Plug 'phpactor/phpactor', {'for': 'php', 'do': composer install'}`
2931

3032
Then in VIM:
31-
`:VundleInstall`
33+
`:PlugInstall`
3234

33-
You will need to install the Phpactor dependencies with composer:
35+
If you do not use vim-plug, you will need to install the Phpactor dependencies with composer manually:
3436
`$ cd ~/.vim/bundle/phpactor`
3537
`$ composer install`
3638

@@ -122,10 +124,26 @@ This information is useful. Other completion mehanisms may not provide this info
122124
Always enable omni-completion. If another mechanism is failing to complete,
123125
invoke omni-complete to find out why.
124126

127+
================================================================================
128+
COMPLETION PLUGINS *phpactor-completion-plugins*
129+
130+
Several asynchronous completion frameworks support Phpactor
131+
132+
*phpactor-deoplete*
133+
To use Phpactor with deoplete.nvim add this to your vimrc/init.vim:
134+
`Plug 'Shougo/deoplete.nvim'`
135+
`Plug 'phpactor/phpactor', { 'do': 'composer install', 'for': ['php'] }`
136+
`Plug 'kristijanhusak/deoplete-phpactor'`
137+
138+
Run `PlugInstall` and you're good to go!
139+
125140
*phpactor-neovim-completion-manager*
126-
If you are using Neovim with the Neovim Completion Manager you should certainly
127-
install ncm-phpactor to benefit from great asynchronous complete-as-you-type
128-
auto-completion.
141+
To use Phpactor with Neovim Completion manager add this to your vimrc/init.vim:
142+
`Plug 'roxma/nvim-completion-manager'`
143+
`Plug 'phpactor/phpactor', { 'do': 'composer install', 'for': ['php'] }`
144+
`Plug 'roxma/ncm-phpactor'`
145+
146+
Run `PlugInstall` and you're good to go!
129147

130148
================================================================================
131149
CONTEXT MENU *phpactor-context-menu*

doc/vim-plugin.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -14,21 +14,21 @@ Phpactor VIM Plugin
1414
Installation
1515
------------
1616

17-
Install Phpactor using your favorite VIM package manager, I am using Vundle.
18-
Add the plugin to your `.vimrc`:
17+
Install Phpactor using your favorite VIM package manager.
18+
If you don't use any, I recommend [vim-plug](https://github.com/junegunn/vim-plug).
19+
Add the plugin to your .vimrc:
1920

2021
```
21-
Plugin 'phpactor/phpactor'
22+
Plug 'phpactor/phpactor', {'for': 'php', 'do': composer install'}
2223
```
2324

2425
Then in VIM:
2526

2627
```
27-
:VundleInstall
28+
:PlugInstall
2829
```
2930

30-
Now you will need to install the Phpactor dependencies with composer:
31-
31+
If you do not use [vim-plug](https://github.com/junegunn/vim-plug), you will need to install the Phpactor dependencies with composer manually:
3232
```
3333
$ cd ~/.vim/bundle/phpactor
3434
$ composer install

0 commit comments

Comments
 (0)