Skip to content

Commit 2c748ec

Browse files
committed
update document
1 parent 61a17a1 commit 2c748ec

File tree

2 files changed

+79
-2
lines changed

2 files changed

+79
-2
lines changed

README.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,9 @@
11
# ddc-vim-lsp
22

33
vim-lsp for ddc.vim.
4+
- ddc.vim : v0.4.2
5+
6+
<img src="https://user-images.githubusercontent.com/212602/131358924-a62bd611-81ea-413b-aba5-2439fc42ae66.png" width="600"><br>
47

58
## Required
69

doc/study.md

Lines changed: 76 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,75 @@
1+
# v0.1.0
2+
3+
```plantuml
4+
5+
box "vim/neovim" #A5D6A7
6+
participant core
7+
end box
8+
9+
box "ddc-vim-lsp" #FFCCBC
10+
participant autoload
11+
participant plugin
12+
participant source
13+
end box
14+
15+
box "ddc" #B2EBF2
16+
participant ddc
17+
end box
18+
19+
box "denops" #B2EBF2
20+
participant denops
21+
end box
22+
23+
box "vim-lsp" #B2EBF2
24+
participant vimlsp as "vim-lsp"
25+
end box
26+
27+
box "lsp" #BBDEFB
28+
participant lsp as "lsp server"
29+
end box
30+
31+
== input text ==
32+
core -> ddc: detect input text
33+
34+
ddc -> source: gatherCandidates
35+
source -> autoload: call ddc_vim_lsp#request
36+
autoload ->> vimlsp: call lsp#send_request
37+
source --> ddc: return empty candidates
38+
39+
...
40+
41+
group lsp sequence
42+
vimlsp ->> lsp:
43+
lsp ->> vimlsp:
44+
end
45+
46+
vimlsp ->> autoload: callback
47+
autoload -> vimlsp: call lsp#omni#get_vim_completion_items
48+
return
49+
autoload -> core: store lsp items
50+
note right
51+
store it on
52+
vim global variable
53+
endnote
54+
55+
autoload -> ddc: call ddc#refresh_candidates
56+
return
57+
...
58+
59+
ddc -> source: gatherCandidates
60+
note right
61+
"gatnerCandidates" is called automatically
62+
to trigger by "ddc#refresh_candidates".
63+
endnote
64+
source -> denops: get lsp items
65+
denops -> core: get variable
66+
return variable
67+
denops --> source: lsp items
68+
source --> ddc: return candidates
69+
70+
```
71+
72+
# v0.0.1
173

274
```plantuml
375
@@ -31,14 +103,16 @@ end box
31103
core -> ddc: detect input text
32104
ddc -> source: gatherCandidates
33105
source -> autoload: call ddc_vim_lsp#request
34-
autoload ->> vimlsp: call send_request
106+
autoload ->> vimlsp: call lsp#send_request
35107
36108
group lsp sequence
37109
vimlsp ->> lsp:
38110
lsp ->> vimlsp:
39111
end
40112
41-
vimlsp ->> autoload: call back
113+
vimlsp ->> autoload: callback
114+
autoload -> vimlsp: call lsp#omni#get_vim_completion_items
115+
return
42116
autoload ->> source: call anonymous func
43117
source -> source: call toCandidates
44118
source ->> ddc: return candidates

0 commit comments

Comments
 (0)