Add beta support for new features in LSP 3.18 by pisv · Pull Request #893 · eclipse-lsp4j/lsp4j

pisv · 2025-08-01T11:37:08Z

This PR complements #886 in adding beta support for those new features in LSP 3.18 that are available at the moment. The new API elements are annotated with @Draft and are subject to incompatible changes, including even removal, as long as they remain in the draft (beta) state.

Please note that there are some breaking API changes, which are documented in the change log as follows:

Type of TextDocumentEdit.edits changed from List<TextEdit> to List<Either<TextEdit, SnippetTextEdit>>
Type of Diagnostic.message changed from String to Either<String, MarkupContent>
Type of DocumentFilter.pattern changed from String to Either<String, RelativePattern>
Type of NotebookDocumentFilter.pattern changed from String to Either<String, RelativePattern>

jonahgraham

From my perspective, approved for 1.0.0 based on #873 (comment)

pisv · 2025-11-18T17:26:30Z

@jonahgraham Thanks for taking a look at this PR and approving it for 1.0.0 👍

Since this PR has become a bit stale and we still have some time left before the 1.0.0 release according to #871 (comment), I'll make sure to review the current state of the LSP 3.18 spec and update this PR if necessary.

Renames `InlineCompletionClientCapabilities` to `InlineCompletionCapabilities` to match existing naming conventions for property types in `TextDocumentClientCapabilities`.

Closes eclipse-lsp4j#810.

pisv · 2025-11-20T15:07:56Z

I have rebased this PR and would like to merge it in its current state, if there are no objections.

Looking at the LSP spec repo history, I cannot see any changes that would affect this PR. The only relevant change is this commit, which adds some optional properties to DiagnosticClientCapabilities in both LSP 3.17 and 3.18. Therefore, I plan to address this change in a separate PR.

pisv · 2025-11-20T15:17:05Z

I don't quite understand what is happening here: https://github.com/eclipse-lsp4j/lsp4j/actions/workflows/junit.yml, but it does not seem related to this PR, so I think we are good to go.

jonahgraham · 2025-11-20T15:32:23Z

I was trying to get junit publishing working - I got it working on my fork (e.g. jonahgraham#1 (comment) for a PR and https://github.com/jonahgraham/lsp4j/runs/55447887659 for main) but I need to update permissions on eclipse-lsp4j (in otterdog I think) - but I didn't come back to it yet. Sorry for the noise - I will create an issue soon if I don't resolve it.

jonahgraham · 2025-11-20T15:33:32Z

I can review if needed, but I hope someone in the LSP space (perhaps @sebthom who 🚀 the OP originally) can review it for content? If no one available, @pisv merge at your convenience.

pisv · 2025-11-20T16:38:09Z

I'd like to merge it now to avoid repeated rebasing 17 commits. There have been no comments for several months since this PR was created, but if anyone would be interested in reviewing it now, please let me know ASAP.

sebthom · 2025-11-20T17:12:26Z

I have no objections.

pisv · 2025-11-20T19:07:17Z

Merging it now to allow interested parties to test the changes before they are released in 1.0.0. If any problems are found, please create separate issues for them.

pisv · 2025-11-20T19:13:52Z

@jonahgraham As a potential follow-up to this PR, what do you think of renaming the @Draft annotation to @ProtocolDraft for the sake of consistency with @ProtocolDeprecated and in case we need the @Draft annotation for our own API in the future?

jonahgraham · 2025-11-23T17:09:35Z

@jonahgraham As a potential follow-up to this PR, what do you think of renaming the @Draft annotation to @ProtocolDraft for the sake of consistency with @ProtocolDeprecated and in case we need the @Draft annotation for our own API in the future?

xref: This was done in #928 - thanks @pisv

jonahgraham · 2025-11-24T14:53:25Z

@pisv I overlooked this earlier, but can you add changelog + readme entries for this at your convenience, similar to what I asked for in this other PR #856 (review)

pisv · 2025-11-24T15:19:48Z

@jonahgraham Sure! I don't know why I thought we were doing this just before releasing as part of the other release activities... Probably because I'm mostly contributing to Eclipse Theia these days, and they update their changelog in this way (except for breaking API changes, which should be part of each PR that introduces such changes). Anyway, let me do it just after #856 is merged to avoid conflicts.

jonahgraham · 2025-11-24T16:16:03Z

FWIW, this PR does include breaking API changes:

Binary incompatible: https://download.eclipse.org/lsp4j/builds/main/japicmp-report/org.eclipse.lsp4j.html#org.eclipse.lsp4j.Diagnostic
Source incompatible: https://download.eclipse.org/lsp4j/builds/main/japicmp-report/org.eclipse.lsp4j.html#org.eclipse.lsp4j.TextDocumentEdit

I don't know if it is worth explicitly listing them in the changelog too??

One of the potential limitations of japicmp (perhaps only how we are using it)

I don't know why I thought we were doing this just before releasing as part

It is also part of the releasing steps - but I would prefer to have them updated as we go so that I don't miss them and so that people consuming snapshots can get the most current info at a glance.

Anyway, let me do it just after #856 is merged to avoid conflicts.

+1

pisv · 2025-11-24T16:34:10Z

FWIW, this PR does include breaking API changes:
I don't know if it is worth explicitly listing them in the changelog too??

Yes, this has already been addressed (as part of this PR):

lsp4j/CHANGELOG.md

Lines 20 to 24 in b5a8adf

    
           * Added beta support for new features in LSP 3.18 [#893](https://github.com/eclipse-lsp4j/lsp4j/pull/893) 
        
              * Type of `TextDocumentEdit.edits` changed from `List<TextEdit>` to `List<Either<TextEdit, SnippetTextEdit>>` 
        
              * Type of `Diagnostic.message` changed from `String` to `Either<String, MarkupContent>` 
        
              * Type of `DocumentFilter.pattern` changed from `String` to `Either<String, RelativePattern>` 
        
              * Type of `NotebookDocumentFilter.pattern` changed from `String` to `Either<String, RelativePattern>`

It is also part of the releasing steps - but I would prefer to have them updated as we go so that I don't miss them and so that people consuming snapshots can get the most current info at a glance.

I see. Makes total sense. Thanks!

jonahgraham · 2025-11-24T16:41:20Z

Yes, this has already been addressed (as part of this PR):

Thanks for reminding me - I was too focussed on the top part of the Changelog that today I missed that you had done this part.

pisv · 2025-11-24T19:36:54Z

can you add changelog + readme entries for this

Done in #935.

pisv mentioned this pull request Nov 15, 2025

LSP4J 1.0.0 #871

Closed

37 tasks

jonahgraham mentioned this pull request Nov 18, 2025

Document API policy in regards to Semantic Versioning #873

Closed

jonahgraham approved these changes Nov 18, 2025

View reviewed changes

pisv added this to the 1.0.0 milestone Nov 18, 2025

jonahgraham mentioned this pull request Nov 19, 2025

Add support for SnippetTextEdit #847

Closed

jonahgraham linked an issue Nov 19, 2025 that may be closed by this pull request

Support for SnippetTextEdit #810

Closed

pisv added 17 commits November 20, 2025 17:45

Clean up doc comments related to LSP 3.18 support

0d5b40f

Rename InlineCompletionClientCapabilities

f00238c

Renames `InlineCompletionClientCapabilities` to `InlineCompletionCapabilities` to match existing naming conventions for property types in `TextDocumentClientCapabilities`.

Add beta support for SnippetTextEdit

f0b14f2

Closes eclipse-lsp4j#810.

Add beta support for markup content in diagnostic messages

42041d3

Add beta support for relative patterns in document filters

b520fc5

Add beta support for properties that can be resolved for code lenses

4d5261c

Add beta support for folding range refresh request

c09caf5

Add beta support for the 'label' semantic token type

53b67cd

Add beta support for CompletionList.applyKind

b65c9d3

Add beta support for code action kind documentation

935e7f8

Add beta support for new predefined code action kinds

cd917a3

Add beta support for code action tags

0d601ad

Add beta support for metadata information on workspace edits

015ee7f

Add beta support for debug message kind

73dc899

Add beta support for command tooltip

90c1e89

Add beta support for formatting multiple ranges at once

62f16f0

Add beta support for dynamic text document content

0824e18

pisv force-pushed the lsp-3.18-beta branch from b569a41 to 0824e18 Compare November 20, 2025 15:04

pisv mentioned this pull request Nov 20, 2025

Missing properties in client capabilities of diagnostic pull requests #925

Closed

pisv merged commit daeeb3a into eclipse-lsp4j:main Nov 20, 2025
6 checks passed

pisv deleted the lsp-3.18-beta branch November 20, 2025 19:08

jonahgraham mentioned this pull request Nov 24, 2025

Add symbol tags as proposed for LSP specification (e.g. visibility tags, static, abstract, etc.) #856

Merged

pisv mentioned this pull request Nov 24, 2025

Update CHANGELOG and README w.r.t. LSP 3.18 support #935

Merged

Conversation

pisv commented Aug 1, 2025

Uh oh!

jonahgraham left a comment

Choose a reason for hiding this comment

Uh oh!

pisv commented Nov 18, 2025

Uh oh!

pisv commented Nov 20, 2025

Uh oh!

pisv commented Nov 20, 2025

Uh oh!

jonahgraham commented Nov 20, 2025

Uh oh!

jonahgraham commented Nov 20, 2025

Uh oh!

pisv commented Nov 20, 2025

Uh oh!

sebthom commented Nov 20, 2025

Uh oh!

pisv commented Nov 20, 2025

Uh oh!

Uh oh!

pisv commented Nov 20, 2025

Uh oh!

jonahgraham commented Nov 23, 2025

Uh oh!

jonahgraham commented Nov 24, 2025

Uh oh!

pisv commented Nov 24, 2025

Uh oh!

jonahgraham commented Nov 24, 2025

Uh oh!

pisv commented Nov 24, 2025

Uh oh!

jonahgraham commented Nov 24, 2025

Uh oh!

pisv commented Nov 24, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants