Hack to fix finding runtime module in analysis/tools

Author: cknitt

analysis/src/BuildSystem.ml

@@ -6,18 +6,21 @@ let namespacedName namespace name =
 let ( /+ ) = Filename.concat
 
 let getRuntimeDir rootPath =
-  let result =
-    ModuleResolution.resolveNodeModulePath ~startPath:rootPath
-      "@rescript/runtime"
-  in
-  match result with
-  | Some path -> Some path
-  | None ->
-    let message = "@rescript/runtime could not be found" in
-    Log.log message;
-    None
+  match !Cfg.isDocGenFromCompiler with
+  | false -> (
+    let result =
+      ModuleResolution.resolveNodeModulePath ~startPath:rootPath
+        "@rescript/runtime"
+    in
+    match result with
+    | Some path -> Some path
+    | None ->
+      let message = "@rescript/runtime could not be found" in
+      Log.log message;
+      None)
+  | true -> Some rootPath
 
-let getLibBs root = Files.ifExists (root /+ "lib" /+ "bs")
+let getLibBs path = Files.ifExists (path /+ "lib" /+ "bs")
 
 let getStdlib base =
   match getRuntimeDir base with

analysis/src/FindFiles.ml

@@ -142,7 +142,7 @@ let findProjectFiles ~public ~namespace ~path ~sourceDirectories ~libBs =
   in
   let files =
     dirs |> StringSet.elements
-    |> List.map (fun name -> Files.collect ~maxDepth:1 name isSourceFile)
+    |> List.map (fun name -> Files.collect ~maxDepth:2 name isSourceFile)
     |> List.concat |> StringSet.of_list
   in
   dirs

analysis/src/ModuleResolution.ml

@@ -1,14 +1,18 @@
 let ( /+ ) = Filename.concat
 
 let rec resolveNodeModulePath ~startPath name =
-  let scope = Filename.dirname name in
-  let name = Filename.basename name in
-  let name =
-    match scope.[0] with
-    | '@' -> scope /+ name
-    | _ -> name
-  in
-  let path = startPath /+ "node_modules" /+ name in
-  if Files.exists path then Some path
-  else if Filename.dirname startPath = startPath then None
-  else resolveNodeModulePath ~startPath:(Filename.dirname startPath) name
+  if name = "@rescript/runtime" then
+    (* Hack: we need a reliable way to resolve modules in monorepos. *)
+    Some Config.runtime_module_path
+  else
+    let scope = Filename.dirname name in
+    let name = Filename.basename name in
+    let name =
+      match scope.[0] with
+      | '@' -> scope /+ name
+      | _ -> name
+    in
+    let path = startPath /+ "node_modules" /+ name in
+    if Files.exists path then Some path
+    else if Filename.dirname startPath = startPath then None
+    else resolveNodeModulePath ~startPath:(Filename.dirname startPath) name

compiler/ext/config.ml

@@ -1,6 +1,6 @@
 (* This resolves the location of the standard library starting from the location of bsc.exe
    (@rescript/{platform}/bin/bsc.exe), handling different supported package layouts. *)
-let standard_library =
+let runtime_module_path =
   let build_path rest path =
     String.concat Filename.dir_sep (List.rev_append rest path)
   in
@@ -15,21 +15,25 @@ let standard_library =
   *)
   | "bin" :: _platform :: "@rescript" :: "node_modules" :: _package :: ".pnpm"
     :: "node_modules" :: rest ->
-    build_path rest ["node_modules"; "@rescript"; "runtime"; "lib"; "ocaml"]
+    build_path rest ["node_modules"; "@rescript"; "runtime"]
   (* 2. Packages installed via npm
      - bin:    node_modules/@rescript/{platform}/bin
      - stdlib: node_modules/@rescript/runtime/lib/ocaml
   *)
   | "bin" :: _platform :: "@rescript" :: "node_modules" :: rest ->
-    build_path rest ["node_modules"; "@rescript"; "runtime"; "lib"; "ocaml"]
+    build_path rest ["node_modules"; "@rescript"; "runtime"]
   (* 3. Several other cases that can occur in local development, e.g.
      - bin:    <repo>/packages/@rescript/{platform}/bin, <repo>/_build/install/default/bin
      - stdlib: <repo>/packages/@rescript/runtime/lib/ocaml
   *)
   | _ :: _ :: _ :: _ :: rest ->
-    build_path rest ["packages"; "@rescript"; "runtime"; "lib"; "ocaml"]
+    build_path rest ["packages"; "@rescript"; "runtime"]
   | _ -> ""
 
+let standard_library =
+  let ( // ) = Filename.concat in
+  runtime_module_path // "lib" // "ocaml"
+
 let cmi_magic_number = "Caml1999I022"
 
 and ast_impl_magic_number = "Caml1999M022"

compiler/ext/config.mli

@@ -15,11 +15,14 @@
 
 (* System configuration *)
 
+(* The directory containing the runtime module (@rescript/runtime) *)
+val runtime_module_path : string
+
+(* The directory containing the runtime artifacts (@rescript/runtime/lib/ocaml) *)
 val standard_library : string
-(* The directory containing the standard libraries *)
 
-val load_path : string list ref
 (* Directories in the search path for .cmi and .cmo files *)
+val load_path : string list ref
 
 val cmi_magic_number : string