Add rename support

Author: JohnnyMorganz

CHANGELOG.md

@@ -13,6 +13,8 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
 - Can toggle whether non-script instances are included in the generated sourcemap (included by default).
 - Added support for "Find References"
   - Currently only works for finding all references of a local variable in the current document. Cross-file references will come in future.
+- Added support for "Rename"
+  - Currently only works for local variables in the current document. Cross-file references will come in future.
 
 ## [1.0.0] - 2022-05-19
 

src/Workspace.cpp

@@ -857,6 +857,54 @@ lsp::ReferenceResult WorkspaceFolder::references(const lsp::ReferenceParams& par
     return result;
 }
 
+lsp::RenameResult WorkspaceFolder::rename(const lsp::RenameParams& params)
+{
+    // Verify the new name is valid (is an identifier)
+    if (params.newName.length() == 0)
+        throw JsonRpcException(lsp::ErrorCode::RequestFailed, "The new name must be a valid identifier");
+    if (!isalpha(params.newName.at(0)) && params.newName.at(0) != '_')
+        throw JsonRpcException(lsp::ErrorCode::RequestFailed, "The new name must be a valid identifier starting with a character or underscore");
+    for (auto ch : params.newName)
+    {
+        if (!isalpha(ch) && !isdigit(ch) && ch != '_')
+            throw JsonRpcException(
+                lsp::ErrorCode::RequestFailed, "The new name must be a valid identifier composed of characters, digits, and underscores only");
+    }
+
+    // TODO: currently we only support renaming local bindings in the current file
+    auto moduleName = getModuleName(params.textDocument.uri);
+    auto position = convertPosition(params.position);
+
+    // Run the type checker to ensure we are up to date
+    // TODO: we only need the parse result here - can typechecking be skipped?
+    if (frontend.isDirty(moduleName))
+        frontend.check(moduleName);
+
+    auto sourceModule = frontend.getSourceModule(moduleName);
+    auto module = frontend.moduleResolver.getModule(moduleName);
+    if (!sourceModule || !module)
+        throw JsonRpcException(lsp::ErrorCode::RequestFailed, "Unable to read source code");
+
+    auto exprOrLocal = Luau::findExprOrLocalAtPosition(*sourceModule, position);
+    Luau::Symbol symbol;
+
+    if (exprOrLocal.getLocal())
+        symbol = exprOrLocal.getLocal();
+    else if (auto exprLocal = exprOrLocal.getExpr()->as<Luau::AstExprLocal>())
+        symbol = exprLocal->local;
+    else
+        throw JsonRpcException(lsp::ErrorCode::RequestFailed, "Rename is currently only supported for local variable bindings in the current file");
+
+    auto references = findSymbolReferences(*sourceModule, symbol);
+    std::vector<lsp::TextEdit> localChanges;
+    for (auto& location : references)
+    {
+        localChanges.emplace_back(lsp::TextEdit{{convertPosition(location.begin), convertPosition(location.end)}, params.newName});
+    }
+
+    return lsp::WorkspaceEdit{{{params.textDocument.uri.toString(), localChanges}}};
+}
+
 // std::optional<std::vector<lsp::DocumentSymbol>> WorkspaceFolder::documentSymbol(const lsp::DocumentSymbolParams& params)
 // {
 //     auto moduleName = getModuleName(params.textDocument.uri);

src/include/LSP/Protocol.hpp

@@ -288,12 +288,13 @@ struct ServerCapabilities
     bool referencesProvider = false;
     bool documentSymbolProvider = false;
     std::optional<DocumentLinkOptions> documentLinkProvider;
+    bool renameProvider = false;
     std::optional<DiagnosticOptions> diagnosticProvider;
     std::optional<WorkspaceCapabilities> workspace;
 };
 NLOHMANN_DEFINE_TYPE_NON_INTRUSIVE_WITH_DEFAULT(ServerCapabilities, textDocumentSync, completionProvider, hoverProvider, signatureHelpProvider,
     declarationProvider, definitionProvider, typeDefinitionProvider, implementationProvider, referencesProvider, documentSymbolProvider,
-    documentLinkProvider, diagnosticProvider, workspace);
+    documentLinkProvider, renameProvider, diagnosticProvider, workspace);
 
 struct InitializeResult
 {
@@ -832,6 +833,21 @@ struct DocumentSymbol
 };
 NLOHMANN_DEFINE_TYPE_NON_INTRUSIVE_WITH_DEFAULT(DocumentSymbol, name, detail, kind, tags, deprecated, range, selectionRange, children);
 
+struct WorkspaceEdit
+{
+    // TODO: this is optional and there are other options provided
+    std::unordered_map<std::string /* DocumentUri */, std::vector<TextEdit>> changes;
+};
+NLOHMANN_DEFINE_TYPE_NON_INTRUSIVE_WITH_DEFAULT(WorkspaceEdit, changes);
+
+struct RenameParams : TextDocumentPositionParams
+{
+    std::string newName;
+};
+NLOHMANN_DEFINE_TYPE_NON_INTRUSIVE_WITH_DEFAULT(RenameParams, textDocument, position, newName);
+
+using RenameResult = std::optional<WorkspaceEdit>;
+
 struct WorkspaceFoldersChangeEvent
 {
     std::vector<WorkspaceFolder> added;
@@ -845,13 +861,6 @@ struct DidChangeWorkspaceFoldersParams
 };
 NLOHMANN_DEFINE_TYPE_NON_INTRUSIVE_WITH_DEFAULT(DidChangeWorkspaceFoldersParams, event);
 
-struct WorkspaceEdit
-{
-    // TODO: this is optional and there are other options provided
-    std::unordered_map<std::string /* DocumentUri */, std::vector<TextEdit>> changes;
-};
-NLOHMANN_DEFINE_TYPE_NON_INTRUSIVE_WITH_DEFAULT(WorkspaceEdit, changes);
-
 struct ApplyWorkspaceEditParams
 {
     std::optional<std::string> label;

src/include/LSP/Workspace.hpp

@@ -68,6 +68,7 @@ class WorkspaceFolder
     std::optional<lsp::Location> gotoTypeDefinition(const lsp::TypeDefinitionParams& params);
 
     lsp::ReferenceResult references(const lsp::ReferenceParams& params);
+    lsp::RenameResult rename(const lsp::RenameParams& params);
 
     // std::optional<std::vector<lsp::DocumentSymbol>> documentSymbol(const lsp::DocumentSymbolParams& params);
 

src/main.cpp

@@ -103,6 +103,8 @@ class LanguageServer
         capabilities.documentSymbolProvider = false;
         // Document Link Provider
         capabilities.documentLinkProvider = {false};
+        // Rename Provider
+        capabilities.renameProvider = true;
         // Diagnostics Provider
         capabilities.diagnosticProvider = {"luau", /* interFileDependencies: */ true, /* workspaceDiagnostics: */ false};
         // Workspaces
@@ -157,6 +159,10 @@ class LanguageServer
         {
             return references(REQUIRED_PARAMS(params, "textDocument/references"));
         }
+        else if (method == "textDocument/rename")
+        {
+            return rename(REQUIRED_PARAMS(params, "textDocument/rename"));
+        }
         // else if (method == "textDocument/documentSymbol")
         // {
         //     return documentSymbol(REQUIRED_PARAMS(params, "textDocument/documentSymbol"));
@@ -555,6 +561,15 @@ class LanguageServer
     //     return nullptr;
     // }
 
+    Response rename(const lsp::RenameParams& params)
+    {
+        auto workspace = findWorkspace(params.textDocument.uri);
+        auto result = workspace->rename(params);
+        if (result)
+            return *result;
+        return nullptr;
+    }
+
     lsp::DocumentDiagnosticReport documentDiagnostic(const lsp::DocumentDiagnosticParams& params)
     {
         auto workspace = findWorkspace(params.textDocument.uri);