textDocument/rename implemented (#26)

* textDocument/rename implemented

* Only rename symbols inside the project

* Add test for prepareRename

Got tests passing

* Initial support for prepareRename

* Use rootUri sent by editor

Add --run into tests task

* Finish prepareRename support

nils are returned instead of errors since throwing exceptions would either cause the LSP client to get stuck
in a loop (When using rpc exceptions) or have massive message with stacktrace (if normal exceptions)

Author: ire4ever1190

README.md

@@ -61,6 +61,7 @@ nimble build
 - Document symbols
 - Find references
 - Workspace symbols
+- Rename symbols
 
 You can install `nimlangserver` using the instuctions for your text editor below:
 

nimlangserver.nim

@@ -124,7 +124,7 @@ proc getProjectFile(fileUri: string, ls: LanguageServer): Future[string] {.async
     rootPath = AbsoluteDir(ls.initializeParams.rootUri.uriToPath)
     pathRelativeToRoot = string(AbsoluteFile(fileUri).relativeTo(rootPath))
     mappings = ls.getWorkspaceConfiguration.await().projectMapping.get(@[])
-
+  
   for mapping in mappings:
     if find(cstring(pathRelativeToRoot), re(mapping.fileRegex), 0, pathRelativeToRoot.len) != -1:
       result = string(rootPath) / mapping.projectFile
@@ -162,30 +162,45 @@ proc initialize(ls: LanguageServer, params: InitializeParams):
     Future[InitializeResult] {.async.} =
   debug "Initialize received..."
   ls.initializeParams = params
-  return InitializeResult(
+  result = InitializeResult(
     capabilities: ServerCapabilities(
       textDocumentSync: some(%TextDocumentSyncOptions(
         openClose: some(true),
         change: some(TextDocumentSyncKind.Full.int),
         willSave: some(false),
         willSaveWaitUntil: some(false),
-        save: some(SaveOptions(includeText: some(true))))),
+        save: some(SaveOptions(includeText: some(true))))
+      ),
       hoverProvider: some(true),
       workspace: WorkspaceCapability(
-        workspaceFolders: some(WorkspaceFolderCapability())),
+        workspaceFolders: some(WorkspaceFolderCapability())
+      ),
       completionProvider: CompletionOptions(
         triggerCharacters: some(@["."]),
-        resolveProvider: some(false)),
+        resolveProvider: some(false)
+      ),
       definitionProvider: some(true),
       declarationProvider: some(true),
       typeDefinitionProvider: some(true),
       referencesProvider: some(true),
       documentHighlightProvider: some(true),
       workspaceSymbolProvider: some(true),
       executeCommandProvider: ExecuteCommandOptions(
-        commands: some(@[RESTART_COMMAND, RECOMPILE_COMMAND, CHECK_PROJECT_COMMAND])),
+        commands: some(@[RESTART_COMMAND, RECOMPILE_COMMAND, CHECK_PROJECT_COMMAND])
+      ),
       documentSymbolProvider: some(true),
-      codeActionProvider: some(true)))
+      codeActionProvider: some(true)
+    )
+  )
+  # Support rename by default, but check if we can also support prepare
+  result.capabilities.renameProvider = %true
+  if params.capabilities.textDocument.isSome:
+    let docCaps = params.capabilities.textDocument.unsafeGet()
+    # Check if the client support prepareRename
+    if docCaps.rename.isSome and docCaps.rename.get().prepareSupport.get(false):
+      result.capabilities.renameProvider = %* {
+        "prepareProvider": true
+      }
 
 proc initialized(ls: LanguageServer, _: JsonNode):
     Future[void] {.async.} =
@@ -692,6 +707,45 @@ proc references(ls: LanguageServer, params: ReferenceParams):
       .filter(suggest => suggest.section != ideDef or includeDeclaration)
       .map(toLocation);
 
+proc prepareRename(ls: LanguageServer, params: PrepareRenameParams,
+                   id: int): Future[JsonNode] {.async.} =
+  with (params.position, params.textDocument):
+    let
+      nimsuggest = await ls.getNimsuggest(uri)
+      def = await nimsuggest.def(
+        uriToPath(uri),
+        ls.uriToStash(uri),
+        line + 1,
+        ls.getCharacter(uri, line, character)
+      )
+    if def.len == 0:
+      return newJNull()
+    # Check if the symbol belongs to the project
+    let projectDir = ls.initializeParams.rootUri.uriToPath
+    if def[0].filePath.isRelativeTo(projectDir):
+      return %def[0].toLocation().range
+
+    return newJNull()
+
+proc rename(ls: LanguageServer, params: RenameParams, id: int): Future[WorkspaceEdit] {.async.} =
+  # We reuse the references command as to not duplicate it
+  let references = await ls.references(ReferenceParams(
+    context: ReferenceContext(includeDeclaration: true),
+    textDocument: params.textDocument,
+    position: params.position
+  ))
+  # Build up list of edits that the client needs to perform for each file
+  let projectDir = ls.initializeParams.rootUri.uriToPath
+  var edits = newJObject()
+  for reference in references:
+    # Only rename symbols in the project.
+    # If client supports prepareRename then an error will already have been thrown
+    if reference.uri.uriToPath().isRelativeTo(projectDir):
+      if reference.uri notin edits:
+        edits[reference.uri] = newJArray()
+      edits[reference.uri] &= %TextEdit(range: reference.range, newText: params.newName)
+  result = WorkspaceEdit(changes: some edits)
+
 proc codeAction(ls: LanguageServer, params: CodeActionParams):
     Future[seq[CodeAction]] {.async.} =
   let projectUri = await getProjectFile(params.textDocument.uri.uriToPath, ls)
@@ -849,6 +903,8 @@ proc registerHandlers*(connection: StreamConnection, pipeInput: AsyncInputStream
   connection.register("textDocument/hover", partial(hover, ls))
   connection.register("textDocument/references", partial(references, ls))
   connection.register("textDocument/codeAction", partial(codeAction, ls))
+  connection.register("textDocument/prepareRename", partial(prepareRename, ls))
+  connection.register("textDocument/rename", partial(rename, ls))
   connection.register("workspace/executeCommand", partial(executeCommand, ls))
   connection.register("workspace/symbol", partial(workspaceSymbol, ls))
   connection.register("textDocument/documentHighlight", partial(documentHighlight, ls))

nimlangserver.nimble

@@ -16,18 +16,7 @@ requires "nim >= 1.0.0",
 
 --path:"."
 
-proc configForTests() =
-  --hints: off
-  --debuginfo
-  --run
-  --threads:on
-  --silent
-  --define:"debugLogging=on"
-  --define:"chronicles_disable_thread_id"
-  --define:"async_backend=asyncdispatch"
-  --define:"chronicles_timestamps=None"
-  --define:"debugLogging"
-
 task test, "run tests":
-  configForTests()
+  --silent
+  --run
   setCommand "c", "tests/all.nim"

protocol/types.nim

@@ -223,6 +223,7 @@ type
 
   RenameCapability* = ref object of RootObj
     dynamicRegistration*: Option[bool]
+    prepareSupport*: Option[bool]
 
   PublishDiagnosticsCapability* = ref object of RootObj
     dynamicRegistration*: Option[bool]
@@ -315,6 +316,11 @@ type
   TextDocumentAndStaticRegistrationOptions* = ref object of TextDocumentRegistrationOptions
     id*: Option[string]
 
+  RenameOptions* = object
+    # We support rename, but need to change json
+    # depending on if the client supports prepare or not
+    supportsPrepare*: bool
+
   ServerCapabilities* = ref object of RootObj
     textDocumentSync*: OptionalNode # TextDocumentSyncOptions or int
     hoverProvider*: Option[bool]
@@ -333,7 +339,7 @@ type
     documentFormattingProvider*: Option[bool]
     documentRangeFormattingProvider*: Option[bool]
     documentOnTypeFormattingProvider*: DocumentOnTypeFormattingOptions
-    renameProvider*: Option[bool]
+    renameProvider*: JsonNode # bool or RenameOptions
     documentLinkProvider*: DocumentLinkOptions
     colorProvider*: OptionalNode # bool or ColorProviderOptions or TextDocumentAndStaticRegistrationOptions
     executeCommandProvider*: ExecuteCommandOptions
@@ -604,6 +610,13 @@ type
     position*: Position
     newName*: string
 
+  PrepareRenameParams* = ref object of RootObj
+    textDocument*: TextDocumentIdentifier
+    position*: Position
+
+  PrepareRenameResponse* = ref object of RootObj
+    defaultBehaviour*: bool
+
   SignatureHelpContext* = ref object of RootObj
     triggerKind*: int
     triggerCharacter*: Option[string]

tests/config.nims

@@ -0,0 +1,8 @@
+--hints: off
+--debuginfo
+--threads:on
+--define:"debugLogging=on"
+--define:"chronicles_disable_thread_id"
+--define:"async_backend=asyncdispatch"
+--define:"chronicles_timestamps=None"
+--define:"debugLogging"

tests/projects/hw/hw.nim

@@ -4,6 +4,11 @@ var bbb = 100
 bbb = 200
 bbb = ""
 
+import std/options
+var
+  x: Option[string]
+  y: Option[string]
+
 import std/macros
 
 macro myAssertMacroInner(arg: untyped): untyped =

tests/tnimlangserver.nim

@@ -148,26 +148,26 @@ suite "Suggest API selection":
   test "Suggest api":
     client.notify("textDocument/didOpen", %createDidOpenParams("projects/hw/hw.nim"))
     let (_, params) = suggestInit.read.waitFor
-    doAssert %params ==
+    check %params ==
       %ProgressParams(
         token: fmt "Creating nimsuggest for {uriToPath(helloWorldUri)}")
-    doAssert "begin" == progress.read.waitFor[1].value.get()["kind"].getStr
-    doAssert "end" == progress.read.waitFor[1].value.get()["kind"].getStr
+    check "begin" == progress.read.waitFor[1].value.get()["kind"].getStr
+    check "end" == progress.read.waitFor[1].value.get()["kind"].getStr
     client.notify("textDocument/didOpen",
                   %createDidOpenParams("projects/hw/useRoot.nim"))
     let
       rootNimFileUri = "projects/hw/root.nim".fixtureUri.uriToPath
       rootParams2 = suggestInit.read.waitFor[1]
 
-    doAssert %rootParams2 ==
+    check %rootParams2 ==
       %ProgressParams(token: fmt "Creating nimsuggest for {rootNimFileUri}")
 
-    doAssert "begin" == progress.read.waitFor[1].value.get()["kind"].getStr
-    doAssert "end" == progress.read.waitFor[1].value.get()["kind"].getStr
+    check "begin" == progress.read.waitFor[1].value.get()["kind"].getStr
+    check "end" == progress.read.waitFor[1].value.get()["kind"].getStr
     let
       hoverParams = positionParams("projects/hw/hw.nim".fixtureUri, 2, 0)
       hover = client.call("textDocument/hover", %hoverParams).waitFor
-    doAssert hover.kind == JNull
+    check hover.kind == JNull
 
 
 suite "LSP features":
@@ -237,7 +237,7 @@ suite "LSP features":
     let
       hoverParams = positionParams( helloWorldUri, 2, 0)
       hover = client.call("textDocument/hover", %hoverParams).waitFor
-    doAssert hover.kind == JNull
+    check hover.kind == JNull
 
   test "Definitions.":
     let
@@ -257,7 +257,7 @@ suite "LSP features":
           }
         }
       }]
-    doAssert %locations == %expected
+    check %locations == %expected
 
   test "References.":
     let referenceParams = ReferenceParams %* {
@@ -299,7 +299,7 @@ suite "LSP features":
         }
       }
     }]
-    doAssert %locations == %expected
+    check %locations == %expected
 
   test "References(exclude def)":
     let referenceParams =  ReferenceParams %* {
@@ -330,7 +330,41 @@ suite "LSP features":
         }
       }
     }]
-    doAssert %locations == %expected
+    check %locations == %expected
+
+  test "Prepare rename":
+    let renameParams = PrepareRenameParams(
+      textDocument: TextDocumentIdentifier(uri: helloWorldUri),
+      position: Position(line: 2, character: 6)
+    )
+    let resp = client.call("textDocument/prepareRename", %renameParams)
+                        .waitFor()
+    check resp == %* {
+        "start":{"line":2,"character":4},
+        "end":{"line":2,"character":7}
+    }
+
+
+  test "Prepare rename doesn't allow non-project symbols":
+    let renameParams = PrepareRenameParams(
+      textDocument: TextDocumentIdentifier(uri: helloWorldUri),
+      position: Position(line: 8, character: 10)
+    )
+    let resp = client.call("textDocument/prepareRename", %renameParams)
+                        .waitFor()
+    check resp.kind == JNull
+
+  test "Rename":
+    let renameParams = RenameParams(
+        textDocument: TextDocumentIdentifier(uri: helloWorldUri),
+        newName: "hello",
+        position: Position(line: 2, character: 6)
+    )
+    let changes = client.call("textDocument/rename", %renameParams)
+                        .waitFor().to(WorkSpaceEdit).changes.get()
+    check changes.len == 1
+    check changes[helloWorldUri].len == 3
+    check changes[helloWorldUri].mapIt(it["newText"].getStr()) == "hello".repeat(3)
 
   test "didChange then sending hover.":
     let didChangeParams = DidChangeTextDocumentParams %* {
@@ -360,6 +394,7 @@ suite "LSP features":
          "uri": fixtureUri("projects/hw/hw.nim")
        }
     }
+
     let actualEchoCompletionItem =
       to(waitFor client.call("textDocument/completion", %completionParams),
          seq[CompletionItem])
@@ -369,7 +404,7 @@ suite "LSP features":
     doAssert actualEchoCompletionItem.kind.get == 3
     doAssert actualEchoCompletionItem.detail.get().contains("proc")
     doAssert actualEchoCompletionItem.documentation.isSome
-
+    
   test "Shutdown":
     let
       nullValue = newJNull()
@@ -410,7 +445,12 @@ suite "Null configuration:":
       "processId": %getCurrentProcessId(),
       "rootUri": fixtureUri("projects/hw/"),
       "capabilities": {
-        "workspace": {"configuration": true}
+        "workspace": {"configuration": true},
+        "textDocument": {
+          "rename": {
+            "prepareSupport": true
+          }
+        }
       }
   }
 
@@ -530,4 +570,4 @@ suite "LSP expand":
   #          }},
   #        "content":"proc helloProc(): string =\n  result = \"Hello\"\n"
   #      }
-  #   doAssert %expected == %expandResult
+  #   doAssert %expected == %expandResult