forked from Shougo/deoplete.nvim
-
Notifications
You must be signed in to change notification settings - Fork 0
/
deoplete.txt
1689 lines (1284 loc) · 50.6 KB
/
deoplete.txt
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
*deoplete.txt* Dark powered asynchronous completion framework for neovim/Vim8.
Version: 4.0
Author: Shougo <Shougo.Matsu at gmail.com>
License: MIT license
CONTENTS *deoplete-contents*
Introduction |deoplete-introduction|
Install |deoplete-install|
Interface |deoplete-interface|
Options |deoplete-options|
Variables |deoplete-variables|
Key mappings |deoplete-key-mappings|
Functions |deoplete-functions|
Custom Functions |deoplete-custom-functions|
Examples |deoplete-examples|
Sources |deoplete-sources|
Create source |deoplete-create-source|
Source attributes |deoplete-source-attributes|
Candidate attributes |deoplete-candidate-attributes|
Create filter |deoplete-create-filter|
FILTERS |deoplete-filters|
External sources |deoplete-external-sources|
External plugins |deoplete-external-plugins|
FAQ |deoplete-faq|
Compatibility |deoplete-compatibility|
==============================================================================
INTRODUCTION *deoplete-introduction*
*deoplete* is the abbreviation of "dark powered neo-completion". It
provides asynchronous keyword completion system in the
current buffer.
Note: deoplete may consume more memory than other plugins do.
Improvements in deoplete in comparison to |neocomplete|:
1. Real asynchronous completion behavior like |YouCompleteMe| by default.
2. Uses Python3 to implement sources.
3. Removes legacy interface.
4. Requires |+python3|.
==============================================================================
INSTALL *deoplete-install*
Note: deoplete requires Neovim(0.2.0+) or Vim8(latest is recommended) with
Python3 and |+timers| enabled.
Please install nvim-yarp plugin for Vim8.
https://github.com/roxma/nvim-yarp
Please install vim-hug-neovim-rpc plugin for Vim8.
https://github.com/roxma/vim-hug-neovim-rpc
1. Extract the files and put them in your Neovim or .vim directory
(usually `$XDG_CONFIG_HOME/nvim/`).
2. Call |deoplete#enable()| or set "let g:deoplete#enable_at_startup = 1" in
your `init.vim`
3. Execute the ":UpdateRemotePlugins" if Neovim.
If ":echo has('python3')" returns `1`, then you're done; otherwise, see below.
You can enable Python3 interface with pip: >
pip3 install neovim
Note: deoplete needs neovim-python ver.0.2.4+.
You need update neovim-python module.
>
pip3 install --upgrade neovim
<
If you want to read for Neovim-python/python3 interface install documentation,
you should read |provider-python| and the Wiki.
https://github.com/zchee/deoplete-jedi/wiki/Setting-up-Python-for-Neovim
You can check the Python3 installation by using the |:checkhealth| command.
==============================================================================
INTERFACE *deoplete-interface*
------------------------------------------------------------------------------
OPTIONS *deoplete-options*
Options can be toggled through the use of |deoplete#custom#option()|.
For example:
>
" Set a single option
call deoplete#custom#option('auto_complete_delay', 200)
" Pass a dictionary to set multiple options
call deoplete#custom#option({
\ 'auto_complete_delay': 200,
\ 'smart_case': v:true,
\ })
<
The set of available options follows.
*deoplete-options-auto_complete*
auto_complete
If it is False, automatic completion becomes invalid, but can
use the manual completion by |deoplete#manual_complete()|.
Default: v:true
*deoplete-options-auto_complete_delay*
auto_complete_delay
Delay the completion after input in milliseconds.
Requires |+timers|.
Default value: 50
*deoplete-options-auto_refresh_delay*
auto_refresh_delay
Delay the refresh when asynchronous.
If it is less than equal 0, the feature is disabled.
Default value: 50
*deoplete-options-camel_case*
camel_case
When a capital letter is matched with the uppercase, but a
lower letter is matched with the upper- and lowercase.
Ex: "foB" is matched with "FooBar" not "foobar".
Note: This feature is only available in
|deoplete-filter-matcher_fuzzy| or
|deoplete-filter-matcher_full_fuzzy|.
Default value: v:false
*deoplete-options-complete_method*
complete_method
If it is "complete", deoplete use |complete()|.
If it is "completefunc", deoplete use |i_CTRL-X_CTRL-U|.
Note: It changes current 'completefunc' value.
If it is "omnifunc", deoplete use |i_CTRL-X_CTRL-O|.
Note: It changes current 'omnifunc' value.
Default value: "complete"
*deoplete-options-delimiters*
delimiters
Delimiters list. It is used in
|deoplete-filter-converter_auto_delimiter|.
Default value: ['/']
*deoplete-options-ignore_case*
ignore_case
If it is True, deoplete ignores case.
Default value: same with your 'ignorecase' value
*deoplete-options-ignore_sources*
ignore_sources
It is a dictionary to decide ignore source names.
The key is filetype and the value is source names list.
Default value: {}
*deoplete-options-keyword_patterns*
keyword_patterns
It defines the keyword patterns for completion.
This is appointed in regular expression string or list every
file type.
Note: It is Python3 regexp. But "\k" is converted to
'iskeyword' pattern.
>
call deoplete#custom#option('keyword_patterns', {
\ '_': '[a-zA-Z_]\k*',
\ 'tex': '\\?[a-zA-Z_]\w*',
\ 'ruby': '[a-zA-Z_]\w*[!?]?',
\})
<
Default value: {}
*deoplete-options-max_list*
max_list
If the list of candidates exceeds the limit, not all
candidates will show up.
Default value: 500
*deoplete-options-num_processes*
num_processes
The number of processes used for the deoplete parallel
feature.
If it is 1, this feature is disabled.
If it is less than equal 0, the number of processes are equal
to sources number.
Default value: 1 (Windows) or 4 (Others)
*deoplete-options-omni_patterns*
omni_patterns
If omni_patterns is set, deoplete will call 'omnifunc'
directly as soon as a pattern is matched.
Note: This will disable deoplete filtering and combination of
sources for those matches. Suggested use is only for legacy
omnifunc plugins which do not return all results when provided
an empty base argument or moves the cursor in omnifunc. See
|complete-functions|
If this pattern is not defined or empty for a filetype,
deoplete does not call 'omnifunc'.
Note: It is a Vim regexp.
>
call deoplete#custom#option('omni_patterns', {
\ 'java': '[^. *\t]\.\w*',
\})
<
Default value: in autoload/deoplete/init.vim
*deoplete-options-on_insert_enter*
on_insert_enter
Deoplete enables the auto completion on |InsertEnter| autocmd
if this value is True.
Default value: v:true
*deoplete-options-profile*
profile
If it is True, deoplete will print the time information to
|deoplete#enable_logging()| logfile.
Must be set in init.vim before to start the Neovim.
Does not support command line.
Default value: v:false
*deoplete-options-refresh_always*
refresh_always
Deoplete refreshes the candidates automatically if this value
is True.
Note: It increases the screen flicker.
Default value: v:false
*deoplete-options-skip_chars*
skip_chars
The list of skip characters in the auto completion.
Default value: ['(', ')']
*deoplete-options-smart_case*
smart_case
When a capital letter is included in input, deoplete does
not ignore the upper- and lowercase.
Default value: same with your 'smartcase' value
*deoplete-options-sources*
sources
It is a dictionary to decide use source names. The key is
filetype and the value is source names list. If the key is
"_", the value will be used for default filetypes. For
example, you can load some sources in C++ filetype.
If the value is [], it will load all sources.
Default value: {}
>
" Examples:
call deoplete#custom#option('sources', {
\ '_': ['buffer'],
\ 'cpp': ['buffer', 'tag'],
\})
*deoplete-options-min_pattern_length*
min_pattern_length
The default number of the input completion at the time of key
input automatically.
Note: You should change
|deoplete-source-attribute-min_pattern_length|.
Default: 2
*deoplete-options-yarp*
yarp
Use nvim-yarp library instead of neovim remote plugin feature.
Note: nvim-yarp plugin is needed.
https://github.com/roxma/nvim-yarp
Default value: v:false
------------------------------------------------------------------------------
VARIABLES *deoplete-variables*
*g:deoplete#enable_at_startup*
g:deoplete#enable_at_startup
Deoplete gets started automatically when Neovim starts if
this value is 1.
Default: 0
Note: It means you cannot use deoplete unless you start it
manually.
------------------------------------------------------------------------------
FUNCTIONS *deoplete-functions*
*deoplete#disable()*
deoplete#disable()
Disable deoplete auto completion.
Note: It changes the global state.
*deoplete#enable()*
deoplete#enable()
Enable deoplete auto completion.
Note: It changes the global state.
Note: It does not work in lazy loading. You should use
|g:deoplete#enable_at_startup| instead.
*deoplete#enable_logging()*
deoplete#enable_logging({level}, {logfile})
Enable logging for debugging purposes.
Set {level} to "DEBUG", "INFO", "WARNING", "ERROR", or
"CRITICAL".
{logfile} is the file where log messages are written.
Messages are appended to this file. Each log session will
start with "--- Deoplete Log Start ---".
Note: You must enable
|deoplete-source-attribute-is_debug_enabled| to debug the
sources.
*deoplete#initialize()*
deoplete#initialize()
Initialize deoplete and sources.
Note: You should call it in |VimEnter| autocmd.
User customization for deoplete must be set before
initialization of deoplete.
*deoplete#send_event()*
deoplete#send_event({event})
Call |deoplete-source-attribute-on_event| manually.
{event} is event name.
*deoplete#toggle()*
deoplete#toggle()
Toggle deoplete auto completion.
Note: It changes the global state.
CUSTOM FUNCTIONS *deoplete-custom-functions*
*deoplete#custom#buffer_option()*
deoplete#custom#buffer_option({option-name}, {value})
deoplete#custom#buffer_option({dict})
The buffer local version of |deoplete#custom#option()|.
*deoplete#custom#option()*
deoplete#custom#option({option-name}, {value})
deoplete#custom#option({dict})
Set {option-name} option to {value}.
If {dict} is available, the key is {option-name} and the value
is {value}.
*deoplete#custom#source()*
deoplete#custom#source({source-name}, {option-name}, {value})
Set {source-name} source specialized {option-name}
to {value}. You may specify multiple sources with
separating "," in {source-name}.
If {source-name} is "_", sources default option will be
change.
Note: You must call it before using deoplete.
>
" Examples:
" Use head matcher instead of fuzzy matcher
call deoplete#custom#source('_',
\ 'matchers', ['matcher_head'])
" Use auto delimiter feature
call deoplete#custom#source('_', 'converters',
\ ['converter_auto_delimiter', 'remove_overlap'])
call deoplete#custom#source('buffer',
\ 'min_pattern_length', 9999)
" Change the source rank
call deoplete#custom#source('buffer', 'rank', 9999)
" Enable buffer source in C/C++ files only.
call deoplete#custom#source('buffer',
\ 'filetypes', ['c', 'cpp'])
" Disable the candidates in Comment/String syntaxes.
call deoplete#custom#source('_',
\ 'disabled_syntaxes', ['Comment', 'String'])
" Change the truncate width.
call deoplete#custom#source('javacomplete2',
\ 'max_abbr_width', 20)
call deoplete#custom#source('javacomplete2',
\ 'max_menu_width', 80)
" Disable the truncate feature.
call deoplete#custom#source('javacomplete2',
\ 'max_abbr_width', 0)
call deoplete#custom#source('javacomplete2',
\ 'max_menu_width', 0)
" Change the source mark.
call deoplete#custom#source('buffer', 'mark', '*')
" Disable the source mark.
call deoplete#custom#source('omni', 'mark', '')
" Enable jedi source debug messages
" call deoplete#custom#option('profile', v:true)
" call deoplete#enable_logging('DEBUG', 'deoplete.log')
" call deoplete#custom#source('jedi', 'is_debug_enabled', 1)
<
*deoplete#custom#var()*
deoplete#custom#var({source-name}, {var-name}, {value})
Set {source-name} source specialized variable {variable-name}
to {value}. You may specify multiple sources with the
separator "," in {source-name}.
------------------------------------------------------------------------------
KEY MAPPINGS *deoplete-key-mappings*
*deoplete#close_popup()*
deoplete#close_popup()
Insert candidate and close popup menu for deoplete.
Note: It must be in |map-<expr>|.
*deoplete#complete_common_string()*
deoplete#complete_common_string()
complete common string in candidates. It will be convenient
when candidates have long common string.
Note: It must be in |map-<expr>|.
*deoplete#manual_complete()*
deoplete#manual_complete([{sources}])
It calls the completion of deoplete. You can use it with
custom completion setups.
You can provide a list of {sources}: It can be the name of a
source or a list of sources name.
Note: It blocks your neovim.
Note: It must be in |map-<expr>|.
If you want to trigger deoplete manually, see also
|deoplete-options-auto_complete|, which should be 1 then
typically.
>
inoremap <silent><expr> <TAB>
\ pumvisible() ? "\<C-n>" :
\ <SID>check_back_space() ? "\<TAB>" :
\ deoplete#mappings#manual_complete()
function! s:check_back_space() abort "{{{
let col = col('.') - 1
return !col || getline('.')[col - 1] =~ '\s'
endfunction"}}}
<
*deoplete#refresh()*
deoplete#refresh()
Refresh the candidates.
Note: It must be in |map-<expr>|.
>
inoremap <expr><C-l> deoplete#refresh()
<
*deoplete#smart_close_popup()*
deoplete#smart_close_popup()
Insert candidate and re-generate popup menu for deoplete.
Note: It must be in |map-<expr>|.
>
inoremap <expr><C-h>
\ deoplete#smart_close_popup()."\<C-h>"
inoremap <expr><BS>
\ deoplete#smart_close_popup()."\<C-h>"
<
Note: This mapping is conflicted with |SuperTab| or |endwise|
plugins.
Note: This key mapping is for <C-h> or <BS> keymappings.
*deoplete#undo_completion()*
deoplete#undo_completion()
Undo inputted candidate.
Note: It must be in |map-<expr>|.
>
inoremap <expr><C-g> deoplete#undo_completion()
<
==============================================================================
EXAMPLES *deoplete-examples*
>
" Use deoplete.
let g:deoplete#enable_at_startup = 1
" Use smartcase.
call deoplete#custom#option('smart_case', v:true)
" <C-h>, <BS>: close popup and delete backword char.
inoremap <expr><C-h> deoplete#smart_close_popup()."\<C-h>"
inoremap <expr><BS> deoplete#smart_close_popup()."\<C-h>"
" <CR>: close popup and save indent.
inoremap <silent> <CR> <C-r>=<SID>my_cr_function()<CR>
function! s:my_cr_function() abort
return deoplete#close_popup() . "\<CR>"
endfunction
<
==============================================================================
SOURCES *deoplete-sources*
around *deoplete-source-around*
This source collects candidates around the cursor, so inside
current buffer only. Plus, it searches keywords in |:changes|
command output. Therefore, this source is about to provide the
words that are in sight or the ones you've just typed somewhere
else.
Legend: You can see where the words came from. Next to the
source mark [~] these suffixes are used:
A - above the cursor
B - below the cursor
C - in changes
rank: 300
buffer *deoplete-source-buffer*
It collects keywords from current buffer and the current
tabpage windows buffers and the opened buffers which have same
'filetype'.
Note: It does not collect keywords from not loaded buffer.
For example, if you open file by "nvim A B". A is already
loaded, but B is not loaded. So buffer source cannot collect
the keywords in B until you switch to buffer B.
Note: It takes time to get the candidates in the first time if
you want to edit the large files(like Vim 22000 lines eval.c).
rank: 100
Source custom variables:
require_same_filetype
If it is False, deoplete collects keywords from
buffers of any filetype
(default: True)
dictionary *deoplete-source-dictionary*
This source collects |deoplete-options-keyword_patterns|
keywords from 'dictionary'. Note: it uses buffer-local
'dictionary' set up.
rank: 100
>
" Examples:
" Sample configuration for dictionary source with multiple
" dictionary files.
setlocal dictionary+=/usr/share/dict/words
setlocal dictionary+=/usr/share/dict/american-english
" Remove this if you'd like to use fuzzy search
call deoplete#custom#source(
\ 'dictionary', 'matchers', ['matcher_head'])
" If dictionary is already sorted, no need to sort it again.
call deoplete#custom#source(
\ 'dictionary', 'sorters', [])
" Do not complete too short words
call deoplete#custom#source(
\ 'dictionary', 'min_pattern_length', 4)
<
file *deoplete-source-file*
This source collects keywords from local files. Specifically,
it completes file and directory names and paths, e.g.
/usr/lib/share.
rank: 150
Source custom variables:
enable_buffer_path
If it is True, file source complete the files
from the buffer path instead of the current
directory.
(default: False)
member *deoplete-source-member*
It collects members from current buffer.
rank: 100
Source custom variables:
prefix_patterns
This dictionary records prefix patterns to
member completion. This is appointed in
regular expression string or list every file
type. If this pattern is not defined or
empty pattern, deoplete does not complete
member candidates.
Note: It is Python3 regexp.
(default: See in member.py)
omni *deoplete-source-omni*
This source collects keywords from 'omnifunc'.
Note: It is not asynchronous.
rank: 500
Source custom variables:
input_patterns
This dictionary records keyword patterns to
Omni completion. This is appointed in regular
expression string or list every file type. If
this pattern is not defined or empty pattern,
deoplete does not call 'omnifunc'.
Note: Some omnifuncs which moves the cursor is
not worked. For example, htmlcomplete,
phpcomplete, etc...
Note: It is Python3 regexp.
(default: See in omni.py)
>
call deoplete#custom#var('omni', 'input_patterns', {
\ 'ruby': ['[^. *\t]\.\w*', '[a-zA-Z_]\w*::'],
\ 'java': '[^. *\t]\.\w*',
\ 'php': '\w+|[^. \t]->\w*|\w+::\w*',
\})
<
functions
It defines a dictionary for omni completion
with deoplete:
- `keys` consist of filetypes;
- `values` consist of either a string
containing a single omnifunc or a list with
omnifuncs to be used for each filetype.
In case there is no omnifunc setting for the
current filetype in the dictionary, deoplete
will use the 'omnifunc' setting.
Note: It supports context filetype feature
instead of 'omnifunc'. You can call the
omnifunc in the embedded language.
Note: For omnifunctions to work with deoplete,
it's necessary to setup the "input_patterns"
setting.
(default: {})
>
call deoplete#custom#source('omni', 'functions', {
\ 'ruby': 'rubycomplete#Complete',
\ 'javascript': ['tern#Complete', 'jspc#omni']
\})
<
tag *deoplete-source-tag*
It collects keywords from |ctags| files.
Note: It only supports UTF-8 encoding tag file.
rank: 100
==============================================================================
FILTERS *deoplete-filters*
*deoplete-filter-matcher_default*
Default matchers: ['matcher_fuzzy']
You can change it by |deoplete#custom#source()|.
*deoplete-filter-sorter_default*
Default sorters: ['sorter_rank'].
You can change it by |deoplete#custom#source()|.
*deoplete-filter-converter_default*
Default converters: ['converter_remove_overlap', 'converter_truncate_abbr',
'converter_truncate_menu'].
You can change it by |deoplete#custom#source()|.
*deoplete-filter-matcher_cpsm*
matcher_cpsm
A matcher which filters the candidates using cpsm.
It is like |deoplete-filter-matcher_full_fuzzy| but faster.
It also sorts the candidates using cpsm.
Note: cpsm plugin build/install is needed in 'runtimepath'.
https://github.com/nixprime/cpsm
Note: You must use Python3 support enabled cpsm. >
$ PY3=ON ./install.sh
<
Configuration example: >
>
call deoplete#custom#source('_', 'matchers', ['matcher_cpsm'])
call deoplete#custom#source('_', 'sorters', [])
<
*deoplete-filter-matcher_full_fuzzy*
matcher_full_fuzzy
Full fuzzy matching matcher.
It accepts partial fuzzy matches like YouCompleteMe.
*deoplete-filter-matcher_fuzzy*
matcher_fuzzy Fuzzy matching matcher.
*deoplete-filter-matcher_head*
matcher_head Head matching matcher.
*deoplete-filter-matcher_length*
matcher_length
Length matching matcher.
It removes candidates shorter than or equal to the user input.
*deoplete-filter-sorter_rank*
sorter_rank Matched rank order sorter. The higher the head matched word
or already selected.
*deoplete-filter-sorter_word*
sorter_word Word order sorter.
*deoplete-filter-converter_auto_delimiter*
converter_auto_delimiter
It adds |deoplete-options-delimiters| characters in a
candidate's word.
*deoplete-filter-converter_auto_paren*
converter_auto_paren
It adds parentheses character in a candidate's word.
It is useful if you use |neopairs| or |neosnippet|
plugins.
*deoplete-filter-converter_remove_overlap*
converter_remove_overlap
It removes overlapped text in a candidate's word.
*deoplete-filter-converter_remove_paren*
converter_remove_paren
It removes parentheses character in a candidate's word.
*deoplete-filter-converter_truncate_abbr*
converter_truncate_abbr
It truncates a candidate's abbr by the current window width.
*deoplete-filter-converter_truncate_menu*
converter_truncate_menu
It truncates a candidate's menu by the current window width.
==============================================================================
CREATE SOURCE *deoplete-create-source*
To create source, you should read default sources implementation in
rplugin/python3/deoplete/source/*.py.
The files are automatically loaded and deoplete creates new Source class
object.
Source class must extend Base class in ".base".
Note: The sources must be created by Python3 language.
Note: If you call Vim functions in your source, it is not asynchronous.
------------------------------------------------------------------------------
SOURCE ATTRIBUTES *deoplete-source-attributes*
*deoplete-source-attribute-__init__*
__init__ (Function)
Source constructor. It is always called in initializing. It
must call super() constructor. This function takes {self} and
{vim} as its parameters.
*deoplete-source-attribute-__*
__{name} (Unspecified) (Optional)
Additional source information.
Note: Recommend sources save variables instead of
global variables.
*deoplete-source-attribute-converters*
converters (List[str]) (Optional)
Source default converters list.
Default: |deoplete-filter-converter_default|
*deoplete-source-attribute-description*
description (String) (Optional)
The description of a source.
*deoplete-source-attribute-disabled_syntaxes*
disabled_syntaxes
(List[str]) (Optional)
Source disabled syntaxes list.
Default: []
Note: It means this feature is ignored.
*deoplete-source-attribute-events*
events (List[str]) (Optional)
List of events for which |deoplete-source-attribute-on_event|
should get called.
Default: `None`
Note: It means that `on_event` gets called for all events.
*deoplete-source-attribute-filetypes*
filetypes (List[str]) (Optional)
Available filetype list.
Default: []
Note: It means this source available in all filetypes.
*deoplete-source-attribute-get_complete_position*
get_complete_position
(Function) (Optional)
It is called to get complete position.
It takes {self} and {context} as its parameter and returns
complete position in current line.
Here, {context} is the context information when the source is
called(|deoplete-notation-{context}|).
If you omit it, deoplete will use the position using
|deoplete-options-keyword_patterns|.
Note: |deoplete-source-attribute-is_bytepos| is True, it must
return byte position.
*deoplete-source-attribute-gather_candidates*
gather_candidates
(Function) (Required)
It is called to gather candidates.
It takes {self} and {context} as its parameter and returns a
list of {candidate}.
If the error is occurred, it must return None.
{candidate} must be String or Dictionary contains
|deoplete-candidate-attributes|.
Here, {context} is the context information when the source is
called(|deoplete-notation-{context}|).
Note: The source must not filter the candidates by user input.
It is |deoplete-filters| work. If the source filter the
candidates, user cannot filter the candidates by fuzzy match.
*deoplete-source-attribute-input_pattern*
input_pattern
(String) (Optional)
If it is matched, deoplete ignores
|deoplete-source-attribute-min_pattern_length|.
It is useful for omni function sources.
Note: If the source set the attribute, it must define
|deoplete-source-attribute-get_complete_position| attribute.
Note: It is Python3 regexp.
Default: ''
Note: It means this feature is ignored.
*deoplete-source-attribute-is_bytepos*
is_bytepos
(Bool) (Optional)
If it is True,
|deoplete-source-attribute-get_complete_position|
returns byteposition instead of character position.
The default is False.
It is useful for Vim script to create sources.
Because Vim script string uses byte position. Python string
uses character position.
*deoplete-source-attribute-is_debug_enabled*
is_debug_enabled
(Bool) (Optional)
If it is True, the debug log feature is enabled in the source.
Default: False
*deoplete-source-attribute-is_silent*
is_silent
(Bool) (Optional)
If it is True, the source messages are disabled.
Default: False
*deoplete-source-attribute-is_volatile*
is_volatile
(Bool) (Optional)
If it is True, the source depends on the user input. It means
that if this flag is set to False, deoplete will cache
gather_candidates results and will not call gather_candidates
on each input change. Only on_post_filter method will be
called on each input change (if implemented).
Default: False
*deoplete-source-attribute-keyword_patterns*
keyword_patterns
It defines the keyword patterns for completion.
This is appointed in regular expression string or list every
file type.
Default: |deoplete-options-keyword_patterns|
*deoplete-source-attribute-rank*
rank (Integer) (Optional)
Source priority. Higher values imply higher priority.
Note: It is high priority than match position.
Default: 100
*deoplete-source-attribute-mark*
mark (String) (Optional)
The mark of a source.
*deoplete-source-attribute-matchers*
matchers (List[str]) (Optional)
Source default matchers list.
Default: |deoplete-filter-matcher_default|
*deoplete-source-attribute-matcher_key*
matcher_key (String) (Optional)
Matcher compare key instead of "word".
If it is empty string, the feature is disabled.
Default: ''
*deoplete-source-attribute-max_abbr_width*
max_abbr_width
(Integer) (Optional)
If the candidate abbr length exceeds the length it will be cut
down.
It it is less than or equal 0, it will be disabled.
Default: 80
*deoplete-source-attribute-max_candidates*
max_candidates
(Integer) (Optional)
If the candidates are more than it, deoplete will ignore the
filtering.
Default: 500
*deoplete-source-attribute-max_kind_width*
max_kind_width
(Integer) (Optional)
If the candidate kind length exceeds the length it will be cut
down.
It it is less than or equal 0, it will be disabled.
Default: 40
*deoplete-source-attribute-max_menu_width*
max_menu_width
(Integer) (Optional)
If the candidate menu length exceeds the length it will be cut
down.
It it is less than or equal 0, it will be disabled.
Default: 40
*deoplete-source-attribute-max_pattern_length*
max_pattern_length
(Integer) (Optional)
Ignored pattern length for completion.
It is useful to edit BASE64 files.
Default: 80
*deoplete-source-attribute-min_pattern_length*
min_pattern_length
(Integer) (Optional)
Required pattern length for completion.
Default: 2
*deoplete-source-attribute-name*
name (String) (Required)
The name of a source.
*deoplete-source-attribute-on_event*
on_event (Function) (Optional)
Called for |InsertEnter|, |BufWritePost|, |DirChanged|
autocommands, through |deoplete#send_event()|.
It is useful to make cache.
It takes {self} and {context} as its parameter.
" Examples:
def on_event(self, context):
if context['event'] == 'BufWritePost':
# BufWritePost
pass
else:
pass
*deoplete-source-attribute-on_init*
on_init (Function) (Optional)
It will be called before the source attribute is called.
It takes {self} and {context} as its parameter.
It should be used to initialize the internal variables.
*deoplete-source-attribute-on_post_filter*
on_post_filter
(Function) (Optional)
It is called after the candidates are filtered.
It takes {self} and {context} as its parameter and returns a
list of {candidate}.
*deoplete-source-attribute-sorters*
sorters (List[str]) (Optional)
Source default sorters list.
If you omit it, |deoplete-filter-sorter_default| is
used.
*deoplete-source-attribute-vars*
vars (Dictionary) (Optional)
List of source customization variables.
{context} *deoplete-notation-{context}*
A dictionary to give context information.
The followings are the primary information.