support LSP TextDocumentSyncKind.Incremental #14431
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
tmtm
force-pushed
the
support-TextDocumentSyncKind.Incremental
branch
from
1beee8c to
067216e
Compare
koic
reviewed
Aug 11, 2025
| @@ -0,0 +1 @@ | |||
| * Support LSP TextDocumentSyncKind.Incremental. ([@tmtm][]) | |||
Member
There was a problem hiding this comment.
Can you update this changelog entry to the following and squash your commits into one?
Suggested change
| * Support LSP TextDocumentSyncKind.Incremental. ([@tmtm][]) | |
| * [#14431](https://github.com/rubocop/rubocop/pull/14431): Support LSP `TextDocumentSyncKind.Incremental`. ([@tmtm][]) |
tmtm
force-pushed
the
support-TextDocumentSyncKind.Incremental
branch
2 times, most recently
from
d9145f3 to
e188292
Compare
Member
|
Please don't split the changes into separate commits for the new change entry. Can you squash them into a single commit? |
tmtm
force-pushed
the
support-TextDocumentSyncKind.Incremental
branch
from
e188292 to
37b7d8c
Compare
tmtm
force-pushed
the
support-TextDocumentSyncKind.Incremental
branch
from
37b7d8c to
620921b
Compare
Member
|
Thank you. Let's proceed with this. |
Member
|
@tmtm Unfortunately, this change is insufficient and, for example, the following situation causes problems.
# frozen_string_literal: true
RSpec.describe RuboCop::Cop::Style::Dir, :config do
context 'when using `#expand_path` and `#dirname`' do
it 'registers an offense' do
expect_offense(<<~RUBY)
File.expand_path(File.dirname(__FILE__))
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Use `__dir__` to get an absolute path to the current file's directory.
RUBY
expect_correction(<<~RUBY)
__dir__
RUBY
end
+ byebug
it 'registers an offense with ::File' do
expect_offense(<<~RUBY)
::File.expand_path(::File.dirname(__FILE__))
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Use `__dir__` to get an absolute path to the current file's directory.
RUBY
expect_correction(<<~RUBY)
__dir__
RUBY
end
end
# frozen_string_literal: true
RSpec.describe RuboCop::Cop::Style::Dir, :config do
context 'when using `#expand_path` and `#dirname`' do
it 'registers an offense' do
expect_offense(<<~RUBY)
File.expand_path(File.dirname(__FILE__))
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Use `__dir__` to get an absolute path to the current file's directory.
RUBY
expect_correction(<<~RUBY)
__dir__
RUBY
end
+ byebug
+
+ it ug 'registers an offense with ::File' do
expect_offense(<<~RUBY)
::File.expand_path(::File.dirname(__FILE__))
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Use `__dir__` to get an absolute path to the current file's directory.
RUBY
expect_correction(<<~RUBY)
__dir__
RUBY
end
endIs there a plan to fix this bug promptly? |
Contributor
Author
|
@koic I’m not sure what the cause is. I couldn’t reproduce it in my environment. 😢 |
Contributor
Author
|
Ah, I understood! When making quick edits at multiple positions in Emacs, |
Contributor
Author
|
@koic However, I won’t have time to fix it immediately, so please revert it. |
koic
added a commit
to koic/rubocop
that referenced
this pull request
Aug 13, 2025
…on the LSP Follow-up to rubocop#14431 (comment) This PR fixes an unexpect diagnostic with `TextDocumentSyncKind.Incremental` on the LSP when multiple `contentChanges`. Since rubocop#14431 changed `TextDocumentSyncKind` from `Full` to `Incremental`, it is necessary to handle the possibility that `params[:contentChanges]` may contain multiple entries.
8 tasks
Member
koic
added a commit
to koic/rubocop
that referenced
this pull request
Aug 13, 2025
…on the LSP Follow-up to rubocop#14431 (comment) This PR fixes an unexpect diagnostic with `TextDocumentSyncKind.Incremental` on the LSP when multiple `contentChanges`. Since rubocop#14431 changed `TextDocumentSyncKind` from `Full` to `Incremental`, it is necessary to handle the possibility that `params[:contentChanges]` may contain multiple entries. Ref: https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification/#textDocument_synchronization
koic
added a commit
to koic/rubocop
that referenced
this pull request
Aug 13, 2025
…on the LSP Follow-up to rubocop#14431 (comment) This PR fixes an unexpect diagnostic with `TextDocumentSyncKind.Incremental` on the LSP when `contentChanges` contains multiple entries. Since rubocop#14431 changed `TextDocumentSyncKind` from `Full` to `Incremental`, it is necessary to handle the possibility that `params[:contentChanges]` may contain multiple entries. Ref: https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification/#textDocument_synchronization
bbatsov
pushed a commit
that referenced
this pull request
Aug 14, 2025
…on the LSP Follow-up to #14431 (comment) This PR fixes an unexpect diagnostic with `TextDocumentSyncKind.Incremental` on the LSP when `contentChanges` contains multiple entries. Since #14431 changed `TextDocumentSyncKind` from `Full` to `Incremental`, it is necessary to handle the possibility that `params[:contentChanges]` may contain multiple entries. Ref: https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification/#textDocument_synchronization
8 tasks
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Implemented support for TextDocumentSyncKind.Incremental in LSP, so that only text diffs are sent when changes are made in the editor.
Before submitting the PR make sure the following are checked:
[Fix #issue-number](if the related issue exists).master(if not - rebase it).bundle exec rake default. It executes all tests and runs RuboCop on its own code.{change_type}_{change_description}.mdif the new code introduces user-observable changes. See changelog entry format for details.