Publish RuboCop::LSP.enable to enable LSP mode
#12679
Merged
Conversation
This file contains 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
`RuboCop::Cop::Base.enable_lsp_mode` will be renamed to `RuboCop::LSP.enable`. Before: ```ruby RuboCop::Cop::Base.enable_lsp_mode ``` After: ```ruby RuboCop::LSP.enable ``` This is because whether or not it is LSP should not be set per cop but should be a state controlled for the entire RuboCop process. Since `RuboCop::Cop::Base.enable_lsp_mode` was an experimental private API, it will be renamed without a deprecation warning. Along with this, the module name has been changed from `RuboCop::Lsp` to `RuboCop::LSP`. This change is made to align with Ruby's standard API, like `RubyVM::YJIT.enable`, making it `RuboCop::LSP.enable` instead. `RuboCop::Lsp.enable` does not look as pretty name. With the renaming to `RuboCop::LSP.enable`, the usage of this API will be documented. This allows libraries like Ruby LSP and Solargraph, which use internal modules other than RuboCop's built-in `RuboCop::LSP::Server#start`, to easily utilize the features in rubocop#12586 and rubocop#12657.
koic
force-pushed
the
publish_lsp_enable_api
branch
from
40d53cf
to
4bea30a
Compare
|
Good change! |
8 tasks
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
RuboCop::Cop::Base.enable_lsp_modewill be renamed toRuboCop::LSP.enable.Before:
After:
This is because whether or not it is LSP should not be set per cop but should be a state controlled for the entire RuboCop process.
Since
RuboCop::Cop::Base.enable_lsp_modewas an experimental private API, it will be renamed without a deprecation warning.Along with this, the module name has been changed from
RuboCop::LsptoRuboCop::LSP. This change is made to align with Ruby's standard API, likeRubyVM::YJIT.enable, making itRuboCop::LSP.enableinstead.RuboCop::Lsp.enabledoes not look as pretty name.With the renaming to
RuboCop::LSP.enable, the usage of this API will be documented. This allows libraries like Ruby LSP and Solargraph, which use internal modules other than RuboCop's built-inRuboCop::LSP::Server#start, to easily utilize the features in #12586 and #12657.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.