Use nim track for goto definition and find usages

.github/workflows/ci.yml

@@ -21,7 +21,7 @@ jobs:
       - name: Setup Nimble
         uses: nim-lang/setup-nimble-action@v1
         with:
-          nimble-version: "0.20.1"
+          nimble-version: "latest"
           repo-token: ${{ secrets.GITHUB_TOKEN }}
 
       - name: Restore nimble dependencies from cache
@@ -35,6 +35,10 @@ jobs:
           restore-keys: |
             ${{ runner.os }}-${{ env.cache_nonce }}-
 
+      - name: Install Nimble fork with the nim#head fix
+        shell: bash
+        run: nimble install https://github.com/moigagoo/nimble@#bugfix/nimble_dump_with_nim_head
+
       - name: Install dependencies
         shell: bash
         run: nimble -y install -l

ls.nim

@@ -96,6 +96,7 @@ type
     nimExpandMacro*: Option[bool]
     maxNimsuggestProcesses*: Option[int]
       #max number of nimsuggest processes to keep alive. zero means unlimited
+    useNimTrack*: Option[bool]
 
   NlsFileInfo* = ref object of RootObj
     projectFile*: Future[string]
@@ -271,14 +272,28 @@ proc supportSignatureHelp*(cc: LspClientCapabilities): bool =
   caps.isSome and caps.get.signatureHelp.isSome
 
 proc getNimbleDumpInfo*(
-    ls: LanguageServer, nimbleFile: string
+    ls: LanguageServer, nimbleFile: string, workingDir = ""
 ): Future[NimbleDumpInfo] {.async.} =
   if nimbleFile in ls.nimDumpCache:
     return ls.nimDumpCache.getOrDefault(nimbleFile)
+  # `nimble dump` resolves the project's Nim (`nimDir`) relative to the process
+  # working directory. When a project pins a local Nim (e.g. `nim#head` in
+  # `nimbledeps`), running `nimble dump` from the wrong directory reports the
+  # global Nim instead. Run it in the project directory so the project-local Nim
+  # is picked up. Fall back to the nimble file's directory when no working dir
+  # is supplied.
+  let dumpDir =
+    if workingDir != "":
+      workingDir
+    elif nimbleFile != "":
+      nimbleFile.parentDir
+    else:
+      getCurrentDir()
   var process: AsyncProcessRef
   try:
     process = await startProcess(
       "nimble",
+      workingDir = dumpDir,
       arguments = @["dump", nimbleFile],
       options = {UsePath},
       stderrHandle = AsyncProcess.Pipe,
@@ -508,10 +523,15 @@ proc getNimVersion(nimDir: string): string =
 proc getNimSuggestPathAndVersion(
     ls: LanguageServer, conf: NlsConfig, workingDir: string
 ): Future[(string, string)] {.async.} =
-  #Attempting to see if the project is using a custom Nim version, if it's the case this will be slower than usual
-  let nimbleDumpInfo = await ls.getNimbleDumpInfo("")
-  let nimDir = nimbleDumpInfo.nimDir.get ""
+  let nimbleFiles = walkFiles(workingDir / "*.nimble").toSeq
+
+  let nimbleDumpInfo =
+    if nimbleFiles.len > 0:
+      await ls.getNimbleDumpInfo(nimbleFiles[0], workingDir)
+    else:
+      await ls.getNimbleDumpInfo("", workingDir)
 
+  let nimDir = nimbleDumpInfo.nimDir.get ""
   var nimsuggestPath = expandTilde(conf.nimsuggestPath.get(""))
   var nimVersion = ""
   if nimsuggestPath == "":
@@ -527,11 +547,19 @@ proc getNimSuggestPathAndVersion(
   debug "Using {nimVersion}", nimVersion = nimVersion
   (nimsuggestPath, nimVersion)
 
-proc getNimPath*(conf: NlsConfig): Option[string] =
+proc getNimPath*(
+    ls: LanguageServer, conf: NlsConfig, workingDir = ""
+): Future[Option[string]] {.async.} =
   if conf.nimSuggestPath.isSome and conf.nimsuggestPath.get().fileExists():
     some(conf.nimSuggestPath.get.parentDir / "nim")
   else:
-    let path = findExe "nim"
+    let (nimsuggestPath, _) = await ls.getNimSuggestPathAndVersion(conf, workingDir)
+    let path =
+      if nimsuggestPath.fileExists():
+        nimsuggestPath.parentDir / "nim"
+      else:
+        findExe "nim"
+
     if path != "":
       some(path)
     else:
@@ -597,7 +625,7 @@ proc getRootPath*(ip: LspInitializeParams): string =
 proc getRootPath*(ip: McpInitializeParams): string =
   getCurrentDir().pathToUri.uriToPath
 
-proc getWorkingDir(ls: LanguageServer, path: string): Future[string] {.async.} =
+proc getWorkingDir*(ls: LanguageServer, path: string): Future[string] {.async.} =
   let rootPath =
     case ls.serverMode
     of lsp: ls.lspInitializeParams.getRootPath
@@ -607,7 +635,7 @@ proc getWorkingDir(ls: LanguageServer, path: string): Future[string] {.async.} =
     pathRelativeToRoot = path.tryRelativeTo(rootPath)
     mapping = ls.getWorkspaceConfiguration.await().workingDirectoryMapping.get(@[])
 
-  result = getCurrentDir()
+  result = rootPath
 
   for m in mapping:
     if pathRelativeToRoot.isSome and m.projectFile == pathRelativeToRoot.get():
@@ -945,7 +973,7 @@ proc checkProject*(ls: LanguageServer, uri: string): Future[void] {.async.} =
   let conf = await ls.getAndWaitForWorkspaceConfiguration()
   let useNimCheck = conf.useNimCheck.get(USE_NIM_CHECK_BY_DEFAULT)
 
-  let nimPath = getNimPath(conf)
+  let nimPath = await ls.getNimPath(conf)
 
   if useNimCheck and nimPath.isSome:
     proc getFilePath(c: CheckResult): string =
@@ -1258,7 +1286,7 @@ proc getProjectFile*(fileUri: string, ls: LanguageServer): Future[string] {.asyn
 proc checkFile*(ls: LanguageServer, uri: string): Future[void] {.async.} =
   let conf = await ls.getAndWaitForWorkspaceConfiguration()
   let useNimCheck = conf.useNimCheck.get(USE_NIM_CHECK_BY_DEFAULT)
-  let nimPath = conf.getNimPath()
+  let nimPath = await ls.getNimPath(conf)
   let token = fmt "Checking file {uri}"
   ls.workDoneProgressCreate(token)
   ls.progress(token, "begin", fmt "Checking {uri.uriToPath}")

nimlangserver.nimble

@@ -16,9 +16,9 @@ requires "nim == 2.0.8",
   "."
 
 task test, "run tests":
-  --silent
   --run
-  setCommand "c", "tests/all.nim"
+  --silent
+  setCommand("c", "tests/all.nim")
 
 task book, "Generate book":
   exec "mdbook build book -d ../docs"

routes/lsp.nim

@@ -14,7 +14,7 @@ import
     stew/byteutils,
     with,
   ],
-  ../[testrunner, nimexpand, asyncprocmonitor, suggestapi, ls, utils],
+  ../[testrunner, nimexpand, asyncprocmonitor, suggestapi, trackapi, ls, utils],
   ../protocol/[enums, types]
 
 import macros except error
@@ -157,6 +157,34 @@ proc definition*(
 ): Future[seq[Location]] {.async.} =
   with (params.position, params.textDocument):
     asyncSpawn ls.addProjectFileToPendingRequest(id.uint, uri)
+    let config = await ls.getWorkspaceConfiguration()
+    # `nim track` only works on files as saved on disk; it has no dirty-buffer
+    # support. Use it only when the file is open and has no unsaved changes,
+    # otherwise fall back to nimsuggest (which supports dirty buffers).
+    if config.useNimTrack.get(false) and uri in ls.openFiles and
+        not ls.openFiles[uri].changed:
+      let ch = ls.getCharacter(uri, line, character)
+      if ch.isNone:
+        return @[]
+      let projectFile = await ls.openFiles[uri].projectFile
+      let timeout = config.timeout.get(REQUEST_TIMEOUT)
+      let workingDir = await ls.getWorkingDir(projectFile)
+      let nimPath = await ls.getNimPath(config, workingDir)
+      if nimPath.isNone:
+        return @[]
+      result = (
+        await track(
+          projectFile,
+          uriToPath(uri),
+          line + 1,
+          ch.get,
+          tmDef,
+          nimPath = nimPath.get,
+          workingDir = workingDir,
+          timeout = timeout,
+        )
+      ).map(x => x.toUtf16Pos(ls).toLocation)
+      return
     let ns = await ls.tryGetNimsuggest(uri)
     if ns.isNone:
       return @[]
@@ -410,14 +438,14 @@ proc hover*(
           content.value.add &"```nim\n{expanded[0].doc}\n```"
         else:
           # debug "Couldnt expand the macro. Trying with nim expand", suggest = suggest[]
-          let nimPath = config.getNimPath()
+          let nimPath = await ls.getNimPath(config)
           if nimPath.isSome:
             let expanded = await nimExpandMacro(nimPath.get, suggest, uriToPath(uri))
             content.value.add &"```nim\n{expanded}\n```"
       if suggest.section == ideDef and suggest.symkind in ["skProc"] and
           config.nimExpandArc.get(NIM_EXPAND_ARC_BY_DEFAULT):
         debug "#Expanding arc", suggest = suggest[]
-        let nimPath = config.getNimPath()
+        let nimPath = await ls.getNimPath(config)
         if nimPath.isSome:
           let expanded = await nimExpandArc(nimPath.get, suggest, uriToPath(uri))
           let arcContent = "#Expanded arc \n" & expanded
@@ -432,6 +460,36 @@ proc references*(
     ls: LanguageServer, params: ReferenceParams
 ): Future[seq[Location]] {.async.} =
   with (params.position, params.textDocument, params.context):
+    let config = await ls.getWorkspaceConfiguration()
+    # `nim track` only works on files as saved on disk; it has no dirty-buffer
+    # support. Use it only when the file is open and has no unsaved changes,
+    # otherwise fall back to nimsuggest (which supports dirty buffers).
+    if config.useNimTrack.get(false) and uri in ls.openFiles and
+        not ls.openFiles[uri].changed:
+      let ch = ls.getCharacter(uri, line, character)
+      if ch.isNone:
+        return @[]
+      let projectFile = await ls.openFiles[uri].projectFile
+      let mode = if includeDeclaration: tmDefUsages else: tmUsages
+      let timeout = config.timeout.get(REQUEST_TIMEOUT)
+      let workingDir = await ls.getWorkingDir(projectFile)
+      let nimPath = await ls.getNimPath(config, workingDir)
+      if nimPath.isNone:
+        return @[]
+      let refs = await track(
+        projectFile,
+        uriToPath(uri),
+        line + 1,
+        ch.get,
+        mode,
+        nimPath = nimPath.get,
+        workingDir = workingDir,
+        timeout = timeout,
+      )
+      result = refs
+        .filter(suggest => suggest.section != ideDef or includeDeclaration)
+        .map(x => x.toUtf16Pos(ls).toLocation)
+      return
     let nimsuggest = await ls.tryGetNimsuggest(uri)
     if nimsuggest.isNone:
       return @[]
@@ -854,27 +912,27 @@ proc listTests*(
     ls: LanguageServer, params: ListTestsParams
 ): Future[ListTestsResult] {.async.} =
   let config = await ls.getWorkspaceConfiguration()
-  let nimPath = config.getNimPath()
+  let workspaceRoot = ls.lspInitializeParams.getRootPath
+  let nimPath = await ls.getNimPath(config, workspaceRoot)
   if nimPath.isNone:
     error "Nim path not found when listing tests"
     return ListTestsResult(
       projectInfo: TestProjectInfo(
         entryPoint: params.entryPoint, suites: initTable[string, TestSuiteInfo]()
       )
     )
-  let workspaceRoot = ls.lspInitializeParams.getRootPath
   let testProjectInfo = await listTests(params.entryPoint, nimPath.get(), workspaceRoot)
   result.projectInfo = testProjectInfo
 
 proc runTests*(
     ls: LanguageServer, params: RunTestParams
 ): Future[RunTestProjectResult] {.async.} =
   let config = await ls.getWorkspaceConfiguration()
-  let nimPath = config.getNimPath()
+  let workspaceRoot = ls.lspInitializeParams.getRootPath
+  let nimPath = await ls.getNimPath(config, workspaceRoot)
   if nimPath.isNone:
     error "Nim path not found when running tests"
     return RunTestProjectResult()
-  let workspaceRoot = ls.lspInitializeParams.getRootPath
   await runTests(
     params.entryPoint,
     nimPath.get(),