refactor to clarify the structure

Author: saem

nim.cfg

@@ -2,6 +2,8 @@
 --outdir:out
 --sourceMap
 
+--path:"src/"
+
 define:nimsuggest
 define:nodejs
 define:js

src/nimvscode/nimBuild.nim renamed to src/nimBuild.nim

@@ -1,18 +1,14 @@
-import vscodeApi
-import nimSuggestExec
-import nimUtils
-import jsNode
-import jsNodeCp
-import jsffi
-import jsPromise
-import jsNodeOs
-import jsString
-import jsre
-import jsconsole
-import sequtils
+## does the work to build whatever file the user is asking for or running a
+## nim check and handling the diagnostics.
+
+import platform/vscodeApi
+import platform/js/[jsNodeCp, jsNodeOs, jsString, jsre]
+import std/[jsconsole, sequtils]
+from std/strformat import fmt
+import nimSuggestExec, nimUtils
 from nimProjects import getProjects, isProjectMode, getProjectFileInfo,
                         ProjectFileInfo, toLocalFile
-from nimBinTools import getNimExecPath
+from tools/nimBinTools import getNimExecPath
 
 type
   CheckStacktrace* = ref object
@@ -48,6 +44,9 @@ proc nimExec(
     ) =
     var execPath = getNimExecPath()
     if execPath.isNil() or execPath.strip() == "":
+      vscode.window.showInformationMessage(
+        "Binary named 'nim' not found in PATH environment variable"
+      )
       resolve(@[])
       return
 
@@ -66,7 +65,7 @@ proc nimExec(
       }
 
     var executor = cp.spawn(
-            getNimExecPath(),
+            execPath,
             @[cmd] & args,
             SpawnOptions{cwd: project.wsFolder.uri.fsPath}
       )
@@ -297,6 +296,11 @@ proc execSelectionInTerminal*(#[ doc:VscodeTextDocument ]#) {.async.} =
         return
 
       var execPath = getNimExecPath(executable)
+      if execPath.isNil() or execPath.strip() == "":
+        vscode.window.showInformationMessage(
+          fmt"Binary named '{executable}' not found in PATH environment variable"
+        )
+        return
       evalTerminal = vscode.window.createTerminal("Nim Console")
       evalTerminal.show(preserveFocus = true)
       # previously was a setTimeout 3s, perhaps a valid pid works better

src/nimvscode/nimDeclaration.nim renamed to src/nimDeclaration.nim

@@ -1,6 +1,7 @@
-import vscodeApi
+## maps nimsuggest to vscode definition provider, this allows goto definition
+
+import platform/vscodeApi
 import nimSuggestExec
-import jsNode
 
 proc provideDefinition*(
   doc: VscodeTextDocument,

src/nimvscode/nimFormatting.nim renamed to src/nimFormatting.nim

@@ -1,11 +1,14 @@
-import vscodeApi
-import nimUtils
-import jsNodeCp
-import jsNodeFs
-import jsconsole
-from strformat import fmt
+## this extension ain't pretty, but maybe your code might be? This works with
+## nim pretty to clean things up.
+
+import platform/vscodeApi
+import platform/js/[jsNodeCp, jsNodeFs]
 
-from nimBinTools import getNimPrettyExecPath
+import std/jsconsole
+from std/strformat import fmt
+
+import nimUtils
+from tools/nimBinTools import getNimPrettyExecPath
 
 var extensionContext*: VscodeExtensionContext
 

src/nimvscode/nimHover.nim renamed to src/nimHover.nim

@@ -1,4 +1,7 @@
-import vscodeApi
+## maps nimsuggest to vscode hover providing, which in turn shows hovers or
+## tooltips, with the signature or docs for various symbols
+
+import platform/vscodeApi
 import nimSuggestExec
 import nimMode
 

src/nimvscode/nimImports.nim renamed to src/nimImports.nim

@@ -1,15 +1,11 @@
-import vscodeApi
-import jsNodeCp
-import jsNodeFs
-import jsNodePath
-import jsPromise
-import jsString
-import jsre
-import jsconsole
-import jsffi
+## supports auto-completion of module imports... this feels a bit janky
+
+import platform/vscodeApi
+import platform/js/[jsNodeCp, jsNodeFs, jsNodePath, jsString, jsre]
+import std/jsconsole
 
 from nimProjects import getProjects, isProjectMode
-from nimBinTools import getNimExecPath, getNimbleExecPath
+from tools/nimBinTools import getNimExecPath, getNimbleExecPath
 
 type
   NimbleModuleInfo = ref object
@@ -31,8 +27,16 @@ proc getNimDirectories(projectDir: cstring, projectFile: cstring): Promise[seq[c
   return newPromise(proc(
         resolve: proc(v: seq[cstring]), reject: proc(reasons: JsObject)
     ) =
+    let execPath = getNimExecPath()
+    if execPath.isNil() or execPath.strip() == "":
+      vscode.window.showInformationMessage(
+        "Binary named 'nim' not found in PATH environment variable"
+      )
+      resolve(@[])
+      return
+
     discard cp.exec(
-      getNimExecPath() & " dump " & projectFile,
+      execPath & " dump " & projectFile,
       ExecOptions{cwd: projectDir},
       proc(err: ExecError, stdout: cstring, stderr: cstring): void =
         var res: seq[cstring] = @[]
@@ -77,8 +81,18 @@ proc walkDir(projectDir: cstring, rootDir: cstring, dir: cstring,
 proc initNimDirectories(projectDir: cstring, projectFile: cstring): Promise[void] =
   if nimModules[projectDir].toJs().to(bool):
     nimModules[projectDir] = @[]
+    let
+      execPath = getNimExecPath()
+      nimRoot = path.dirname(path.dirname(execPath))
+
+    # we check this after setting `nimRoot`, but it shouldn't matter
+    if execPath.isNil() or execPath.strip() == "":
+      vscode.window.showInformationMessage(
+        "Binary named 'nim' not found in PATH environment variable"
+      )
+      return
+
     getNimDirectories(projectDir, projectFile).then(proc(dirs: seq[cstring]) =
-      var nimRoot = path.dirname(path.dirname(getNimExecPath()))
       for dir in dirs:
         walkDir(projectDir, dir, dir, dir.startsWith(nimRoot))
     ).toJs().to(Promise[void])

src/nimvscode/nimIndexer.nim renamed to src/nimIndexer.nim

@@ -1,23 +1,16 @@
-import vscodeApi
-import jsffi
-import sequtils
+## this crawls the file system and indexes files and types so they're available
+## for search providers (document, symbol, and outline). It caches this
+## data inside our silly little flatfile database and reuses it between runs
+## timestamps are used for invalidating the cache.
 
-import nimStatus
-import nimSuggestExec
+import platform/vscodeApi
+import platform/js/[jsNodeFs, jsNodePath, jsString, jsre]
+import store/flatdbnode
 
-import flatdbnode
+import std/[jsconsole, sequtils, asyncjs]
+from std/jscore import Math, max
 
-import jsNode
-import jsNodeFs
-import jsNodePath
-import jsPromise
-import asyncjs
-import jsre
-import jsString
-
-import jsconsole
-
-from jscore import Math, max
+import nimStatus, nimSuggestExec
 
 let
   dbVersion: cint = 5

src/nimMode.nim

@@ -0,0 +1,10 @@
+## this correspondes to the language mode for nim, better syntax highlighting
+## support for nims, nimble, cfg, fitlers, etc... will require this list to
+## grow and we'll need to support defaults.
+
+import platform/vscodeApi
+
+var mode*: VscodeDocumentFilter = VscodeDocumentFilter{
+  language: "nim",
+  scheme: "file"
+}

src/nimvscode/nimOutline.nim renamed to src/nimOutline.nim

@@ -1,4 +1,7 @@
-import vscodeApi
+## provides a list of symbols and documents so vscode can use them for search
+## results when you do symbol or document search.
+
+import platform/vscodeApi
 import nimIndexer
 
 proc provideWorkspaceSymbols(

src/nimvscode/nimProjects.nim renamed to src/nimProjects.nim

@@ -1,12 +1,14 @@
 # modules handles the concept of nim projects. Projects are the project file
 # we pass to the compiler, nimsuggest, etc... 
 
-from vscodeApi import VscodeWorkspaceFolder, VscodeWorkspaceConfiguration,
-  vscode, getWorkspaceFolder, uriFile, asRelativePath, findFiles, get,
-  newWorkspaceFolderLike, VscodeUri, VscodeUriChange, with, getConfiguration,
-  VscodeConfigurationChangeEvent, affectsConfiguration
-import jsffi, jsPromise, jsString, jsNode, jsre
-from jsNodePath import path, isAbsolute, parse, ParsedPath, dirname
+from platform/vscodeApi import VscodeWorkspaceFolder,
+  VscodeWorkspaceConfiguration, vscode, getWorkspaceFolder, uriFile,
+  asRelativePath, findFiles, get, newWorkspaceFolderLike, VscodeUri,
+  VscodeUriChange, with, getConfiguration, VscodeConfigurationChangeEvent,
+  affectsConfiguration
+import std/jsffi
+import platform/js/[jsPromise, jsString, jsNode, jsre]
+from platform/js/jsNodePath import path, isAbsolute, parse, ParsedPath, dirname
 
 type
   ProjectFileInfo* = ref object