Permalink
Find file
1351 lines (1021 sloc) 41 KB
*deoplete.txt* Dark powered asynchronous completion framework for neovim.
Version: 3.0
Author: Shougo <Shougo.Matsu at gmail.com>
License: MIT license
CONTENTS *deoplete-contents*
Introduction |deoplete-introduction|
Install |deoplete-install|
Interface |deoplete-interface|
Variables |deoplete-variables|
Key mappings |deoplete-key-mappings|
Functions |deoplete-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|
External omnifuncs |deoplete-external-omnifuncs|
Vim8 async API support |deoplete-vim8|
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(latest is recommended) with Python3 enabled.
1. Extract the files and put them in your Neovim directory
(usually `$XDG_CONFIG_HOME/nvim/`).
2. Execute the ":UpdateRemotePlugins" and restart Neovim.
3. Call |deoplete#enable()| or set "let g:deoplete#enable_at_startup = 1" in
your `init.vim`
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.1.8+.
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 nvim-python-doctor or |:CheckHealth|
command.
https://github.com/tweekmonster/nvim-python-doctor
==============================================================================
INTERFACE *deoplete-interface*
------------------------------------------------------------------------------
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.
With the default value 0, you cannot use deoplete
unless you start it manually.
*g:deoplete#enable_ignore_case*
g:deoplete#enable_ignore_case
When deoplete looks for candidate completion, this
variable controls whether deoplete ignores the upper-
and lowercase. If it is 1, deoplete ignores case.
Default value: same with your 'ignorecase' value
*g:deoplete#enable_smart_case*
g:deoplete#enable_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
*g:deoplete#enable_camel_case*
g:deoplete#enable_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: 0
*g:deoplete#enable_refresh_always*
g:deoplete#enable_refresh_always
Deoplete refreshes the candidates automatically if this value
is 1.
Note: It increases the screen flicker.
Default value: 0
*g:deoplete#auto_complete_start_length*
g:deoplete#auto_complete_start_length
This variable controls the number of the input completion
at the time of key input automatically.
Note: It is the deprecated option. You should change
|deoplete-source-attribute-min_pattern_length|.
Default: 2
*g:deoplete#disable_auto_complete*
g:deoplete#disable_auto_complete
It controls whether you invalidate automatic completion. If
it is 1, automatic completion becomes invalid, but can use the
manual completion by |deoplete#manual_complete()|.
Default value: 0
*b:deoplete_disable_auto_complete*
b:deoplete_disable_auto_complete
Buffer local variable of |g:deoplete#disable_auto_complete|.
*g:deoplete#enable_profile*
g:deoplete#enable_profile
It enables deoplete profile mode.
If it is 1, 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: 0
*g:deoplete#delimiters*
g:deoplete#delimiters
Delimiters list.
Default value: ['/']
*g:deoplete#max_list*
g:deoplete#max_list
If the list of candidates exceeds the limit, not all
candidates will show up.
Default value: 100
*g:deoplete#max_abbr_width*
g:deoplete#max_abbr_width
If the candidate abbr length exceeds the length it will be cut
down. If it is less than equal 0, this feature will be
disabled.
Default value: 80
*g:deoplete#max_menu_width*
g:deoplete#max_menu_width
If the candidate menu length exceeds the length it will be cut
down. If it is less than equal 0, this feature will be
disabled.
Default value: 40
*g:deoplete#auto_complete_delay*
g:deoplete#auto_complete_delay
Delay the completion after input in milliseconds.
Requires |+timers| (Neovim 0.1.5)
Default value: 150
*g:deoplete#auto_refresh_delay*
g:deoplete#auto_refresh_delay
Delay the refresh after input in milliseconds.
Requires |+timers| (Neovim 0.1.5) and
|g:deoplete#enable_refresh_always|
Default value: 50
*g:deoplete#skip_chars*
g:deoplete#skip_chars
The list of skip characters in the auto completion.
Default value: []
*b:deoplete_skip_chars*
b:deoplete_skip_chars
Buffer local variable of |g:deoplete#skip_chars|.
*g:deoplete#keyword_patterns*
g:deoplete#keyword_patterns
This dictionary records keyword patterns to buffer 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.
>
let g:deoplete#keyword_patterns = {}
let g:deoplete#keyword_patterns.tex = '\\?[a-zA-Z_]\w*'
<
Default value: in g:deoplete#_keyword_patterns
*b:deoplete_keyword_patterns*
b:deoplete_keyword_patterns
Buffer local variable of |g:deoplete#keyword_patterns|.
*g:deoplete#omni_patterns*
g:deoplete#omni_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: If it is a set, deoplete will call 'omnifunc'
directly. So almost deoplete features are disabled.
Note: It is Vim regexp.
>
let g:deoplete#omni_patterns = {}
let g:deoplete#omni_patterns.java = '[^. *\t]\.\w*'
<
Default value: in g:deoplete#_omni_patterns
*b:deoplete_omni_patterns*
b:deoplete_omni_patterns
Buffer local variable of |g:deoplete#omni_patterns|.
*g:deoplete#sources*
g:deoplete#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:
let g:deoplete#sources = {}
let g:deoplete#sources._ = ['buffer']
let g:deoplete#sources.cpp = ['buffer', 'tag']
< *b:deoplete_sources*
b:deoplete_sources
Buffer local variable of |g:deoplete#sources|.
It must be the source names list.
>
" Examples:
" In cmdwin, only use buffer source.
autocmd CmdwinEnter * let b:deoplete_sources = ['buffer']
< *g:deoplete#ignore_sources*
g:deoplete#ignore_sources
It is a dictionary to decide ignore source names.
The key is filetype and the value is source names list.
Default value: {}
*b:deoplete_ignore_sources*
b:deoplete_ignore_sources
Buffer local variable of |g:deoplete#ignore_sources|.
It must be the source names list.
*g:deoplete#member#prefix_patterns*
g:deoplete#member#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 value: defined in member.py
*b:deoplete_member_prefix_patterns*
b:deoplete_member_prefix_patterns
Buffer local variable of |g:deoplete#member#prefix_patterns|.
*g:deoplete#omni#input_patterns*
g:deoplete#omni#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.
>
let g:deoplete#omni#input_patterns = {}
let g:deoplete#omni#input_patterns.ruby =
\ ['[^. *\t]\.\w*', '[a-zA-Z_]\w*::']
let g:deoplete#omni#input_patterns.java = '[^. *\t]\.\w*'
let g:deoplete#omni#input_patterns.php =
\ '\w+|[^. \t]->\w*|\w+::\w*'
<
Default value: defined in omni.py.
*b:deoplete_omni_input_patterns*
b:deoplete_omni_input_patterns
Buffer local variable of |g:deoplete#omni#input_patterns|.
*g:deoplete#omni#functions*
g:deoplete#omni#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.
>
let g:deoplete#omni#functions = {}
let g:deoplete#omni#functions.ruby = 'rubycomplete#Complete'
let g:deoplete#omni#functions.javascript = [
\ 'tern#Complete',
\ 'jspc#omni'
\]
<
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 g:deoplete#omni#input_patterns setting.
*b:deoplete_omni_functions*
b:deoplete_omni_functions
Buffer local variable of |g:deoplete#omni#functions|.
*g:deoplete#file#enable_buffer_path*
g:deoplete#file#enable_buffer_path
If it is 1, file source complete the files from the buffer
path instead of the current directory.
Default value: 0
*g:deoplete#tag#cache_limit_size*
g:deoplete#tag#cache_limit_size
It sets file size to make a cache of a file in
tag source. If a tag file is bigger than this size,
deoplete does not make the tag file cache.
Default value: 500000
*g:deoplete#buffer#require_same_filetype*
g:deoplete#buffer#require_same_filetype
If it is zero, deoplete collects keywords from buffers of any
filetype
Default value: 1
------------------------------------------------------------------------------
FUNCTIONS *deoplete-functions*
*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#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#disable()*
deoplete#disable()
Disable deoplete auto completion.
Note: It changes the global state.
*deoplete#toggle()*
deoplete#toggle()
Toggle deoplete auto completion.
Note: It changes the global state.
*deoplete#custom#set()*
deoplete#custom#set({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#set('_', 'matchers', ['matcher_head'])
" Use auto delimiter feature
call deoplete#custom#set('_', 'converters',
\ ['converter_auto_delimiter', 'remove_overlap'])
call deoplete#custom#set('buffer', 'min_pattern_length', 9999)
" Change the source rank
call deoplete#custom#set('buffer', 'rank', 9999)
" Enable buffer source in C/C++ files only.
call deoplete#custom#set('buffer', 'filetypes', ['c', 'cpp'])
" Disable the candidates in Comment/String syntaxes.
call deoplete#custom#set('_',
\ 'disabled_syntaxes', ['Comment', 'String'])
" Change the truncate width.
call deoplete#custom#set('javacomplete2',
\ 'max_abbr_width', 20)
call deoplete#custom#set('javacomplete2',
\ 'max_menu_width', 80)
" Disable the truncate feature.
call deoplete#custom#set('javacomplete2',
\ 'max_abbr_width', 0)
call deoplete#custom#set('javacomplete2',
\ 'max_menu_width', 0)
" Change the source mark.
call deoplete#custom#set('buffer', 'mark', '*')
" Disable the source mark.
call deoplete#custom#set('omni', 'mark', '')
" Enable jedi source debug messages
" let g:deoplete#enable_profile = 1
" call deoplete#enable_logging('DEBUG', 'deoplete.log')
" call deoplete#custom#set('jedi', 'debug_enabled', 1)
<
*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-debug_enabled| to debug the
sources.
------------------------------------------------------------------------------
KEY MAPPINGS *deoplete-key-mappings*
*deoplete#manual_complete()*
deoplete#manual_complete([{sources}])
Use this function with |:inoremap| <expr> (|:map-expression|).
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.
If you want to trigger deoplete manually, see also
|g:deoplete#disable_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#smart_close_popup()*
deoplete#smart_close_popup()
Insert candidate and re-generate popup menu for deoplete.
>
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#close_popup()*
deoplete#close_popup()
Insert candidate and close popup menu for deoplete.
*deoplete#undo_completion()*
deoplete#undo_completion()
Undo inputted candidate. >
inoremap <expr><C-g> deoplete#undo_completion()
<
*deoplete#refresh()*
deoplete#refresh()
Refresh the candidates.
>
inoremap <expr><C-l> deoplete#refresh()
<
==============================================================================
EXAMPLES *deoplete-examples*
>
" Use deoplete.
let g:deoplete#enable_at_startup = 1
" Use smartcase.
let g:deoplete#enable_smart_case = 1
" <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*
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).
member *deoplete-source-member*
It collects members from current buffer.
tag *deoplete-source-tag*
It collects keywords from |ctags| files.
Note: It only supports UTF-8 encoding tag file.
file *deoplete-source-file*
This source collects keywords from local files.
omni *deoplete-source-omni*
This source collects keywords from 'omnifunc'.
Note: It is not asynchronous.
dictionary *deoplete-source-dictionary*
This source collects |g:deoplete#keyword_patterns| keywords
from 'dictionary'.
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
==============================================================================
FILTERS *deoplete-filters*
*deoplete-filter-matcher_default*
Default matchers: ['matcher_length', 'matcher_fuzzy']
You can change it by |deoplete#custom#set()|.
*deoplete-filter-sorter_default*
Default sorters: ['sorter_rank'].
You can change it by |deoplete#custom#set()|.
*deoplete-filter-converter_default*
Default converters: ['converter_remove_overlap', 'converter_truncate_abbr',
'converter_truncate_menu'].
You can change it by |deoplete#custom#set()|.
*deoplete-filter-matcher_head*
matcher_head Head matching matcher.
*deoplete-filter-matcher_fuzzy*
matcher_fuzzy Fuzzy matching matcher.
*deoplete-filter-matcher_full_fuzzy*
matcher_full_fuzzy
Full fuzzy matching matcher.
It accepts partial fuzzy matches like YouCompleteMe.
*deoplete-filter-matcher_length*
matcher_length
Length matching matcher.
It removes shorter candidates than 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_remove_overlap*
converter_remove_overlap
It removes overlapped text in a candidate's word.
*deoplete-filter-converter_auto_delimiter*
converter_auto_delimiter
It adds delimiter 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_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*
name (String) (Required)
The name of a source.
*deoplete-source-attribute-filetypes*
filetypes (List) (Optional)
Available filetype list.
If you omit it, this source available in all filetypes.
*deoplete-source-attribute-rank*
rank (Number) (Optional)
Source priority. Higher values imply higher priority.
If you omit it, it is set 100.
Note: It is high priority than match position.
*deoplete-source-attribute-min_pattern_length*
min_pattern_length
(Number) (Optional)
Required pattern length for completion.
If you omit it, it is set "2" value.
*deoplete-source-attribute-max_pattern_length*
max_pattern_length
(Number) (Optional)
Ignored pattern length for completion.
It is useful to edit BASE64 files.
If you omit it, it is set "80" value.
*deoplete-source-attribute-max_abbr_width*
max_abbr_width
(Number) (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.
If you omit it, it is set |g:deoplete#max_abbr_width| value.
*deoplete-source-attribute-max_menu_width*
max_menu_width
(Number) (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.
If you omit it, it is set |g:deoplete#max_menu_width| value.
*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.
If you omit it, 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-debug_enabled*
debug_enabled
(Bool) (Optional)
If it is True, the debug log feature is enabled in the source.
*deoplete-source-attribute-matchers*
matchers (List) (Optional)
Source default matchers list.
If you omit it, |deoplete-filter-matcher_default| is used.
*deoplete-source-attribute-sorters*
sorters (List) (Optional)
Source default sorters list.
If you omit it, |deoplete-filter-sorter_default| is
used.
*deoplete-source-attribute-converters*
converters (List) (Optional)
Source default converters list.
If you omit it, |deoplete-filter-converter_default| is used.
*deoplete-source-attribute-disabled_syntaxes*
disabled_syntaxes
(List) (Optional)
Source disabled syntaxes list.
If you omit it, this feature is ignored.
*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
|g:deoplete#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}.
{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-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-on_event*
on_event (Function) (Optional)
It is called when |BufRead|, |BufNewFile|, |BufWritePost| or
deoplete is initialized.
It is useful to make cache.
It takes {self} and {context} as its parameter.
*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-__*
__{name} (Unknown) (Optional)
Additional source information.
Note: Recommend sources save variables instead of
global variables.
{context} *deoplete-notation-{context}*
A dictionary to give context information.
The followings are the primary information.
input (String)
The input string of current line.
complete_position (Number)
The complete position of current source.
complete_str (String)
The complete string of current source.
candidates (List)
The current candidates.
filetype (String)
Current 'filetype'.
filetypes (List)
It contains current 'filetype' and same
filetypes and composite filetypes.
------------------------------------------------------------------------------
CANDIDATE ATTRIBUTES *deoplete-candidate-attributes*
*deoplete-candidate-attribute-name*
word (String) (Required)
The completion word of a candidate. It is used for matching
inputs.
*deoplete-candidate-attribute-abbr*
abbr (String) (Optional)
The abbreviation of a candidate. It is displayed in popup
window.
*deoplete-candidate-attribute-kind*
kind (String) (Optional)
The kind of a candidate. It is displayed in popup window.
*deoplete-candidate-attribute-menu*
menu (String) (Optional)
The menu information of a candidate. It is displayed in popup
window.
*deoplete-candidate-attribute-info*
info (String) (Optional)
The preview information of a candidate. If 'completeopt'
contains "preview", it will be displayed in |preview-window|.
*deoplete-candidate-attribute-dup*
dup (Number) (Optional)
If it is non zero, the item will be displayed in the popup
menu when an item with the same word is already present.
==============================================================================
CREATE FILTER *deoplete-create-filter*
To create filter, you should read default filters implementation in
rplugin/python3/deoplete/filter/*.py.
The files are automatically loaded and deoplete creates new Filter class object.
Filter class must extend Base class in ".base".
Note: The filters must be created by Python3 language.
------------------------------------------------------------------------------
FILTER ATTRIBUTES *deoplete-filter-attributes*
*deoplete-filter-attribute-__init__*
__init__ (Function)
Source constructor. It will be called in initializing. It
must call Base constructor. This function takes {self} and
{vim} as its parameters.
*deoplete-filter-attribute-name*
name (String) (Required)
The name of a source.
*deoplete-filter-attribute-filter*
filter
(Function) (Required)
It is called to filter candidates.
It takes {self} and {context} as its parameter and returns a
list of {candidate}.
{candidate} must be Dictionary contains
|deoplete-candidate-attributes|.
Here, {context} is the context information when the source is
called(|deoplete-notation-{context}|).
==============================================================================
EXTERNAL SOURCES *deoplete-external-sources*
neco-vim: "vim" source for Vim script
https://github.com/Shougo/neco-vim
neosnippet: "neosnippet" source
https://github.com/Shougo/neosnippet.vim
neoinclude: "include" and "file/include" sources
https://github.com/Shougo/neoinclude.vim
neco-syntax: "syntax" source
https://github.com/Shougo/neco-syntax
vimshell: "vimshell" source for vimshell
https://github.com/Shougo/vimshell.vim
neco-ghc: "ghc" source for Haskell
https://github.com/eagletmt/neco-ghc
vim-racer: "racer" source for Rust
https://github.com/racer-rust/vim-racer
UltiSnips source: "ultisnips" source for UltiSnips
https://github.com/SirVer/ultisnips
clang-complete: "clang_complete" source for C/C++/Objective-C
https://github.com/Rip-Rip/clang_complete
deoplete-go: "go" source for Go
https://github.com/zchee/deoplete-go
elixir.nvim: "elixir" source for Elixir
https://github.com/awetzel/elixir.nvim
deoplete-jedi: "jedi" source for Python
https://github.com/zchee/deoplete-jedi
perlomni.vim: "PerlOmni" source for Perl
https://github.com/c9s/perlomni.vim
deoplete-typescript: "typescript" source for typescript
https://github.com/mhartington/deoplete-typescript
deoplete-clang: "clang" source for C/C++/ObjC
https://github.com/zchee/deoplete-clang
deoplete-clang2: "clang2" source for C/C++/ObjC
It is faster than deoplete-clang
https://github.com/tweekmonster/deoplete-clang2
async-clj-omni: "async_clj" source for Clojure
https://github.com/SevereOverfl0w/async-clj-omni
deoplete-ternjs: "ternjs" source for JavaScript
https://github.com/carlitux/deoplete-ternjs
deoplete-swift: "swift" source for Swift
https://github.com/landaire/deoplete-swift
neovim-intellij-complete-deoplete: "intellij" source for Intellij IDE
https://github.com/vhakulinen/neovim-intellij-complete-deoplete
tmux-complete: "tmuxcomplete" source for tmux panes
https://github.com/wellle/tmux-complete.vim
deoplete-github: "github" source for "gitcommit" filetype
https://github.com/SevereOverfl0w/deoplete-github
deoplete-flow: "flow" source for JavaScript
https://github.com/steelsojka/deoplete-flow
deoplete-d: "d" source for D language
https://github.com/landaire/deoplete-d
deoplete-rtags: "rtags" source for "c", "cpp", "objc" and "objcpp" filetypes
https://github.com/LuXuryPro/deoplete-rtags
deoplete-ruby: "ruby" source for Ruby language
https://github.com/fishbullet/deoplete-ruby
deoplete-padawan: "padawan" source for padawan.php
https://github.com/pbogut/deoplete-padawan
webcomplete.vim: "webcomplete" source for browser opened pages
https://github.com/thalesmello/webcomplete.vim
deoplete-julia: "julia" source for Julia
https://github.com/JuliaEditorSupport/deoplete-julia
acid.nvim: "acid" source for Clojure
https://github.com/hkupty/acid.nvim
deoplete-omnisharp: "cs" source for C#
https://github.com/Robzz/deoplete-omnisharp/
deoplete-hack: "hack" source for Hack and PHP
https://github.com/zefei/deoplete-hack
==============================================================================
EXTERNAL PLUGINS *deoplete-external-plugins*
These are my recommended plugins for deoplete.
context_filetype.vim:
It adds the context filetype feature.
https://github.com/Shougo/context_filetype.vim
neopairs.vim:
It inserts the parentheses pairs automatically.
https://github.com/Shougo/neopairs.vim
echodoc.vim:
It prints the documentation you have completed.
https://github.com/Shougo/echodoc.vim
neoinclude.vim:
You can completes the candidates from the included files and included path.
https://github.com/Shougo/neoinclude.vim
FastFold:
Speed up the updating folds when you use auto completion plugins.
https://github.com/Konfekt/FastFold
==============================================================================
EXTERNAL OMNIFUNCS *deoplete-external-omnifuncs*
These are my recommended omnifuncs for deoplete.
phpcomplete: PHP omnifunc
https://github.com/shawncplus/phpcomplete.vim
==============================================================================
VIM8 ASYNC API SUPPORT *deoplete-vim8*
Current deoplete does not support Vim8 asynchronous API.
To support Vim8, neovim-python compatible API is needed.
I have not plan to create it.
But if it is created, I will support it.
Q: Why neovim-python compatible API is needed? Vim8 already implements
asynchronous API. It optimize your plugins, doesn't it?
Q: Why neocomplete/unite.vim does not support Vim8 asynchronous API?
A: Vim8 asynchronous API (or neovim job API) does replace vimproc plugin.
No more vimproc dependency. But it does not optimize my plugins.
To optimize my plugins, I must rewrite the plugins and most functions must be
executed in the separated process. It is hard way though, it is already done.
Yes, it is deoplete!
Q: Why does not use the external interfaces?
A: Current all external interfaces block your Vim. The neovim remote plugin
feature is not.
Q: Why neovim remote plugin is better?
A: It is the separated process and easy to communicate with Vim like the
external interfaces. I think it is the killer feature in neovim. It is not
well known though.
Q: neovim-python compatible API can be implemented by Vim8 async API?
A: Yes. Vim8 implements JSON RPC. I think you can create Python-Vim
input/output interface using JSON RPC. It is like MessagePack-RPC in neovim.
Q: Why don't you implement neovim-python compatibility API using Vim8 JSON
RPC?
A: I have not much time. You can implement it. Why do I need to implement
the feature? neovim remote plugin feature already works! It should be
implemented by needed person.
==============================================================================
FAQ *deoplete-faq*
Q: deoplete can support Vim8?
A: |deoplete-vim8|
Q: deoplete does not work.
A:
1. Please update neovim to latest version.
2. Please update neovim python3 module to latest version.
>
$ sudo pip3 install neovim --upgrade
<
3. Please execute ":UpdateRemotePlugins" or ":NeoBundleRemotePlugins" (for
using NeoBundle) command manually.
4. Please check if Python3 interface works. You can check it by ":echo
has('python3')" command.
https://github.com/neovim/neovim/wiki/Troubleshooting#python-support-isnt-working
5. Please enable debug mode from command line and upload the log file. >
$ export NVIM_PYTHON_LOG_FILE=/tmp/log
$ export NVIM_PYTHON_LOG_LEVEL=DEBUG
$ neovim
... Use deoplete
$ cat /tmp/log_{PID}
Q: I want to get quiet messages in auto completion.
A: You can disable the messages through the 'shortmess' option.
>
if has("patch-7.4.314")
set shortmess+=c
endif
<
Q: I want to look selected function's arguments in deoplete. But I don't
like preview window feature.
A: You can do it by |echodoc|.
http://github.com/Shougo/echodoc.vim
Q: I want to use auto select feature like |neocomplete|.
A: You can use it by the 'completeopt' option. >
set completeopt+=noinsert
Q: I want to lock auto completion.
A: Please use |b:deoplete_disable_auto_complete|.
Q: Ruby omni completion does not work in neovim.
A: Ruby omni completion support was added to nvim 0.1.5. For it to work you
will need to install the neovim gem.
https://github.com/alexgenco/neovim-ruby
$ gem install neovim
Q: I want to use C/C++ omni completion with deoplete.
A: You can use |clang_complete| or |deoplete-clang|.
https://github.com/Rip-Rip/clang_complete
https://github.com/zchee/deoplete-clang
For clang_complete configuration is below. >
let g:clang_complete_auto = 0
let g:clang_auto_select = 0
let g:clang_omnicppcomplete_compliance = 0
let g:clang_make_default_keymappings = 0
"let g:clang_use_library = 1
Current clang_complete supports the original deoplete source.
It is better than using omni source.
Q: I want to use head matcher instead of fuzzy matcher.
A: >
" Use head matcher instead of fuzzy matcher
call deoplete#custom#set('_', 'matchers', ['matcher_head'])
Q: Is deoplete faster than neocomplete?
A: No. Deoplete is asynchronous completion plugin. But it does not
mean that it is faster than neocomplete. It can skip the completion if you
input the characters too fast. I think it is great than the speed. You
should use faster machine for deoplete.
Q: I want to complete AAA using deoplete.
A: You can create the source for it. Why don't create the source if you need?
Q: I want to use jedi-vim omni completion with deoplete.
A: You should install deoplete-jedi instead of jedi-vim. >
https://github.com/zchee/deoplete-jedi
Q: When I press enter, neovim close the popup instead of inserting new line.
A: It is Vim/neovim's default behavior (feature.) If you want to insert the
new line, you should map <CR>. >
inoremap <silent> <CR> <C-r>=<SID>my_cr_function()<CR>
function! s:my_cr_function() abort
return deoplete#close_popup() . "\<CR>"
endfunction
Q: I want to use "vim-lua-ftplugin".
https://github.com/xolox/vim-lua-ftplugin
A: Please set the config as below.
>
let g:lua_check_syntax = 0
let g:lua_complete_omni = 1
let g:lua_complete_dynamic = 0
let g:lua_define_completion_mappings = 0
let g:deoplete#omni#functions.lua = 'xolox#lua#omnifunc'
"let g:deoplete#omni#functions.lua = 'xolox#lua#completefunc'
<
Q: I want to disable buffer source.
A: You can use |g:deoplete#ignore_sources|. >
let g:deoplete#ignore_sources = {}
let g:deoplete#ignore_sources._ = ['buffer']
Q: I want to complete go candidates.
A: You should install deoplete-go source.
https://github.com/zchee/deoplete-go
Q: I want to complete the candidates from other files.
https://github.com/Shougo/deoplete.nvim/issues/133
A: You must install context_filetype plugin.
https://github.com/Shougo/context_filetype.vim
And you must set |g:context_filetype#same_filetypes| variable.
Q: I want to close the preview window after completion is done.
A: >
autocmd CompleteDone * pclose!
Note: It conflicts with iabbr.
https://github.com/Shougo/deoplete.nvim/issues/234
Q: I want to see the typed word in the completion menu.
A: You should remove |deoplete-filter-matcher_length| from the matchers.
>
call deoplete#custom#set('_', 'matchers', ['matcher_fuzzy'])
<
Q: How to prevent auto bracket completion?
https://github.com/Shougo/deoplete.nvim/issues/150
A: >
call deoplete#custom#set('_', 'converters',
\ ['converter_remove_paren'])
Q: What is the difference of |g:deoplete#omni_patterns| and
|g:deoplete#omni#input_patterns| ?
A:
g:deoplete#omni_patterns is:
* can call all omni functions
* called by Vim
* Vim regexp
g:deoplete#omni#input_patterns is:
* cannot call some omni functions
* can use deoplete features
* called by deoplete
* Python3 regexp
You should use |g:deoplete#omni#input_patterns| if possible.
Q: deoplete cannot complete filename after "=".
A: It seems 'isfname' contains "=". You should remove it. >
set isfname-==
Q: Deoplete does not work with vim-multiple-cursors.
A: You must disable deoplete when using vim-multiple-cursors. >
function g:Multiple_cursors_before()
let g:deoplete#disable_auto_complete = 1
endfunction
function g:Multiple_cursors_after()
let g:deoplete#disable_auto_complete = 0
endfunction
Q: The candidates are filtered by first character.
https://github.com/Shougo/deoplete.nvim/issues/288
A: >
call deoplete#custom#set('_', 'matchers', ['matcher_full_fuzzy'])
<
Q: Are there any plans to support GotoDefinition feature like YouCompleteMe?
A: https://github.com/zchee/deoplete-jedi/issues/35
Q: What about the alphabetical sorting of all entries?
A: >
call deoplete#custom#set('_', 'sorters', ['sorter_word'])
<
Q: I want to change the UltiSnips source order.
A: >
call deoplete#custom#set('ultisnips', 'rank', 1000)
<
Q: tag source does not work.
https://github.com/Shougo/deoplete.nvim/issues/309
A: Please increase |g:deoplete#tag#cache_limit_size| value.
Q: I want to debug the sources.
A: Please enable logging feature like this.
>
let g:deoplete#enable_profile = 1
call deoplete#enable_logging('DEBUG', 'deoplete.log')
call deoplete#custom#set('jedi', 'debug_enabled', 1)
<
Q: Is deoplete better than completer.vim?
A: Please see
https://www.reddit.com/r/vim/comments/573e3d/completorvim_async_completion_framework_made_ease/
Q: The popup is delayed.
https://github.com/Shougo/deoplete.nvim/issues/413
A: Please change |g:deoplete#auto_complete_delay| value.
==============================================================================
COMPATIBILITY *deoplete-compatibility*
==============================================================================
vim:tw=78:ts=8:ft=help:norl:noet:fen:noet: