Add collect_file_renames addon hook for rename requests#3958
Open
sucicfilip wants to merge 1 commit intoShopify:mainfrom
Open
Add collect_file_renames addon hook for rename requests#3958sucicfilip wants to merge 1 commit intoShopify:mainfrom
sucicfilip wants to merge 1 commit intoShopify:mainfrom
Conversation
sucicfilip
force-pushed
the
feature/rename-addon-hook
branch
from
0494d3a to
deae3bc
Compare
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Motivation
This adds an addon hook so that add-ons can participate in file renames during
textDocument/rename.Right now,
collect_file_renamesonly renames files that exactly match the constant's snake_case name (e.g. Foo → foo.rb). This doesn't cover cases where file naming conventions include prefixes or other patterns. For example, Rails migration files like20241030120000_create_users.rb.Closes Shopify/ruby-lsp-rails#497 (the ruby-lsp-rails side will follow in a separate PR)
Implementation
collect_file_renames(fully_qualified_name, new_name, document_changes)to the Addon classInterface::RenameFileentries intodocument_changesAutomated Tests
No tests added here since the hook is a no-op by default. The ruby-lsp-rails PR will have tests covering the actual behavior.
Manual Tests
-