Add signature help LSP request support

[a7medev]

Depends on swiftlang/swift#83378

---

Adds support for the LSP signature help request.

Note

As of swiftlang/swift#83378, SourceKitD still doesn't separate parameter documentation from the signature documentation and thus parameters don't have their own separate documentation. This should just work once SourceKitD implements this functionality and we'll only need to modify the tests.

[ahoppen]

Very nice 🌟. If you have a screen recording showing the signature help in real life, I would be very keen to see that.

PR looks great to me, I just have a few nitpicky comments.

[a7medev]

Here's a quick demo of signature help in VS Code.

output.mp4

There are some things to improve though:

1. Automatically triggering signature help after accepting a function or subscript completion item. We should ideally do that in vscode-swift by injecting the editor.action.triggerParameterHints command in completion items using a middleware. I plan on opening a PR for it once we get the basic implementation done.
2. Persisting the active signature chosen by the user across re-triggers.

[a7medev]

I've opened a PR on vscode-swift (swiftlang/vscode-swift#1802) to automatically trigger signature help on accepting a function-like completion item in VS Code.

[ahoppen]

Oh, that behavior is interesting. The LSP specification says the following. Does this mean that VS Code does not comply with the LSP spec in this regard?

If omitted or the value lies outside the range of signatures[activeSignature].parameters defaults to 0 if the active signature has parameters

I’m fine keeping this in but we should mention the intended behavior from the LSP spec in the comment and mention that we are deliberately relying on a VS Code LSP-non-compliance if that’s what we’re doing.

[a7medev]

Yes, that's VS Code-specific behavior which we use as a workaround here. For editors that are fully LSP-compliant this will have the same behavior as if we didn't return a value and we actually don't have a way of expressing "no active parameter" in that case so it's fine. I actually found rust-analyzer using this trick too.

There are also other VS Code-specific workarounds like setting the active parameter to -1 (microsoft/vscode#145851 (comment)).

I'll update the comment to explain this part too.

[ahoppen]

The screen recording looks great 🤩

One thought that just crossed my mind to extract the documentation for the parameters: SourceKit-LSP does link against docc, so we should be able to use docc to parse the doc comment into a symbol graph and then extract the parameters from there. In general, getting docc into the loop here might be open up new possibilities such as #2256. If you want to tackle this, I would make that a separate PR though.

[a7medev]

@ahoppen Thanks for the suggestion, I'll look into it more as I'm not familiar with DocC.

I've updated the comments you mentioned as well, can you please recheck? 🙏🏼

[ahoppen]

Looks good to me. Thanks for adding the explanation.

[a7medev]

@ahoppen I rebased the PR on main as it had some conflicts (due to moving default implementations from DocumentationLanguageService to LanguageService in #2261).

[ahoppen]

Thanks for rebasing and sorry for causing the conflict.

[ahoppen]

swiftlang/swift#83378

@swift-ci Please test

[ahoppen]

swiftlang/swift#8337

@swift-ci Please test Windows

[a7medev]

@ahoppen I've implemented preserving the user's selected active signature in 02caee7, can you please review this part as well? 🙏🏼

Sorry for modifying this after the review.

[ahoppen]

Looks good to me, just two nitpicks.

[a7medev]

@ahoppen Updated. Can you please recheck? 🙏🏼
FYI, swiftlang/swift#83378 has been merged.

[ahoppen]

LGTM. Let’s ship this 🚀

[ahoppen]

@swift-ci Please test

[ahoppen]

@swift-ci Please test Windows

[a7medev]

@ahoppen @hamishknight Tests are failing on Windows with errors similar to the following:

<EXPR>:0: error: SwiftSignatureHelpTests.testSignatureHelpEnumCase : threw error "ResponseError(code: LanguageServerProtocol.ErrorCode(rawValue: -32001), message: "No language service implements textDocument/signatureHelp", data: nil)"

Any idea why that is happening? Shouldn't these tests run fine on Windows?

[bnbarham]

Any idea why that is happening? Shouldn't these tests run fine on Windows?

I haven't checked the logs, but I see new files with no update to CMakeLists.txt, so my guess would be that is the cause. You'll want to update Sources/SwiftLanguageService/CMakeLists.txt with the new files

[a7medev]

@bnbarham Interesting. I didn't notice that I needed to add that since it was working fine on my machine. Do we primarily use this CMakeLists.txt file on Windows? 👀

I've added them now. Can you please rerun the tests? 🙏🏼

[bnbarham]

Do we primarily use this CMakeLists.txt file on Windows?

Yep :(

[bnbarham]

@swift-ci please test

[ahoppen]

@swift-ci Please test Windows

[hamishknight]

🚢

[bnbarham]

Could we add a SkipUnless similar to your completion PR, to make sure that the tests pass when we have an older sourcekitd 🙏?

[a7medev]

@bnbarham Makes sense. I've opened #2284 to add that change.