Route aware tools (#115)

* code lens in ReScript files detailing how many routes the file is referenced in

* changeset

* support custom LSP command for returning routes for a file

* fix wording

* fix error in code lens path order

.changeset/quick-rings-shake.md

@@ -0,0 +1,5 @@
+---
+"rescript-relay-router": patch
+---
+
+LSP: Code lens in ReScript files detailing how many routes the file is referenced in.

.changeset/silver-lemons-cry.md

@@ -0,0 +1,5 @@
+---
+"rescript-relay-router": patch
+---
+
+LSP: Support custom LSP command for returning routes for a file.

packages/rescript-relay-router/cli/RescriptRelayRouterCli__Bindings.res

@@ -12,6 +12,9 @@ module Chokidar = {
     @send
     external onUnlink: (t, @as(json`"unlink"`) _, string => unit) => t = "on"
 
+    @send
+    external onAdd: (t, @as(json`"add"`) _, string => unit) => t = "on"
+
     @send
     external close: t => Promise.t<unit> = "close"
   }
@@ -38,6 +41,12 @@ module Path = {
 
   @module("path")
   external extname: string => string = "extname"
+
+  @live
+  type parsed = {name: string}
+
+  @module("path")
+  external parse: string => parsed = "parse"
 }
 
 module Node = {
@@ -115,6 +124,33 @@ module Fs = {
   }
 }
 
+module ChildProcess = {
+  module Spawn = {
+    type stdout
+    type stderr
+    @live
+    type t = {stdout: stdout, stderr: stderr}
+
+    @live
+    type opts = {
+      shell?: bool,
+      cwd?: string,
+      stdio?: [#inherit | #pipe],
+    }
+
+    type buffer
+    @send external bufferToString: buffer => string = "toString"
+
+    @module("child_process")
+    external make: (string, array<string>, opts) => t = "spawn"
+
+    @send external onStdoutData: (stdout, @as(json`"data"`) _, buffer => unit) => unit = "on"
+    @send external onClose: (t, @as(json`"close"`) _, int => unit) => unit = "on"
+
+    let onData = (t, cb) => t.stdout->onStdoutData(buffer => buffer->bufferToString->cb)
+  }
+}
+
 module URL = {
   type t
 
@@ -169,3 +205,5 @@ module LinesAndColumns = {
   @send
   external offsetForLocation: (t, loc) => int = "indexForLocation"
 }
+
+@val @module("os") external osEOL: string = "EOL"

packages/rescript-relay-router/cli/RescriptRelayRouterCli__Bindings.resi

@@ -11,6 +11,9 @@ module Chokidar: {
     @send
     external onUnlink: (t, @as(json`"unlink"`) _, string => unit) => t = "on"
 
+    @send
+    external onAdd: (t, @as(json`"add"`) _, string => unit) => t = "on"
+
     @send
     external close: t => Js.Promise.t<unit> = "close"
   }
@@ -36,6 +39,11 @@ module Path: {
 
   @module("path")
   external extname: string => string = "extname"
+
+  type parsed = {name: string}
+
+  @module("path")
+  external parse: string => parsed = "parse"
 }
 
 module Node: {
@@ -88,6 +96,26 @@ module Fs: {
   let writeFileIfChanged: (string, string) => unit
 }
 
+module ChildProcess: {
+  module Spawn: {
+    type t
+
+    @live
+    type opts = {
+      shell?: bool,
+      cwd?: string,
+      stdio?: [#inherit | #pipe],
+    }
+
+    @module("child_process")
+    external make: (string, array<string>, opts) => t = "spawn"
+
+    @send external onClose: (t, @as(json`"close"`) _, int => unit) => unit = "on"
+
+    let onData: (t, string => unit) => unit
+  }
+}
+
 module URL: {
   type t
 
@@ -139,3 +167,5 @@ module LinesAndColumns: {
   @send
   external offsetForLocation: (t, loc) => int = "indexForLocation"
 }
+
+@val @module("os") external osEOL: string = "EOL"

packages/rescript-relay-router/cli/RescriptRelayRouterCli__Commands.res

@@ -299,7 +299,7 @@ let init = () => {
   Console.log("[init] Done! You can now run the `generate -scaffold-renderers` command.")
 }
 
-type cliResult = Done | Watcher({watcher: Chokidar.Watcher.t})
+type cliResult = Done | Watcher({watchers: array<Chokidar.Watcher.t>})
 
 let runCli = args => {
   switch args->List.fromArray {
@@ -379,7 +379,7 @@ let runCli = args => {
           ->Watcher.onUnlink(_ => {
             generateRoutesSafe()
           })
-        Watcher({watcher: theWatcher})
+        Watcher({watchers: [theWatcher]})
       } else {
         Done
       }
@@ -400,8 +400,8 @@ let runCli = args => {
     } else {
       NodeRpc
     }
-    let watcher = Lsp.start(~config, ~mode)
-    Watcher({watcher: watcher})
+    let watchers = Lsp.start(~config, ~mode)
+    Watcher({watchers: watchers})
   | _ =>
     Console.log("Unknown command. Use -help or -h to see all available commands.")
     Done

packages/rescript-relay-router/cli/RescriptRelayRouterCli__Parser.res

@@ -528,8 +528,6 @@ module Path = {
   }
 }
 
-let f = Belt.Array.concatMany
-
 module Validators = {
   open! JsoncParser
 

packages/rescript-relay-router/cli/RescriptRelayRouterCli__Types.res

@@ -93,7 +93,8 @@ module RoutePath: {
   }
 
   let getPathSegment = t => t.pathSegment
-  let getFullRoutePath = t => "/" ++ t.currentRoutePath->List.toArray->Array.joinWith("/")
+  let getFullRoutePath = t =>
+    "/" ++ t.currentRoutePath->List.toArray->Array.reverse->Array.joinWith("/")
 
   let toPattern = t =>
     "/" ++
@@ -207,4 +208,15 @@ type rec routeForCliMatching = {
 type config = {
   generatedPath: string,
   routesFolderPath: string,
+  rescriptLibFolderPath: string,
+}
+
+type dependencyDeclaration = {
+  dependsOn: Set.t<string>,
+  dependents: Set.t<string>,
+}
+
+type moduleDepsCache = {
+  mutable cache: Dict.t<dependencyDeclaration>,
+  mutable compilerLastRebuilt: float,
 }

packages/rescript-relay-router/cli/RescriptRelayRouterCli__Utils.res

@@ -34,6 +34,10 @@ module Config: {
           ->Option.getWithDefault(Path.join([routesFolderPath, "__generated__"]))
           ->resolveFullPath,
           routesFolderPath,
+          // TODO: This won't work for monorepo setups etc where the ReScript
+          // lib dir isn't at the same level as the router config file. Fix
+          // eventually.
+          rescriptLibFolderPath: Path.join([Path.dirname(filepath), "lib", "bs"]),
         }
       }
 
@@ -294,3 +298,10 @@ let queryParamToQueryParamDecoder = (param, ~key) => {
       )}),\n`
   }
 }
+
+let maybePluralize = (text, ~count) =>
+  text ++ if count == 1 {
+    ""
+  } else {
+    "s"
+  }