/
denite.txt
2410 lines (1886 loc) · 68 KB
/
denite.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
*denite.txt* Dark powered asynchronous unite all interfaces for NeoVim/Vim.
Version: 3.4
Author: Shougo <Shougo.Matsu at gmail.com>
License: MIT license
CONTENTS *denite-contents*
Introduction |denite-introduction|
Usage |denite-usage|
Install |denite-install|
Configuration Examples |denite-examples|
Interface |denite-interface|
Commands |denite-commands|
Key mappings |denite-key-mappings|
Functions |denite-functions|
Options |denite-options|
Sources |denite-sources|
Kinds |denite-kinds|
Filters |denite-filters|
Create source |denite-create-source|
Create kind |denite-create-kind|
Create filter |denite-create-filter|
External source |denite-external-sources|
FAQ |denite-faq|
Compatibility |denite-compatibility|
==============================================================================
INTRODUCTION *denite-introduction*
*denite* or *denite.nvim* is a common extensible interface for searching and
displaying lists of information from within NeoVim/Vim. It can display and
search through any arbitrary source, from files and directories to buffers.
* Theoretically faster while the main process is executed by python.
* Theoretically more stable while no other processes can be performed when
denite.nvim is executed.
* The implementation is relatively simpler than unite.vim
* Denite.nvim has great potential to implement a new feature.
* Sending pull requests using Python3 is easier than when using Vim script.
* There are a lot of useful tools to keep code simple (linter, tester, etc...)
in Python3.
* The unite.vim is officially obsolete, minor bugs (or even major bugs) are
not fixed anymore.
==============================================================================
USAGE *denite-usage*
To browse a list of currently open buffers like |:ls| command.
>
:Denite buffer
<
To browse recursive list of all the files under the current working
directory.
>
:Denite file/rec
<
Or you can combine sources, to browse files and buffers.
>
:Denite file/rec buffer
<
There are a number of command line flags (see |denite-options|), for
example to set an initial search term (foo) to filter files search.
>
:Denite -input=foo file/rec
<
Multiple keywords can be used to narrow down the candidates. They are
separated by either a space " ", and act like a logical AND.
>
foo bar
<
Specify negative conditions with a bang "!".
>
foo !bar
<
It matches candidates that contain "foo" but not "bar".
==============================================================================
INSTALL *denite-install*
Note: denite requires Neovim 0.4.0+ or Vim 8.0+ with |:python3| enabled.
Note: Please install/upgrade msgpack package (1.0.0+).
https://github.com/msgpack/msgpack-python
Note: You need to install Python 3.6.1+.
For neovim:
1. Extract the files and put them in your Neovim directory
(usually `$XDG_CONFIG_HOME/nvim/`).
2. Execute the |:UpdateRemotePlugins| and restart Neovim.
If ":echo has('python3')" returns `1`, then you're done; otherwise, see below.
You can enable Python3 interface with pip >
pip3 install --user pynvim
If you want to read for pynvim/python3 interface install documentation,
you should read |provider-python| and the Wiki.
You can check the Python3 installation |:checkhealth|
command.
For Vim8.0+:
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
Use |:python3| enabled Vim.
You must install "pynvim" module with pip >
pip3 install --user pynvim
==============================================================================
EXAMPLES *denite-examples*
>
" Define mappings
autocmd FileType denite call s:denite_my_settings()
function! s:denite_my_settings() abort
nnoremap <silent><buffer><expr> <CR>
\ denite#do_map('do_action')
nnoremap <silent><buffer><expr> d
\ denite#do_map('do_action', 'delete')
nnoremap <silent><buffer><expr> p
\ denite#do_map('do_action', 'preview')
nnoremap <silent><buffer><expr> q
\ denite#do_map('quit')
nnoremap <silent><buffer><expr> i
\ denite#do_map('open_filter_buffer')
nnoremap <silent><buffer><expr> <Space>
\ denite#do_map('toggle_select').'j'
endfunction
autocmd FileType denite-filter call s:denite_filter_my_settings()
function! s:denite_filter_my_settings() abort
imap <silent><buffer> <C-o> <Plug>(denite_filter_quit)
endfunction
" Change file/rec command.
call denite#custom#var('file/rec', 'command',
\ ['ag', '--follow', '--nocolor', '--nogroup', '-g', ''])
" For ripgrep
" Note: rg is faster than ag
call denite#custom#var('file/rec', 'command',
\ ['rg', '--files', '--glob', '!.git', '--color', 'never'])
" For Pt(the platinum searcher)
" NOTE: It also supports windows.
call denite#custom#var('file/rec', 'command',
\ ['pt', '--follow', '--nocolor', '--nogroup',
\ (has('win32') ? '-g:' : '-g='), ''])
" For python script scantree.py
" Read bellow on this file to learn more about scantree.py
call denite#custom#var('file/rec', 'command',
\ ['scantree.py', '--path', ':directory'])
" Change matchers.
call denite#custom#source(
\ 'file_mru', 'matchers', ['matcher/fuzzy', 'matcher/project_files'])
call denite#custom#source(
\ 'file/rec', 'matchers', ['matcher/cpsm'])
" Change sorters.
call denite#custom#source(
\ 'file/rec', 'sorters', ['sorter/sublime'])
" Change default action.
call denite#custom#kind('file', 'default_action', 'split')
" Add custom menus
let s:menus = {}
let s:menus.zsh = {
\ 'description': 'Edit your import zsh configuration'
\ }
let s:menus.zsh.file_candidates = [
\ ['zshrc', '~/.config/zsh/.zshrc'],
\ ['zshenv', '~/.zshenv'],
\ ]
let s:menus.my_commands = {
\ 'description': 'Example commands'
\ }
let s:menus.my_commands.command_candidates = [
\ ['Split the window', 'vnew'],
\ ['Open zsh menu', 'Denite menu:zsh'],
\ ['Format code', 'FormatCode', 'go,python'],
\ ]
call denite#custom#var('menu', 'menus', s:menus)
" Ag command on grep source
call denite#custom#var('grep', {
\ 'command': ['ag'],
\ 'default_opts': ['-i', '--vimgrep'],
\ 'recursive_opts': [],
\ 'pattern_opt': [],
\ 'separator': ['--'],
\ 'final_opts': [],
\ })
" Ack command on grep source
call denite#custom#var('grep', {
\ 'command': ['ack'],
\ 'default_opts': [
\ '--ackrc', $HOME.'/.ackrc', '-H', '-i',
\ '--nopager', '--nocolor', '--nogroup', '--column'
\ ],
\ 'recursive_opts': [],
\ 'pattern_opt': ['--match'],
\ 'separator': ['--'],
\ 'final_opts': [],
\ })
" Ripgrep command on grep source
call denite#custom#var('grep', {
\ 'command': ['rg'],
\ 'default_opts': ['-i', '--vimgrep', '--no-heading'],
\ 'recursive_opts': [],
\ 'pattern_opt': ['--regexp'],
\ 'separator': ['--'],
\ 'final_opts': [],
\ })
" Pt command on grep source
call denite#custom#var('grep', {
\ 'command': ['pt'],
\ 'default_opts': [
\ '-i', '--nogroup', '--nocolor', '--smart-case'],
\ 'recursive_opts': [],
\ 'pattern_opt': [],
\ 'separator': ['--'],
\ 'final_opts': [],
\ })
" jvgrep command on grep source
call denite#custom#var('grep', {
\ 'command': ['jvgrep'],
\ 'default_opts': ['-i'],
\ 'recursive_opts': ['-R'],
\ 'pattern_opt': [],
\ 'separator': [],
\ 'final_opts': [],
\ })
" Specify multiple paths in grep source
"call denite#start([{'name': 'grep',
" \ 'args': [['a.vim', 'b.vim'], '', 'pattern']}])
" Define alias
call denite#custom#alias('source', 'file/rec/git', 'file/rec')
call denite#custom#var('file/rec/git', 'command',
\ ['git', 'ls-files', '-co', '--exclude-standard'])
call denite#custom#alias('source', 'file/rec/py', 'file/rec')
call denite#custom#var('file/rec/py', 'command',
\ ['scantree.py', '--path', ':directory'])
" Change ignore_globs
call denite#custom#filter('matcher/ignore_globs', 'ignore_globs',
\ [ '.git/', '.ropeproject/', '__pycache__/',
\ 'venv/', 'images/', '*.min.*', 'img/', 'fonts/'])
" Custom action
" Note: denite#custom#action() with lambda parameter is only available
" in NeoVim; not supported in Vim8.
call denite#custom#action('file', 'test',
\ {context -> execute('let g:foo = 1')})
call denite#custom#action('file', 'test2',
\ {context -> denite#do_action(
\ context, 'open', context['targets'])})
" Source specific action
call denite#custom#action('source/file', 'test',
\ {context -> execute('let g:bar = 1')})
<
==============================================================================
INTERFACE *denite-interface*
------------------------------------------------------------------------------
COMMANDS *denite-commands*
:Denite [{options}] {sources} *:Denite*
Creates a new Denite buffer.
Denite can be invoked with one or more sources. This can be
done by specifying the list on the command line, separated by
spaces. The list of candidates (the matches found in the
source by your filter string) will be ordered in the same
order that you specify the {sources}.
For example:
:Denite file/rec line
Will first list the files, then lines of the current buffer.
See also |denite-sources| the available sources.
Denite can accept a list of strings, separated with ":", after
the name of sources. You must escape ":" and "\" with "\"
in parameters themselves, or surround the parameter with
quotes.
Examples:
"file/rec:foo:bar": the parameters of source file are
["foo", "bar"].
"file/rec:foo\:bar": the parameter of source file is
["foo:bar"].
"file/rec:'foo:bar'": the parameter of source file is
["foo:bar"].
"file/rec:foo::bar": the parameters of source file are
["foo", "", "bar"].
You can use evaluation cmdline by ``.
Note: In the evaluation, The special characters(spaces, "\"
and ":") are escaped automatically.
>
:Denite -buffer-name=search%`bufnr('%')` line<CR>
<
{options} are options for Denite buffer: |denite-options|
:DeniteBufferDir [{options}] {sources} *:DeniteBufferDir*
Equivalent to |:Denite| except that it targets the buffer
directory.
:DeniteCursorWord [{options}] {sources} *:DeniteCursorWord*
Equivalent to |:Denite| except that it targets <cword> under
the cursor for the initial narrowing text.
Note: <cword> means 'iskeyword' characters. If you want to
custom <cword> pattern, you need to set 'iskeyword' option.
Note: <cword> characters are escaped automatically.
:DeniteProjectDir [{options}] {sources} *:DeniteProjectDir*
Equivalent to |:Denite| except that it search the VCS project
directory from parent.
Note: You can change the search directory by
|denite-option-path| instead of |getcwd()|.
------------------------------------------------------------------------------
KEY MAPPINGS *denite-key-mappings*
*denite-map-change_sorters*
change_sorters:{arg}
Change |denite-option-sorters| to {arg}.
If |denite-option-sorters| is {arg}, it will be disabled.
*denite-map-choose_action*
choose_action
Choose and fire the action by denite UI.
*denite-map-do_action*
do_action:{action}
Close current Denite buffer and fire {action} action.
You can find the actions list in |denite-kinds|.
If {action} is empty, "default" will be used.
*denite-map-do_previous_action*
do_previous_action
Fire the previous action.
*denite-map-filter*
filter:{string}
Filter the candidates by {string}.
Note: It is used for filtering UI.
*denite-map-move_up_path*
move_up_path
Move to the upper path and restart Denite buffer.
*denite-map-nop*
nop
No operation.
*denite-map-open_filter_buffer*
open_filter_buffer
Open filter buffer to filtering.
*denite-map-print_messages*
print_messages
Output denite messages to |:messages|.
Note: You cannot read the messages in Denite window.
It is for debug only.
*denite-map-quick_move*
quick_move
Move to the selected candidate with using quick match.
*denite-map-quit*
quit
Close current Denite buffer.
*denite-map-redraw*
redraw
Clear the cache and redraw the candidates.
*denite-map-restart*
restart
Restart Denite buffer.
*denite-map-restore_sources*
restore_sources
Move back to the previous sources.
Note: It does not restore the cursor position.
*denite-map-toggle_auto_action*
toggle_auto_action:{action}
Change |denite-option-auto-action| to {action}.
If |denite-option-auto-action| is {action}, it will be
disabled.
If {action} is empty, all auto actions are disabled.
*denite-map-toggle_select*
toggle_select
Toggle cursor candidate select.
*denite-map-toggle_select_all*
toggle_select_all
Toggle all candidates.
*denite-map-toggle_matchers*
toggle_matchers:{arg}
Change |denite-option-matchers| to {arg}.
If |denite-option-matchers| is {arg}, it will be disabled.
FILTER KEY MAPPINGS *denite-filter-key-mappings*
Below mappings are only available in denite filter buffer.
*denite-map-i_<Plug>(denite_filter_backspace)*
<Plug>(denite_filter_backspace)
Delete the back word.
Note: If the input line is empty, quit the filter buffer.
*denite-map-i_<Plug>(denite_filter_clear_backward)*
<Plug>(denite_filter_clear_backward)
Clear the text before cursor.
*denite-map-<Plug>(denite_filter_quit)*
*denite-map-i_<Plug>(denite_filter_quit)*
<Plug>(denite_filter_quit)
Quit both filter buffer and denite buffer.
*denite-map-<Plug>(denite_filter_update)*
*denite-map-i_<Plug>(denite_filter_update)*
<Plug>(denite_filter_update)
Update the current input and quit filter buffer.
Note: It does not close filter window if
|denite-option-start-filter| is enabled.
*denite-filter-default-key-mappings*
Following keymappings are default keymappings.
Normal mode default mappings.
{lhs} {rhs}
-------- -----------------------------
<CR> <Plug>(denite_filter_update)
q <Plug>(denite_filter_quit)
Insert mode default mappings.
{lhs} {rhs}
-------- -----------------------------
<BS> <Plug>(denite_filter_backspace)
<C-h> <Plug>(denite_filter_backspace)
<C-u> <Plug>(denite_filter_clear_backward)
<CR> <Plug>(denite_filter_update)
------------------------------------------------------------------------------
FUNCTIONS *denite-functions*
denite#call_map({map-name}[, {args}]) *denite#call_map()*
Fire {map-name} mapping with {args}. You can find the
mappings list in |denite-key-mappings|.
{args} behavior depends on {map-name}.
Note: It can be used in denite-filter buffer.
*denite#custom#action()*
denite#custom#action({kind}, {name}, {func}[, {options}])
Define {name} action for {kind}.
If {kind} is "source/{source-name}", you can define
{source-name} specific action.
{func} must be a |Funcref| or the name of a function.
{options} is an optional dictionary which overrides the
action behaviors "is_quit" and/or "is_redraw".
Note: {kind} is comma separated.
Note: lambda function is not supported in Vim8.
*denite#custom#alias()*
denite#custom#alias({type}, {alias-name}, {base-name})
Define {alias-name} alias based on {base-name}.
{type} must be "source" or "filter".
*denite#custom#filter()*
denite#custom#filter({filter-name}, {variable-name}, {value})
denite#custom#filter({filter-name}, {dict})
Set {filter-name} filter specialized variable {variable-name}
to {value}. You may specify multiple filters with the
separator "," in {filter-name}.
If {dict} is available, the key is {option-name} and the value
is {value}.
*denite#custom#kind()*
denite#custom#kind({kind-name}, {option-name}, {value})
denite#custom#kind({kind-name}, {dict})
Set {kind-name} kind specialized {option-name} to {value}.
You may specify multiple kinds with the separator "," in
{kind-name}.
A {kind-name} of "_" sets the default for all kinds.
If {dict} is available, the key is {option-name} and the value
is {value}.
The options below are available:
default_action (String)
Specify the kind default action.
|denite-kind-attribute-default_action|
*denite#custom#option()*
denite#custom#option({buffer-name}, {option-name}, {value})
denite#custom#option({buffer-name}, {dict})
Set {option-name} option to {value} in {buffer-name}
buffer.
If {buffer-name} is "_", the options are used for all buffers.
If {dict} is available, the key is {option-name} and the value
is {value}.
Note: The all options are in |denite-options|. However, "-"
is substituted to "_", and "-" prefix is removed. >
call denite#custom#option('default', {
\ 'source_names': 'short',
\ })
*denite#custom#source()*
denite#custom#source({source-name}, {option-name}, {value})
denite#custom#source({source-name}, {dict})
Set {source-name} source specialized {option-name} to {value}.
You may specify multiple sources with the separator "," in
{source-name}.
A {source-name} of "_" sets the default for all sources.
If {dict} is available, the key is {option-name} and the value
is {value}.
The options below are available:
args (List)
Specify the source default arguments.
Default: []
converters (List)
Specify a list of converter names.
|denite-source-attribute-converters|
default_action (String)
Specify the source default action.
|denite-source-attribute-default_action|
matchers (List)
Specify a list of matcher names.
|denite-source-attribute-matchers|
max_candidates (Number)
Specify the maximum candidates.
|denite-source-attribute-max_candidates|
sorters (List)
Specify a list of sorter names.
|denite-source-attribute-sorters|
*denite#custom#var()*
denite#custom#var({source-name}, {var-name}, {value})
denite#custom#var({source-name}, {dict})
Set {source-name} source specialized variable {variable-name}
to {value}. You may specify multiple sources with the
separator "," in {source-name}.
If {dict} is available, the key is {var-name} and the value
is {value}.
*denite#do_action()*
denite#do_action({context}, {action-name}, {targets})
Runs an action {action-name} against {targets}. This will
mainly be used in |denite#custom#action()|.
denite#do_map({map-name}[, {args}]) *denite#do_map()*
Fire {map-name} mapping with {args}. You can find the
mappings list in |denite-key-mappings|.
{args} behavior depends on {map-name}.
Note: It is only used to define mappings.
Note: It can be used in denite-filter buffer. >
autocmd FileType denite-filter
\ call s:denite_filter_my_settings()
function! s:denite_filter_my_settings() abort
inoremap <silent><buffer><expr> <C-c>
\ denite#do_map('quit')
nnoremap <silent><buffer><expr> <C-c>
\ denite#do_map('quit')
endfunction
<
*denite#do_targets()*
denite#do_targets({action-name}, {targets}, [{context}])
Runs an action {action-name} against {candidates} without
denite buffer. >
" Execute "open" action as targets
:call denite#do_targets('open', {
\ 'action__path': '/home/shougo/work/test.c',
\ 'kind': 'file'
\})
denite#get_status({name}) *denite#get_status()*
Returns the {name} part of the status string. It is useful to
customize the statusline.
Note: It also works in the Denite filter window.
The available status names:
"input": Current filtering text
"sources": Current sources and candidates number
"path": Specified |denite-option-path|
"buffer_name": Current |denite-option-buffer-name|
"line_total": Total candidates. Part of "linenr".
*denite#increment_parent_cursor()*
denite#increment_parent_cursor({inc})
Increment the parent denite cursor.
Note: It is only used to define mappings.
Note: It is only for neovim.
*denite#initialize()*
denite#initialize()
Initialize denite and sources.
Note: You don't have to call it manually.
denite#move_to_filter() *denite#move_to_filter()*
Move to the filter buffer.
Note: It is only used to define mappings.
denite#move_to_parent() *denite#move_to_parent()*
Move to the parent denite buffer.
Note: It is only used to define mappings.
Note: It can be used in denite-filter buffer.
*denite#start()*
denite#start({sources}[, {context}])
Creates a new Denite buffer.
{sources} is a list of elements which are formatted as:
>
"{'name': {source-name}, 'args': {source-args}}"
<
Refer to |denite-notation-{context}| about {context}. If you
skip a value, it uses the default value.
>
call denite#start([{'name': 'file/rec', 'args': []}])
<
------------------------------------------------------------------------------
OPTIONS *denite-options*
*denite-option-no-*
-no-{option-name}
Disable {option-name} flag.
Note: If you use both {option-name} and -no-{option-name} in
the same denite buffer, it is undefined.
*denite-option-auto-action*
-auto-action={action}
When you select a candidate, it runs the action automatically.
Default: ""
*denite-option-auto-resize*
-auto-resize
Auto resize the Denite window height automatically.
Default: false
*denite-option-buffer-name*
-buffer-name={buffer-name}
Specify the name of denite buffer.
Default: "default"
*denite-option-default-action*
-default-action={action}
Specify the default action as {action}.
Default: "default"
Note: It overwrites all default actions includes kind/source
default actions.
*denite-option-cursor-pos*
-cursor-pos={number}
Select {number} candidate.
If {number} is "+{N}" or "-{N}" when resume, selects the next
{N} or previous {N} candidate.
previous {N} candidate.
Note: "0" is the first candidate.
Note: "$" is the last candidate.
Default: ""
*denite-option-direction*
-direction={direction}
Specify the Denite window direction as {direction}.
When it is "dynamictop", if each item's length is less than
the current window's width, the direction becomes "aboveleft",
otherwise - "topleft".
Similarly for "dynamicbottom", the direction becomes
"belowright" or "botright".
It is useful to always make best effort to show all items
without shortening.
Default: "botright"
*denite-option-do*
-do={command}
Execute a {command} for each candidate's default action.
You can use it like |:argdo|.
Default: ""
*denite-option-empty*
-empty
Open any denite buffer if the candidate is empty.
Default: true
*denite-option-expand*
-expand
|expand()| the input.
Note: It is useful for file sources.
Default: false
*denite-option-filter-split-direction*
-filter-split-direction={direction}
Specify the Denite filter window direction as {direction}.
When {direction} is "floating", the filter uses neovim
floating window. If statusline is at the bottom, the filter
overwrites statusline. Otherwise, it is located one line below
statusline.
Note: To use "floating", you need to use neovim
0.4.0+(|nvim_open_win()|).
Default: "botright"
*denite-option-filter-updatetime*
-filter-updatetime={time}
Specify the update time in the Denite filter window.
If it is less than equal 0, the feature will be disabled.
Default: 30
*denite-option-filter-zindex*
-filter-zindex={index}
Specify the filter floating window zindex.
Note: To use it, you need to use neovim
0.5.0+(|nvim_open_win()|).
Default: 0(Disabled)
*denite-option-floating-border*
-floating-border={type}
Specify the floating window border.
Note: To use it, you need to use neovim
0.5.0+(|nvim_open_win()|).
Default: ""
*denite-option-floating-preview*
-floating-preview
Open the preview window in floating window when
|denite-option-vertical-preview|.
Note: To use it, you need to use neovim
0.4.0+(|nvim_open_win()|).
Note: If you need the feature in Vim8, you should use
'previewpopup' instead.
Default: false
*denite-option-floating-zindex*
-floating-zindex={index}
Specify the floating window zindex.
Note: To use it, you need to use neovim
0.5.0+(|nvim_open_win()|).
Default: 0(Disabled)
*denite-option-highlight-filter-background*
-highlight-filter-background
Change backgroud color group in floating filter window.
Default: "NormalFloat"
*denite-option-highlight-matched-char*
-highlight-matched-char
Matched characters highlight.
Default: "None"
*denite-option-highlight-matched-range*
-highlight-matched-range
Matched range highlight.
Default: "Underlined"
*denite-option-highlight-preview-line*
-highlight-preview-line
Previewed line highlight.
Default: "Search"
*denite-option-highlight-prompt*
-highlight-prompt
Prompt highlight in filter window.
Default: "Special"
*denite-option-highlight-window-background*
-highlight-window-background
Change backgroud color group in floating window.
Default: "NormalFloat"
*denite-option-ignorecase*
-ignorecase
If it is true, denite ignores the case.
Default: true
*denite-option-immediately*
-immediately
If candidates exist, it runs the default action
immediately.
Default: false
*denite-option-immediately-1*
-immediately-1
If the number of candidates is exactly one, it runs the
default action immediately.
immediately.
Default: false
*denite-option-input*
-input={input-text}
Specify an initial narrowing text.
Default: ""
*denite-option-match-highlight*
-match-highlight
Highlight matched chars.
Note: Vim 8.1.1084+ is needed for it.
Note: It is slow.
Default: v:false
*denite-option-matchers*
-matchers
Specify a list of matcher names. They overwrite the source
matchers.
Default: ""
*denite-option-max-candidate-width*
-max-candidate-width={width}
Specify the max candidate width.
Note: Denite skip the match after the width.
Default: 200
*denite-option-max-dynamic-update-candidates*
-max-dynamic-update-candidates={length}
If the candidates are more than it, denite will ignore the
dynamic filtering.
Default: 20000
*denite-option-path*
-path={path}
Specify an initial narrowing path.
Default: |getcwd()|
*denite-option-post-action*
-post-action={action}
Specify the action after action.
"jump": open the denite buffer and jump to the file.
"open": open the denite buffer.
"quit": quit the denite buffer.
Otherwise: nothing.
Default: "none"
*denite-option-prompt*
-prompt={prompt-text}
Specify the prompt in filter window.
Note: It must one or two characters.
Default: ""
*denite-option-preview-height*
-preview-height={preview-height}
Specify the preview window height.
Default: 'previewheight'
*denite-option-preview-width*
-preview-width={preview-width}
Specify the preview width when
|denite-option-vertical-preview|.
Default: 40
*denite-option-quick-move*
-quick-move={action}
It runs |denite-map-quick_move| automatically.
"immediately": runs the default action immediately
Empty string : nothing.
Otherwise: move to the position.
Default: ""
*denite-option-quick-move-table*
-quick-move-table
The table of completion candidates of quick move list,
corresponding the narrowing text.
Note: You cannot specify it from the command-line.
Default: >
{
\ 'a' : 0, 's' : 1, 'd' : 2, 'f' : 3, 'g' : 4,
\ 'h' : 5, 'j' : 6, 'k' : 7, 'l' : 8, ';' : 9,
\ 'q' : 10, 'w' : 11, 'e' : 12, 'r' : 13, 't' : 14,
\ 'y' : 15, 'u' : 16, 'i' : 17, 'o' : 18, 'p' : 19,
\ '1' : 20, '2' : 21, '3' : 22, '4' : 23, '5' : 24,
\ '6' : 25, '7' : 26, '8' : 27, '9' : 28, '0' : 29,
\ }
<
*denite-option-refresh*
-refresh
Refresh the candidates when |denite-option-resume| is true.
Default: false
*denite-option-relpath*
-relpath={path}
Specify an relative path from |denite-option-path|.
Default: ""
*denite-option-resume*
-resume
Reuse the previous buffer. If none exist, a new denite
buffer gets created.
Note: Uses |denite-option-buffer-name| to search for
previous buffers.
Default: false
*denite-option-reversed*
-reversed
The candidates are reversed.
Note: It is slow.
Default: false
*denite-option-root-markers*
-root-markers={markers}
The project root marker files.
It is splitted by comma.
Default: ""
*denite-option-search*
-search
If it is true, denite update |quote/| register after user
input.
It is useful when you want to use |gn| mapping.
Default: false
*denite-option-smartcase*
-smartcase
If it is true, denite ignores the case when the input contains
the uppercase characters.
Default: false
*denite-option-sorters*
-sorters
Specify a list of sorter names. They are source independent.
Default: ""
*denite-option-split*
-split={direction}
Specify the split direction.
"vertical": Split buffer vertically
"horizontal": Split buffer horizontally
"no": No split
"tab": Create the new tab for denite buffer
"floating": Use neovim floating window feature
"floating_relative_cursor": similar to "floating" but open
floating window near the cursor.
"floating_relative_window": similar to "floating" but open
floating window near the window.