Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Do not resolve during annotate, enrich documentation with details (Fix #3201) (Fix #3905) #4625

Open
wants to merge 5 commits into
base: master
Choose a base branch
from
+58 −13
Open

Do not resolve during annotate, enrich documentation with details (Fix #3201) (Fix #3905) #4625

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
996da76
Do not resolve during annotate, enrich documentation with details
wyuenho Nov 26, 2024
7a2b2ba
cache adjusted documentation
wyuenho Nov 27, 2024
b305fdd
Make lsp-completion--resolve[-async] public
wyuenho Nov 28, 2024
78d2455
Resolved detail may be different from unresolved detail
wyuenho Dec 1, 2024
f85bece
Do not fontify detail in documentation
wyuenho Dec 1, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
71 changes: 58 additions & 13 deletions lsp-completion.el
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -171,6 +171,7 @@ This will help minimize popup flickering issue in `company-mode'."
:_emacsStartPoint start-point)
item))
(propertize label
'lsp-completion-unresolved-item item
'lsp-completion-item item
'lsp-sort-text sort-text?
'lsp-completion-start-point start-point
Expand All @@ -185,7 +186,7 @@ See #2675"
(unless (lsp-get data :import_for_trait_assoc_item)
(lsp-put data :import_for_trait_assoc_item :json-false)))))

(defun lsp-completion--resolve (item)
(defun lsp-completion-resolve (item)
"Resolve completion ITEM.
ITEM can be string or a CompletionItem"
(cl-assert item nil "Completion item must not be nil")
Expand All @@ -210,7 +211,9 @@ ITEM can be string or a CompletionItem"
item))
(_ completion-item)))))

(defun lsp-completion--resolve-async (item callback &optional cleanup-fn)
(defalias 'lsp-completion--resolve 'lsp-completion-resolve)

(defun lsp-completion-resolve-async (item callback &optional cleanup-fn)
"Resolve completion ITEM asynchronously with CALLBACK.
The CLEANUP-FN will be called to cleanup."
(cl-assert item nil "Completion item must not be nil")
Expand Down Expand Up @@ -241,12 +244,12 @@ The CLEANUP-FN will be called to cleanup."
(funcall callback completion-item)
(when cleanup-fn (funcall cleanup-fn))))))

(defalias 'lsp-completion--resolve-async 'lsp-completion-resolve-async)

(defun lsp-completion--annotate (item)
"Annotate ITEM detail."
(-let (((completion-item &as &CompletionItem :detail? :kind? :label-details?)
(get-text-property 0 'lsp-completion-item item)))
(lsp-completion--resolve-async item #'ignore)

(get-text-property 0 'lsp-completion-unresolved-item item)))
(concat (when (and lsp-completion-show-detail detail?)
(concat " " (s-replace "\r" "" detail?)))
(when (and lsp-completion-show-label-description label-details?)
Expand Down Expand Up @@ -455,11 +458,53 @@ The MARKERS and PREFIX value will be attached to each candidate."

(defun lsp-completion--get-documentation (item)
"Get doc comment for completion ITEM."
(-some->> item
(lsp-completion--resolve)
(get-text-property 0 'lsp-completion-item)
(lsp:completion-item-documentation?)
(lsp--render-element)))
(or (get-text-property 0 'lsp-completion-item-doc item)
(-let* (((&CompletionItem :detail?
:documentation?)
(get-text-property 0 'lsp-completion-item (lsp-completion-resolve item)))
(doc
(if (and detail? documentation?)
;; detail was resolved, that means the candidate list has no
;; detail, so we may need to prepend it to the documentation
(cond ((lsp-markup-content? documentation?)
(-let (((&MarkupContent :kind :value) documentation?))
(cond ((and (equal kind "plaintext")
(not (string-match-p (regexp-quote detail?) value)))

(lsp--render-string
(concat detail?
(if (bound-and-true-p page-break-lines-mode)
"\n \n"
"\n\n")
value)
kind))

((and (equal kind "markdown")
(not (string-match-p (regexp-quote detail?) value)))

(concat
(propertize detail? 'face 'fixed-pitch)
(lsp--render-string
(concat
"\n---\n"
value)
kind))))))

((and (stringp documentation?)
(not (string-match-p (regexp-quote detail?) documentation?)))

(lsp--render-string
(concat detail?
(if (bound-and-true-p page-break-lines-mode)
"\n \n"
"\n\n")
documentation?)
"plaintext")))

(lsp--render-element documentation?))))

(put-text-property 0 (length item) 'lsp-completion-item-doc doc item)
doc)))

(defun lsp-completion--get-context (trigger-characters same-session?)
"Get completion context with provided TRIGGER-CHARACTERS and SAME-SESSION?."
Expand Down Expand Up @@ -620,7 +665,7 @@ Others: CANDIDATES"
;; see #3498 typescript-language-server does not provide the
;; proper insertText without resolving.
(if (lsp-completion--find-workspace 'ts-ls)
(lsp-completion--resolve candidate)
(lsp-completion-resolve candidate)
candidate))
((&plist 'lsp-completion-item item
'lsp-completion-start-point start-point
Expand Down Expand Up @@ -662,14 +707,14 @@ Others: CANDIDATES"
(not (seq-empty-p additional-text-edits?)))
(lsp--apply-text-edits additional-text-edits? 'completion)
(-let [(callback cleanup-fn) (lsp--create-apply-text-edits-handlers)]
(lsp-completion--resolve-async
(lsp-completion-resolve-async
item
(-compose callback #'lsp:completion-item-additional-text-edits?)
cleanup-fn))))

(if (or resolved command?)
(when command? (lsp--execute-command command?))
(lsp-completion--resolve-async
(lsp-completion-resolve-async
item
(-lambda ((&CompletionItem? :command?))
(when command? (lsp--execute-command command?)))))
Expand Down
Loading