lsp-bridge怎么去掉不匹配的补全项？

manateelazycat · 2022 年11 月 3 日 11:57

那是补全前端按照前缀过滤了。

Young-people · 2022 年11 月 4 日 02:13

参数直接改配置文件？还是有接口啥的

manateelazycat · 2022 年11 月 4 日 02:14

你要研究 typescript-language-server 的文档，我不知道啊。

twlz0ne · 2022 年11 月 4 日 02:37

我给 typescript language server 提了 issue：

github.com/typescript-language-server/typescript-language-server

Redundant items in response of "textDocument/completion"

opened 02:16AM - 04 Nov 22 UTC

closed 10:23AM - 04 Nov 22 UTC

twlz0ne

### Steps to Reproduce: 0. Prepare test file ```sh $ cat ~/Downloads/test…_ts/test.ts interface User { name: string; id: number; } class UserAccount { name: string; id: number; constructor(name: string, id: number) { this.id = id; this. } } ``` 1. Start Emacs ```sh $ emacs -Q -L ~/.emacs.d/29.0/elpa/typescript-mode-20220805.2008 --eval "\ (progn (require 'typescript-mode) (add-hook 'typescript-mode-hook #'eglot-ensure))" -nw ~/Downloads/test_ts/test.ts ``` 2. Move cursor to the end of `this.`. 3. Type `n`. 4. Press `C-M-i`. ### Actual Behavior Server response contains all items (`id` and `name`): ```log [server-reply] (id:11) Fri Nov 4 09:42:13 2022: (:jsonrpc "2.0" :id 11 :result (:items [(:label "id" :kind 5 :sortText "11" :commitCharacters ["." "," "("] :data (:file "//Users/foo/Downloads/test_ts/test.ts" :line 12 :offset 8 :entryNames ["id"])) (:label "name" :kind 5 :sortText "11" :commitCharacters ["." "," "("] :data (:file "//Users/foo/Downloads/test_ts/test.ts" :line 12 :offset 8 :entryNames ["name"]))] :isIncomplete :json-false)) ``` See full log bellow. ### Expected Behavior Return only the matched item (`name`). ### Environment - macOS 10.13.6 - Emacs 28.2 & 29.0 - Typescript language server 2.1.0 - Packages: + typescript-mode-20220805.2008 + eglot-20221020.1010 ### Eglot log ```log [internal] Fri Nov 4 09:42:01 2022: (:message "Running language server: typescript-language-server --stdio") [client-request] (id:1) Fri Nov 4 09:42:01 2022: (:jsonrpc "2.0" :id 1 :method "initialize" :params (:processId 51845 :rootPath "/Users/foo/" :rootUri "file:////Users/foo" :initializationOptions #s(hash-table size 1 test eql rehash-size 1.5 rehash-threshold 0.8125 data ()) :capabilities (:workspace (:applyEdit t :executeCommand (:dynamicRegistration :json-false) :workspaceEdit (:documentChanges t) :didChangeWatchedFiles (:dynamicRegistration t) :symbol (:dynamicRegistration :json-false) :configuration t :workspaceFolders t) :textDocument (:synchronization (:dynamicRegistration :json-false :willSave t :willSaveWaitUntil t :didSave t) :completion (:dynamicRegistration :json-false :completionItem (:snippetSupport :json-false :deprecatedSupport t :tagSupport (:valueSet [1])) :contextSupport t) :hover (:dynamicRegistration :json-false :contentFormat ["plaintext"]) :signatureHelp (:dynamicRegistration :json-false :signatureInformation (:parameterInformation (:labelOffsetSupport t) :activeParameterSupport t)) :references (:dynamicRegistration :json-false) :definition (:dynamicRegistration :json-false :linkSupport t) :declaration (:dynamicRegistration :json-false :linkSupport t) :implementation (:dynamicRegistration :json-false :linkSupport t) :typeDefinition (:dynamicRegistration :json-false :linkSupport t) :documentSymbol (:dynamicRegistration :json-false :hierarchicalDocumentSymbolSupport t :symbolKind (:valueSet [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])) :documentHighlight (:dynamicRegistration :json-false) :codeAction (:dynamicRegistration :json-false :codeActionLiteralSupport (:codeActionKind (:valueSet ["quickfix" "refactor" "refactor.extract" "refactor.inline" "refactor.rewrite" "source" "source.organizeImports"])) :isPreferredSupport t) :formatting (:dynamicRegistration :json-false) :rangeFormatting (:dynamicRegistration :json-false) :rename (:dynamicRegistration :json-false) :publishDiagnostics (:relatedInformation :json-false :codeDescriptionSupport :json-false :tagSupport (:valueSet [1 2]))) :experimental #s(hash-table size 1 test eql rehash-size 1.5 rehash-threshold 0.8125 data ())) :workspaceFolders [(:uri "file:////Users/foo" :name "~/")])) [server-notification] Fri Nov 4 09:42:01 2022: (:jsonrpc "2.0" :method "window/logMessage" :params (:type 3 :message "[lspserver] Using Typescript version (bundled) 4.8.4 from path \"//Users/foo/repos/shims/nodenv/versions/17.9.1/lib/node_modules/typescript/lib/tsserver.js\"")) [server-reply] (id:1) Fri Nov 4 09:42:01 2022: (:jsonrpc "2.0" :id 1 :result (:capabilities (:textDocumentSync 2 :completionProvider (:triggerCharacters ["." "\"" "'" "/" "@" "<"] :resolveProvider t) :codeActionProvider (:codeActionKinds ["source.fixAll.ts" "source.removeUnused.ts" "source.addMissingImports.ts" "source.organizeImports.ts" "quickfix" "refactor"]) :definitionProvider t :documentFormattingProvider t :documentRangeFormattingProvider t :documentHighlightProvider t :documentSymbolProvider t :executeCommandProvider (:commands ["_typescript.applyWorkspaceEdit" "_typescript.applyCodeAction" "_typescript.applyRefactoring" "_typescript.configurePlugin" "_typescript.organizeImports" "_typescript.applyRenameFile" "_typescript.goToSourceDefinition"]) :hoverProvider t :inlayHintProvider t :renameProvider t :referencesProvider t :signatureHelpProvider (:triggerCharacters ["(" "," "<"] :retriggerCharacters [")"]) :workspaceSymbolProvider t :implementationProvider t :typeDefinitionProvider t :foldingRangeProvider t :semanticTokensProvider (:documentSelector nil :legend (:tokenTypes ["class" "enum" "interface" "namespace" "typeParameter" "type" "parameter" "variable" "enumMember" "property" "function" "member"] :tokenModifiers ["declaration" "static" "async" "readonly" "defaultLibrary" "local"]) :full t :range t) :callsProvider t))) [client-notification] Fri Nov 4 09:42:01 2022: (:jsonrpc "2.0" :method "initialized" :params #s(hash-table size 1 test eql rehash-size 1.5 rehash-threshold 0.8125 data ())) [client-notification] Fri Nov 4 09:42:01 2022: (:jsonrpc "2.0" :method "textDocument/didOpen" :params (:textDocument (:uri "file:////Users/foo/Downloads/test_ts/test.ts" :version 0 :languageId "typescript" :text "interface User {\n name: string;\n id: number;\n}\n\nclass UserAccount {\n name: string;\n id: number;\n\n constructor(name: string, id: number) {\n this.id = id;\n this.\n }\n}\n"))) [client-notification] Fri Nov 4 09:42:01 2022: (:jsonrpc "2.0" :method "workspace/didChangeConfiguration" :params (:settings #s(hash-table size 1 test eql rehash-size 1.5 rehash-threshold 0.8125 data ()))) [server-notification] Fri Nov 4 09:42:03 2022: (:jsonrpc "2.0" :method "textDocument/publishDiagnostics" :params (:uri "file:////Users/foo/Downloads/test_ts/test.ts" :diagnostics [(:range (:start (:line 12 :character 4) :end (:line 12 :character 5)) :message "Identifier expected." :severity 1 :code 1003 :source "typescript" :tags []) (:range (:start (:line 9 :character 16) :end (:line 9 :character 20)) :message "'name' is declared but its value is never read." :severity 4 :code 6133 :source "typescript" :tags [1])])) [client-request] (id:2) Fri Nov 4 09:42:05 2022: (:jsonrpc "2.0" :id 2 :method "textDocument/signatureHelp" :params (:textDocument (:uri "file:////Users/foo/Downloads/test_ts/test.ts") :position (:line 14 :character 0))) [client-request] (id:3) Fri Nov 4 09:42:05 2022: (:jsonrpc "2.0" :id 3 :method "textDocument/hover" :params (:textDocument (:uri "file:////Users/foo/Downloads/test_ts/test.ts") :position (:line 14 :character 0))) [client-request] (id:4) Fri Nov 4 09:42:05 2022: (:jsonrpc "2.0" :id 4 :method "textDocument/documentHighlight" :params (:textDocument (:uri "file:////Users/foo/Downloads/test_ts/test.ts") :position (:line 14 :character 0))) [server-reply] (id:2) Fri Nov 4 09:42:05 2022: (:jsonrpc "2.0" :id 2 :result nil) [server-reply] (id:3) Fri Nov 4 09:42:05 2022: (:jsonrpc "2.0" :id 3 :result (:contents [])) [server-reply] (id:4) Fri Nov 4 09:42:05 2022: (:jsonrpc "2.0" :id 4 :result []) [server-notification] Fri Nov 4 09:42:06 2022: (:jsonrpc "2.0" :method "textDocument/publishDiagnostics" :params (:uri "file:////Users/foo/Downloads/test_ts/test.ts" :diagnostics [(:range (:start (:line 12 :character 4) :end (:line 12 :character 5)) :message "Identifier expected." :severity 1 :code 1003 :source "typescript" :tags []) (:range (:start (:line 9 :character 16) :end (:line 9 :character 20)) :message "'name' is declared but its value is never read." :severity 4 :code 6133 :source "typescript" :tags [1])])) [client-request] (id:5) Fri Nov 4 09:42:06 2022: (:jsonrpc "2.0" :id 5 :method "textDocument/signatureHelp" :params (:textDocument (:uri "file:////Users/foo/Downloads/test_ts/test.ts") :position (:line 11 :character 6))) [client-request] (id:6) Fri Nov 4 09:42:06 2022: (:jsonrpc "2.0" :id 6 :method "textDocument/hover" :params (:textDocument (:uri "file:////Users/foo/Downloads/test_ts/test.ts") :position (:line 11 :character 6))) [client-request] (id:7) Fri Nov 4 09:42:06 2022: (:jsonrpc "2.0" :id 7 :method "textDocument/documentHighlight" :params (:textDocument (:uri "file:////Users/foo/Downloads/test_ts/test.ts") :position (:line 11 :character 6))) [server-reply] (id:5) Fri Nov 4 09:42:06 2022: (:jsonrpc "2.0" :id 5 :result nil) [server-reply] (id:6) Fri Nov 4 09:42:06 2022: (:jsonrpc "2.0" :id 6 :result (:contents [])) [server-reply] (id:7) Fri Nov 4 09:42:06 2022: (:jsonrpc "2.0" :id 7 :result []) [internal] (id:8) Fri Nov 4 09:42:10 2022: (:deferring :textDocument/signatureHelp :id 8 :params (:textDocument (:uri "file:////Users/foo/Downloads/test_ts/test.ts") :position (:line 11 :character 7))) [internal] (id:9) Fri Nov 4 09:42:10 2022: (:deferring :textDocument/hover :id 9 :params (:textDocument (:uri "file:////Users/foo/Downloads/test_ts/test.ts") :position (:line 11 :character 7))) [internal] (id:10) Fri Nov 4 09:42:10 2022: (:deferring :textDocument/documentHighlight :id 10 :params (:textDocument (:uri "file:////Users/foo/Downloads/test_ts/test.ts") :position (:line 11 :character 7))) [client-notification] Fri Nov 4 09:42:10 2022: (:jsonrpc "2.0" :method "textDocument/didChange" :params (:textDocument (:uri "file:////Users/foo/Downloads/test_ts/test.ts" :version 1) :contentChanges [(:range (:start (:line 11 :character 6) :end (:line 11 :character 6)) :rangeLength 0 :text "n")])) [internal] Fri Nov 4 09:42:10 2022: (:maybe-run-deferred (10 9 8)) [client-request] (id:10) Fri Nov 4 09:42:10 2022: (:jsonrpc "2.0" :id 10 :method "textDocument/documentHighlight" :params (:textDocument (:uri "file:////Users/foo/Downloads/test_ts/test.ts") :position (:line 11 :character 7))) [client-request] (id:9) Fri Nov 4 09:42:10 2022: (:jsonrpc "2.0" :id 9 :method "textDocument/hover" :params (:textDocument (:uri "file:////Users/foo/Downloads/test_ts/test.ts") :position (:line 11 :character 7))) [client-request] (id:8) Fri Nov 4 09:42:10 2022: (:jsonrpc "2.0" :id 8 :method "textDocument/signatureHelp" :params (:textDocument (:uri "file:////Users/foo/Downloads/test_ts/test.ts") :position (:line 11 :character 7))) [server-reply] (id:10) Fri Nov 4 09:42:10 2022: (:jsonrpc "2.0" :id 10 :result []) [server-reply] (id:9) Fri Nov 4 09:42:10 2022: (:jsonrpc "2.0" :id 9 :result (:contents (:kind "markdown" :value "\n```typescript\nany\n```\n") :range (:start (:line 11 :character 6) :end (:line 11 :character 7)))) [server-reply] (id:8) Fri Nov 4 09:42:10 2022: (:jsonrpc "2.0" :id 8 :result nil) [server-notification] Fri Nov 4 09:42:11 2022: (:jsonrpc "2.0" :method "textDocument/publishDiagnostics" :params (:uri "file:////Users/foo/Downloads/test_ts/test.ts" :diagnostics [(:range (:start (:line 11 :character 6) :end (:line 11 :character 7)) :message "Property 'n' does not exist on type 'UserAccount'." :severity 1 :code 2339 :source "typescript" :tags []) (:range (:start (:line 9 :character 16) :end (:line 9 :character 20)) :message "'name' is declared but its value is never read." :severity 4 :code 6133 :source "typescript" :tags [1])])) [client-request] (id:11) Fri Nov 4 09:42:13 2022: (:jsonrpc "2.0" :id 11 :method "textDocument/completion" :params (:textDocument (:uri "file:////Users/foo/Downloads/test_ts/test.ts") :position (:line 11 :character 7) :context (:triggerKind 1))) [server-reply] (id:11) Fri Nov 4 09:42:13 2022: (:jsonrpc "2.0" :id 11 :result (:items [(:label "id" :kind 5 :sortText "11" :commitCharacters ["." "," "("] :data (:file "//Users/foo/Downloads/test_ts/test.ts" :line 12 :offset 8 :entryNames ["id"])) (:label "name" :kind 5 :sortText "11" :commitCharacters ["." "," "("] :data (:file "//Users/foo/Downloads/test_ts/test.ts" :line 12 :offset 8 :entryNames ["name"]))] :isIncomplete :json-false)) [client-request] (id:12) Fri Nov 4 09:42:13 2022: (:jsonrpc "2.0" :id 12 :method "completionItem/resolve" :params (:label #("name" 0 1 (eglot--lsp-item #1)) :kind 5 :sortText "11" :commitCharacters ["." "," "("] :data (:file "//Users/foo/Downloads/test_ts/test.ts" :line 12 :offset 8 :entryNames ["name"]))) [server-reply] (id:12) Fri Nov 4 09:42:13 2022: (:jsonrpc "2.0" :id 12 :result (:label "name" :kind 5 :sortText "11" :commitCharacters ["." "," "("] :data (:file "//Users/foo/Downloads/test_ts/test.ts" :line 12 :offset 8 :entryNames ["name"]) :detail "(property) UserAccount.name: string")) [client-notification] Fri Nov 4 09:42:13 2022: (:jsonrpc "2.0" :method "textDocument/didChange" :params (:textDocument (:uri "file:////Users/foo/Downloads/test_ts/test.ts" :version 2) :contentChanges [(:range (:start (:line 11 :character 7) :end (:line 11 :character 7)) :rangeLength 0 :text "ame")])) [client-request] (id:13) Fri Nov 4 09:42:13 2022: (:jsonrpc "2.0" :id 13 :method "textDocument/signatureHelp" :params (:textDocument (:uri "file:////Users/foo/Downloads/test_ts/test.ts") :position (:line 11 :character 10))) [client-request] (id:14) Fri Nov 4 09:42:13 2022: (:jsonrpc "2.0" :id 14 :method "textDocument/hover" :params (:textDocument (:uri "file:////Users/foo/Downloads/test_ts/test.ts") :position (:line 11 :character 10))) [client-request] (id:15) Fri Nov 4 09:42:13 2022: (:jsonrpc "2.0" :id 15 :method "textDocument/documentHighlight" :params (:textDocument (:uri "file:////Users/foo/Downloads/test_ts/test.ts") :position (:line 11 :character 10))) [server-reply] (id:13) Fri Nov 4 09:42:13 2022: (:jsonrpc "2.0" :id 13 :result nil) [server-reply] (id:14) Fri Nov 4 09:42:13 2022: (:jsonrpc "2.0" :id 14 :result (:contents (:kind "markdown" :value "\n```typescript\n(property) UserAccount.name: string\n```\n") :range (:start (:line 11 :character 6) :end (:line 11 :character 10)))) [server-reply] (id:15) Fri Nov 4 09:42:13 2022: (:jsonrpc "2.0" :id 15 :result [(:kind 2 :range (:start (:line 6 :character 4) :end (:line 6 :character 8))) (:kind 2 :range (:start (:line 11 :character 6) :end (:line 11 :character 10)))]) [server-notification] Fri Nov 4 09:42:13 2022: (:jsonrpc "2.0" :method "textDocument/publishDiagnostics" :params (:uri "file:////Users/foo/Downloads/test_ts/test.ts" :diagnostics [(:range (:start (:line 9 :character 16) :end (:line 9 :character 20)) :message "'name' is declared but its value is never read." :severity 4 :code 6133 :source "typescript" :tags [1])])) [internal] (id:8) Fri Nov 4 09:42:20 2022: (:timed-out :textDocument/signatureHelp :id 8 :params (:textDocument (:uri "file:////Users/foo/Downloads/test_ts/test.ts") :position (:line 11 :character 7))) [internal] (id:9) Fri Nov 4 09:42:20 2022: (:timed-out :textDocument/hover :id 9 :params (:textDocument (:uri "file:////Users/foo/Downloads/test_ts/test.ts") :position (:line 11 :character 7))) [internal] (id:10) Fri Nov 4 09:42:20 2022: (:timed-out :textDocument/documentHighlight :id 10 :params (:textDocument (:uri "file:////Users/foo/Downloads/test_ts/test.ts") :position (:line 11 :character 7))) ```

想要尽快解决问题，当然是报给最熟悉相关代码的人，一直在这里讨论很难有什么实质进展。

twlz0ne · 2022 年11 月 7 日 06:58

其实 typescript-language-server 没错，它返回的结果是完整结果，也就是 isIncomplete: false，即 this. 和 this.i 补全项相同。

可能目前大多数所用的 ls 返回结果都是 incomplete，所以 lsp-bridge 显示正常，因而鲜有人报 bug。而 lsp-mode/eglot 上有前端过滤，所以 isIncomplete 是啥也不影响用户。

我测试了几款 ls，情况如下：

server	isIncomplete 值	实际结果集	结果符合预期	lsp-bridge 显示
pyright	True	incomplete	符合✅	无多余的项
pylsp	False	incomplete	不符	无多余的项
jedi	False	incomplete	不符。可能传染给了 pylsp	无多余的项
gopls	True	incomplete	符合✅	无多余的项
rust-analyzer	True	complete	不符	有多余的项🐞
typescript-language-server	False	complete	符合✅	有多余的项🐞
solargraph	False	incomplete	不符	无多余的项

所以我认为 lsp-bridge 也需要处理一下这个问题。

首先我试着在 completion.py 中过滤补全项，但是发现 lsp-bridge 会缓存上一次请求的结果，因此在 completion.py 中过滤会有漏网之虞：

输入 self. (所有补全项已缓存)
按 C-g 关闭补全菜单
按 i 激活补全此时 lsp-bridge 会先从缓存读取补全项（所有），然后再向 ls 发起请求，得到符合 self.i 的补全项。

所以改为在 acm/acm-backend-lsp.el:acm-backend-lsp-candidates 中过滤。

这是我的修改 (鉴于目前发现存在 language server 错误标识 isIncomplete 的情况，所以一律对补全项进行过滤): Filter lsp completion · twlz0ne/lsp-bridge@ac5b1ac · GitHub

twlz0ne · 2022 年11 月 7 日 07:09

@Young-people 试试我改的这个分支的代码 GitHub - twlz0ne/lsp-bridge at filter-lsp-completion

manateelazycat · 2022 年11 月 7 日 07:14

大佬测试这么多语言，很严谨呀！

但是我强烈不建议在 Elisp 端做过滤，因为像 volar 这样的变态 LSP Server，它最多可以返回上万条的候选词列表，如果在 Elisp 端做任何过滤，都有可能导致用户输入一个字符就要对一万条候选词做Elisp模糊匹配，最终结果是用户肉眼可见的前端补全 frame 卡顿。

大佬说的缓存的问题，不应该存在啊，因为 acm 菜单关闭后就会调用 acm-backend-lsp-clean lsp-bridge/acm-backend-lsp.el at fc7384d2850ad580fc32ecb490333fb4438cc099 · manateelazycat/lsp-bridge · GitHub 默认清空LSP返回的候选词列表，是不是大佬的 acm-terminal.el 没有做 lsp-bridge/acm.el at fc7384d2850ad580fc32ecb490333fb4438cc099 · manateelazycat/lsp-bridge · GitHub 这个操作呀？

twlz0ne · 2022 年11 月 7 日 07:36

是我疏于对上游代码的跟踪了。

那就改为在 python 中过滤。

manateelazycat · 2022 年11 月 7 日 07:40

大佬，有空还是把 acm-terminal.el 合并入 lsp-bridge 分支呀，我改啥API的时候就一起帮你改了，两个人干活搭把手。

twlz0ne · 2022 年11 月 7 日 07:41

好吧。我这几天看看。

manateelazycat · 2022 年11 月 7 日 07:43

大佬辛苦啦，大家都很期待 acm-terminal.el, 我水平不够，一直没有把 overlay frame 搞定。

twlz0ne · 2022 年11 月 7 日 07:48

折煞我也，担不起大佬这个称呼。

twlz0ne · 2022 年11 月 7 日 08:03

@manateelazycat @Young-people 过滤(在Python端)补丁已经 PR Filter lsp completion if isIncomplete is False by twlz0ne · Pull Request #401 · manateelazycat/lsp-bridge · GitHub 暂采用 fuzzy match。

那几个乱标 isIncomplete 的，要不要给他们提 issue？

smallzhan · 2022 年11 月 7 日 09:54

我感觉老王喊人“大佬”就跟其他人喊“兄弟”一个意思。

manateelazycat · 2022 年11 月 7 日 10:26

哈哈哈，兄弟好。

manateelazycat · 2022 年11 月 7 日 16:45

代码已经合并，感谢大佬给力补丁。