Skip to content

[5.7] Migrate to upstream inlay hints#570

Merged
ahoppen merged 1 commit intoswiftlang:release/5.7from
fwcd:5.7-upstream-inlay-hints
Jun 22, 2022
Merged

[5.7] Migrate to upstream inlay hints#570
ahoppen merged 1 commit intoswiftlang:release/5.7from
fwcd:5.7-upstream-inlay-hints

Conversation

@fwcd
Copy link
Copy Markdown
Member

@fwcd fwcd commented Jun 14, 2022 •
edited by ahoppen
Loading

  • Explanation: Inlay hints have been upstreamed to the Language Server Protocol and this PR migrates SourceKit-LSP's custom request to the standard LSP request. Besides being more widely supported, standard inlay hints have the advantage of being very customizable, e.g. VSCode can be configured to only show the hints while a certain keybinding is held.
  • Scope: Only affects clients that send inlay hint requests, in particular SourceKit-LSP's non-standard requests.
  • Risk: Clients using the previous non-standard inlay hints will no longer be able to show these, the standard LSP hints should be preferable in any case though and are being supported by recent versions of vscode-languageclient already.
  • Testing: Experimentation with recent versions of VSCode and vscode-swift (see Migrate to upstream LSP inlay hints on the client side vscode-swift#198)
  • Issue: rdar://95141875
  • Reviewer: @ahoppen on Migrate to upstream LSP inlay hints request #465

@fwcd
Migrate to upstream LSP inlay hints
550ce9b 
- Use official textDocument/inlayHint request
- Rename InlayHintCategory to InlayHintKind
- Additionally, represent it using an Int, as in the proposed LSP API.
- Add inlay hint client capabilities
- Add inlay hint server capabilities
- Add dynamic registration of inlay hint request
- Rename InlayHintsRequest -> InlayHintRequest
  This is to be consistent with the request itself being named in singular
  in LSP and the other requests (e.g. DocumentSymbolRequest).
- Forward inlay hint requests to clangd
- Add colon before inlay hints
- Add other properties to InlayHint
- Add InlayHintLabel structures
- Conform InlayHintLabel to ExpressibleByStringX protocols
- Attach TextEdit to inlay hints for committing them
- Add InlayHint.data
- Fix InlayHintTests
  We need to include text edits in the expected inlay hints.
@fwcd fwcd requested review from ahoppen and benlangmuir as code owners June 14, 2022 13:32
@ahoppen ahoppen requested a review from airspeedswift June 14, 2022 20:58
@ahoppen
Copy link
Copy Markdown
Member

ahoppen commented Jun 14, 2022

@swift-ci Please test

@ahoppen ahoppen merged commit 4e05e56 into swiftlang:release/5.7 Jun 22, 2022
@fwcd fwcd deleted the 5.7-upstream-inlay-hints branch June 27, 2022 13:11
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@ahoppen ahoppen ahoppen approved these changes

@airspeedswift airspeedswift airspeedswift approved these changes

@benlangmuir benlangmuir Awaiting requested review from benlangmuir

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@fwcd @ahoppen @airspeedswift
⚡