Added new language server options and functionality. #3161
Conversation
Added new extended diagnostic code information to the language server. -- It must be enabled via a command line switch. Added telemetry data for language server initialization and operation. Added verbose log messages for language server. -- It must be enabled via a command line switch.
| * @var int | ||
| * @readonly | ||
| */ | ||
| public $shortcode; |
There was a problem hiding this comment.
Added this so it can be used to send the error code to the client.
|
|
||
| * @return Promise<void> | ||
| */ | ||
| public function logMessage(string $message, int $type = 4, string $method = 'window/logMessage'): Promise |
There was a problem hiding this comment.
This method allows us to send notifications with the LogMessageParams type as the params for the message. The method is customizable, because we use this same method to send telemetry data using the telemetry/event method which can use anything for its params.
| @@ -200,16 +202,25 @@ public function initialize( | |||
| return call( | |||
| /** @return \Generator<int, true, mixed, InitializeResult> */ | |||
| function () use ($capabilities, $rootPath, $processId) { | |||
| $this->verboseLog("Initializing..."); | |||
| $this->clientStatus('initializing'); | |||
There was a problem hiding this comment.
These client statuses should be known strings, so the client can use them and provide UI updates as needed, such as status appropriate icons, or extended status messages.
| $diagnostic->code = [ | ||
| "value" => $code, | ||
| "target" => $issue_data->link, | ||
| ]; |
There was a problem hiding this comment.
here we send the detailed diagnostic code with the help link.
There was a problem hiding this comment.
@muglug here is where it uses the short code to sent to the client. Right now it pads it to 3 chars and prepends 'PS' to it so a code of 22 would be 'PS022'. We can make it be anything you like, even making the code sent to the client be the link; we would just set the link to both "value" and "target". We need to send the extended code structure instead of just a string in order to make it clickable in the IDE.
| echo 'Psalm ' . PSALM_VERSION . PHP_EOL; | ||
| exit; | ||
| } | ||
|
|
There was a problem hiding this comment.
moved this up to allow for an early exit since they just want the version. There is no need to check other stuff before this.
|
I have a PR for the vscode extension that uses these updates so you can see how they would be used. |
|
Oh, it looks like I forgot to update the tests ... I will get that fixed up. |
|
Thanks! Any reason you need the short code? Won’t the |
|
@muglug, yes vscode (and other IDEs) need the error code to associate with the error. Most of the tim and IDE (vscode does this) requires an error code to attach the link to in the UI. Here is an example of what it looks like in VSCode (I had to redact some areas of the UI because they are for my work):
The part in the parenthesis is the code, and is also the link. |
|
The failing test with |
|
@muglug, also if you prefer, we can just make the error code sent to the client be the link, so like in that screenshot it would look more like so: |
|
Hmm, the CircleCI tests didn't actually show any tests that failed (some were skipped), but it says it failed 🤔 |
It was killed while generating code coverage report, possibly by OOM killer:
|
That sounds preferable – at some point the protocol will support links directly, but until then... |
|
@muglug ok, I will get that changed to be the link for both the value and the link. The protocol will support links directly in LSP 3.16.0 which is what I am implementing here. That is how it is going to be structured in the 3.16.0 specification 😉 . |
| @@ -383,7 +383,8 @@ function (IssueData $issue_data) use ($file_path) : Diagnostic { | |||
| 'Psalm' | |||
| ); | |||
|
|
|||
| $code = 'PS' . \str_pad((string) $issue_data->shortcode, 3, "0", \STR_PAD_LEFT); | |||
| //$code = 'PS' . \str_pad((string) $issue_data->shortcode, 3, "0", \STR_PAD_LEFT); | |||
| $code = $issue_data->link; | |||
There was a problem hiding this comment.
@muglug Ok, the code now sent is the help link instead of the formatted short code.
|
Thanks, these are wonderful additions! |
Added new extended diagnostic code information to the language server.
-- It must be enabled via a command line switch.
Added telemetry data for language server initialization and operation.
Added verbose log messages for language server.
-- It must be enabled via a command line switch.
I will comment on the code changes directly in the diff.