Support textDocument/prepareRename & textDocument/documentHighlight, improve accuracy of reference finding

CHANGELOG.md

@@ -6,6 +6,16 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
 
 ## [Unreleased]
 
+### Added
+
+- Added support for the prepare rename request
+- Added support for document highlighting
+
+### Fixed
+
+- Fixed property references in assignments not being found (i.e. `bar` in `foo.bar = baz` wouldn't be recognized as a reference to `foo.bar`)
+- Fixed references to required files in types prefixes not being accurate with variable shadowing or separate scopes
+
 ## [1.32.4] - 2024-09-11
 
 ### Changed

CMakeLists.txt

@@ -48,6 +48,7 @@ target_sources(Luau.LanguageServer PRIVATE
         src/platform/roblox/RobloxStudioPlugin.cpp
         src/operations/Diagnostics.cpp
         src/operations/Completion.cpp
+        src/operations/DocumentHighlight.cpp
         src/operations/DocumentSymbol.cpp
         src/operations/DocumentLink.cpp
         src/operations/ColorProvider.cpp
@@ -83,6 +84,8 @@ target_sources(Luau.LanguageServer.Test PRIVATE
         tests/SemanticTokens.test.cpp
         tests/Sourcemap.test.cpp
         tests/References.test.cpp
+        tests/DocumentHighlight.test.cpp
+        tests/PrepareRename.test.cpp
         tests/Rename.test.cpp
         tests/ColorProvider.test.cpp
         tests/LuauExt.test.cpp

README.md

@@ -69,6 +69,7 @@ Install the binary and run `luau-lsp --help` for more information.
 - [x] Go To Definition
 - [x] Go To Type Definition
 - [x] Find References
+- [x] Document Highlight
 - [x] Document Link
 - [x] Document Symbol
 - [x] Color Provider
@@ -87,7 +88,6 @@ They can be investigated at a later time:
 - [ ] Go To Declaration (do not apply)
 - [ ] Go To Implementation (do not apply)
 - [ ] Code Lens (not necessary)
-- [ ] Document Highlight (not necessary - editor highlighting is sufficient)
 - [ ] Selection Range (not necessary - editor selection is sufficient)
 - [ ] Inline Value (applies for debuggers only)
 - [ ] Moniker

src/LanguageServer.cpp

@@ -73,6 +73,8 @@ lsp::ServerCapabilities LanguageServer::getServerCapabilities()
     capabilities.implementationProvider = false; // TODO: does this apply to Luau?
     // Find References Provider
     capabilities.referencesProvider = true;
+    // Document Highlight Provider
+    capabilities.documentHighlightProvider = true;
     // Document Symbol Provider
     capabilities.documentSymbolProvider = true;
     // Color Provider
@@ -82,7 +84,7 @@ lsp::ServerCapabilities LanguageServer::getServerCapabilities()
     // Code Action Provider
     capabilities.codeActionProvider = {std::vector<lsp::CodeActionKind>{lsp::CodeActionKind::SourceOrganizeImports}, /* resolveProvider: */ false};
     // Rename Provider
-    capabilities.renameProvider = true;
+    capabilities.renameProvider = {true};
     // Folding Range Provider
     capabilities.foldingRangeProvider = true;
     // Inlay Hint Provider
@@ -160,6 +162,14 @@ void LanguageServer::onRequest(const id_type& id, const std::string& method, std
     {
         response = rename(JSON_REQUIRED_PARAMS(baseParams, "textDocument/rename"));
     }
+    else if (method == "textDocument/prepareRename")
+    {
+        response = prepareRename(JSON_REQUIRED_PARAMS(baseParams, "textDocument/prepareRename"));
+    }
+    else if (method == "textDocument/documentHighlight")
+    {
+        response = documentHighlight(JSON_REQUIRED_PARAMS(baseParams, "textDocument/documentHighlight"));
+    }
     else if (method == "textDocument/documentSymbol")
     {
         response = documentSymbol(JSON_REQUIRED_PARAMS(baseParams, "textDocument/documentSymbol"));