5

我已经实现了一个提供一些 linting 的语言服务器。linter 检查所需的属性并发出“缺少属性”错误。我想为这些错误提供相应的“插入缺失属性”快速修复。

我认为 LSP 协议的一般领域是:

textDocument/codeAction

这样,服务器可以为“缺少属性”诊断标记返回“插入缺失属性”命令。

但是服务器如何实现“插入缺失的属性”命令本身呢?

查看 lsp 规范,我找不到任何让服务器注册命令的东西。

我确实在这里找到了一些关于用于在客户端注册命令的 vscode api 的信息:https ://code.visualstudio.com/docs/extensionAPI/vscode-api

所以我想我可以在客户端注册并实现“插入缺失的属性”,但是......

客户端只是将大部分工作委派给服务器的“愚蠢”包装器。因此,它并不真正了解文档结构,也不是实现需要了解该结构的文档转换的好地方。

似乎我最好的选择是向我的语言服务器添加一些“自定义”协议,以便我可以在客户端实现“插入缺少的属性”命令,但将计算快速修复编辑的困难部分委托给服务器.

或者,还有更好的方法?

4

1 回答 1

4

是的,有一种更好的方法不需要任何自定义协议扩展。大致是这些步骤:

首先确保您的 vscode 扩展package.json具有最新的语言服务器客户端。我的使用版本3.2.x。我还需要将 vscode 引擎版本更新为1.6.x. 这是一个示例 package.json

现在我们可以使用语言服务器协议的版本 3(在撰写本文时只是一个草稿,但已经可用)。这些是有趣的部分:

  • textDocument/codeAction:在服务器端实现它以计算代表快速修复的命令列表。

  • workspace/executeCommand:在服务器端实现这个来执行命令。它可以workspace/applyEdit用来向客户端发送请求以对工作区中的文档进行更改。

  • client/registerCapability:服务器可以用一个 ExecuteCommandRegistrationOptions对象来调用它。这会将您的服务器端命令注册到客户端,以便它知道通过workspace/executeCommand上一步中实现的处理程序来执行它们。

  • initialize:除了使用,您还可以通过返回具有适当属性设置的对象client/registerCapability来注册服务器端命令。这种方法稍微不那么复杂(但只能在不需要动态注册/注销命令的情况下使用)。WorkspaceCapabilitiesexecuteCommandProvider

另请参阅有关实施快速修复主题的vscode 问题单

重要提示:语言服务器客户端实现的 3.2.0 版本有一个错误,它使用了错误的名称client/registerFeature而不是,client/registerCapability因此您可能必须解决这个问题,直到该错误得到修复。如果您使用该initialize方法,那么您不会受到此错误的影响。

于 2017-04-17T21:45:43.480 回答