bsc: add -runtime-path option

cknitt · cknitt · commit a0cd425ea760 · 2025-09-01T08:31:49.000+02:00
diff --git a/analysis/src/ModuleResolution.ml b/analysis/src/ModuleResolution.ml
@@ -3,7 +3,7 @@ let ( /+ ) = Filename.concat
 let rec resolveNodeModulePath ~startPath name =
   if name = "@rescript/runtime" then
     (* Hack: we need a reliable way to resolve modules in monorepos. *)
-    Some Runtime_package.path
+    Some !Runtime_package.path
   else
     let scope = Filename.dirname name in
     let name = Filename.basename name in
diff --git a/compiler/bsc/rescript_compiler_main.ml b/compiler/bsc/rescript_compiler_main.ml
@@ -50,6 +50,8 @@ let set_abs_input_name sourcefile =
   sourcefile
 let setup_outcome_printer () = Lazy.force Res_outcome_printer.setup
 
+let setup_runtime_path path = Runtime_package.path := path
+
 let process_file sourcefile ?kind ppf =
   (* This is a better default then "", it will be changed later
      The {!Location.input_name} relies on that we write the binary ast
@@ -402,6 +404,9 @@ let command_line_flags : (string * Bsc_args.spec * string) array =
       "<list>  Enable or disable error status for warnings according\n\
        to <list>.  See option -w for the syntax of <list>.\n\
        Default setting is " ^ Bsc_warnings.defaults_warn_error );
+    ( "-runtime-path",
+      string_call setup_runtime_path,
+      "*internal* Set the path of the runtime package (@rescript/runtime)" );
     ( "-make-runtime",
       unit_call Js_packages_state.make_runtime,
       "*internal* make runtime library" );
diff --git a/compiler/core/js_name_of_module_id.ml b/compiler/core/js_name_of_module_id.ml
@@ -1,5 +1,5 @@
 (* Copyright (C) 2017 Hongbo Zhang, Authors of ReScript
- * 
+ *
  * This program is free software: you can redistribute it and/or modify
  * it under the terms of the GNU Lesser General Public License as published by
  * the Free Software Foundation, either version 3 of the License, or
@@ -17,182 +17,182 @@
  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  * GNU Lesser General Public License for more details.
- * 
+ *
  * You should have received a copy of the GNU Lesser General Public License
  * along with this program; if not, write to the Free Software
  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. *)
 (*
-let (=)  (x : int) (y:float) = assert false 
+let (=)  (x : int) (y:float) = assert false
 *)
 
 #ifdef BROWSER
 
-let string_of_module_id_in_browser (x : Lam_module_ident.t) =  
+let string_of_module_id_in_browser (x : Lam_module_ident.t) =
   match x.kind with
   | External {name} -> name
-  | Runtime | Ml -> 
+  | Runtime | Ml ->
     "./stdlib/" ^ x.id.name ^ ".js"
 
-let string_of_module_id 
+let string_of_module_id
     (id : Lam_module_ident.t)
     ~output_dir:(_:string)
     (_module_system : Js_packages_info.module_system)
   = string_of_module_id_in_browser id
 
 #else
-  
-let (//) = Filename.concat 
+
+let (//) = Filename.concat
 
 
-let fix_path_for_windows : string -> string = 
+let fix_path_for_windows : string -> string =
   if Ext_sys.is_windows_or_cygwin then Ext_string.replace_backward_slash
-  else fun s -> s 
+  else fun s -> s
 
 
-(* dependency is runtime module *)  
-let get_runtime_module_path 
-    (dep_module_id : Lam_module_ident.t) 
+(* dependency is runtime module *)
+let get_runtime_module_path
+    (dep_module_id : Lam_module_ident.t)
     (current_package_info : Js_packages_info.t)
-    (module_system : Js_packages_info.module_system) = 
-  let current_info_query = 
+    (module_system : Js_packages_info.module_system) =
+  let current_info_query =
     Js_packages_info.query_package_infos current_package_info
       module_system  in
-  let js_file =  
-    Ext_namespace.js_name_of_modulename dep_module_id.id.name 
-      Upper Literals.suffix_js in 
-  match current_info_query with        
+  let js_file =
+    Ext_namespace.js_name_of_modulename dep_module_id.id.name
+      Upper Literals.suffix_js in
+  match current_info_query with
   | Package_not_found -> assert false
-  | Package_script -> 
-    Js_packages_info.runtime_package_path module_system js_file          
-  | Package_found pkg -> 
-    let  dep_path  = 
-      "lib" // Js_packages_info.runtime_dir_of_module_system module_system in 
-    if  Js_packages_info.is_runtime_package current_package_info then 
+  | Package_script ->
+    Js_packages_info.runtime_package_path module_system js_file
+  | Package_found pkg ->
+    let  dep_path  =
+      "lib" // Js_packages_info.runtime_dir_of_module_system module_system in
+    if  Js_packages_info.is_runtime_package current_package_info then
       Ext_path.node_rebase_file
         ~from:pkg.rel_path
-        ~to_:dep_path 
+        ~to_:dep_path
         js_file
         (* TODO: we assume that both [x] and [path] could only be relative path
             which is guaranteed by [-bs-package-output]
         *)
-    else  
-      match module_system with 
-      | Commonjs | Esmodule -> 
-        Js_packages_info.runtime_package_path module_system js_file              
+    else
+      match module_system with
+      | Commonjs | Esmodule ->
+        Js_packages_info.runtime_package_path module_system js_file
       (* Note we did a post-processing when working on Windows *)
-      | Es6_global 
-        -> 
-        (* lib/ocaml/xx.cmj --               
+      | Es6_global
+        ->
+        (* lib/ocaml/xx.cmj --
             HACKING: FIXME
             maybe we can caching relative package path calculation or employ package map *)
         (* assert false  *)
-        Ext_path.rel_normalized_absolute_path              
+        Ext_path.rel_normalized_absolute_path
           ~from:(
-            Js_packages_info.get_output_dir 
+            Js_packages_info.get_output_dir
               current_package_info
               ~package_dir:(Lazy.force Ext_path.package_dir)
               module_system )
-          (*Invariant: the package path to rescript, it is used to 
+          (*Invariant: the package path to rescript, it is used to
             calculate relative js path
           *)
-          (Runtime_package.path // dep_path // js_file)
+          (!Runtime_package.path // dep_path // js_file)
 
 (* [output_dir] is decided by the command line argument *)
-let string_of_module_id 
-    (dep_module_id : Lam_module_ident.t) 
+let string_of_module_id
+    (dep_module_id : Lam_module_ident.t)
     ~(output_dir : string )
-    (module_system : Js_packages_info.module_system)        
+    (module_system : Js_packages_info.module_system)
   : string =
-  let current_package_info = Js_packages_state.get_packages_info ()  in 
-  fix_path_for_windows (    
-    match dep_module_id.kind  with 
+  let current_package_info = Js_packages_state.get_packages_info ()  in
+  fix_path_for_windows (
+    match dep_module_id.kind  with
     | External {name} -> name (* the literal string for external package *)
-    (* This may not be enough, 
-        1. For cross packages, we may need settle 
+    (* This may not be enough,
+        1. For cross packages, we may need settle
         down a single js package
         2. We may need es6 path for dead code elimination
-         But frankly, very few JS packages have no dependency, 
-         so having plugin may sound not that bad   
+         But frankly, very few JS packages have no dependency,
+         so having plugin may sound not that bad
     *)
-    | Runtime  -> 
+    | Runtime  ->
       get_runtime_module_path dep_module_id current_package_info module_system
-    | Ml  -> 
-      let current_info_query = 
-        Js_packages_info.query_package_infos 
+    | Ml  ->
+      let current_info_query =
+        Js_packages_info.query_package_infos
           current_package_info
-          module_system  
+          module_system
       in
-      match Lam_compile_env.get_package_path_from_cmj dep_module_id with 
-      | (package_path, dep_package_info, case) -> 
+      match Lam_compile_env.get_package_path_from_cmj dep_module_id with
+      | (package_path, dep_package_info, case) ->
 
 
-        let dep_info_query =  
-          Js_packages_info.query_package_infos dep_package_info module_system 
-        in 
+        let dep_info_query =
+          Js_packages_info.query_package_infos dep_package_info module_system
+        in
         match dep_info_query, current_info_query with
-        | Package_not_found , _  -> 
+        | Package_not_found , _  ->
           Bs_exception.error (Missing_ml_dependency dep_module_id.id.name)
-        | Package_script , Package_found _  -> 
+        | Package_script , Package_found _  ->
           Bs_exception.error (Dependency_script_module_dependent_not dep_module_id.id.name)
         | (Package_script  | Package_found _ ), Package_not_found -> assert false
 
-        | Package_found ({suffix} as pkg), Package_script 
-          ->    
-          let js_file =  
-            Ext_namespace.js_name_of_modulename dep_module_id.id.name case suffix in 
+        | Package_found ({suffix} as pkg), Package_script
+          ->
+          let js_file =
+            Ext_namespace.js_name_of_modulename dep_module_id.id.name case suffix in
           pkg.pkg_rel_path // js_file
         | Package_found ({suffix } as dep_pkg),
-          Package_found cur_pkg -> 
-          let js_file =  
-            Ext_namespace.js_name_of_modulename dep_module_id.id.name case suffix in 
+          Package_found cur_pkg ->
+          let js_file =
+            Ext_namespace.js_name_of_modulename dep_module_id.id.name case suffix in
 
-          if  Js_packages_info.same_package_by_name current_package_info  dep_package_info then 
+          if  Js_packages_info.same_package_by_name current_package_info  dep_package_info then
             Ext_path.node_rebase_file
               ~from:cur_pkg.rel_path
-              ~to_:dep_pkg.rel_path 
+              ~to_:dep_pkg.rel_path
               js_file
               (* TODO: we assume that both [x] and [path] could only be relative path
                   which is guaranteed by [-bs-package-output]
               *)
-          else  
-          if Js_packages_info.is_runtime_package dep_package_info then 
+          else
+          if Js_packages_info.is_runtime_package dep_package_info then
             get_runtime_module_path dep_module_id current_package_info module_system
-          else 
-            begin match module_system with 
-              | Commonjs | Esmodule -> 
+          else
+            begin match module_system with
+              | Commonjs | Esmodule ->
                 dep_pkg.pkg_rel_path // js_file
               (* Note we did a post-processing when working on Windows *)
-              | Es6_global 
-                ->             
-                begin 
-                  Ext_path.rel_normalized_absolute_path              
+              | Es6_global
+                ->
+                begin
+                  Ext_path.rel_normalized_absolute_path
                     ~from:(
-                      Js_packages_info.get_output_dir 
+                      Js_packages_info.get_output_dir
                         current_package_info
                         ~package_dir:(Lazy.force Ext_path.package_dir)
-                        module_system 
+                        module_system
                     )
-                    (package_path // dep_pkg.rel_path // js_file)              
+                    (package_path // dep_pkg.rel_path // js_file)
                 end
             end
-        | Package_script, Package_script 
-          -> 
-          let js_file =  
-            Ext_namespace.js_name_of_modulename dep_module_id.id.name case Literals.suffix_js in 
-          match Config_util.find_opt js_file with 
-          | Some file -> 
-            let basename = Filename.basename file in 
-            let dirname = Filename.dirname file in 
+        | Package_script, Package_script
+          ->
+          let js_file =
+            Ext_namespace.js_name_of_modulename dep_module_id.id.name case Literals.suffix_js in
+          match Config_util.find_opt js_file with
+          | Some file ->
+            let basename = Filename.basename file in
+            let dirname = Filename.dirname file in
             Ext_path.node_rebase_file
               ~from:(
-                Ext_path.absolute_cwd_path 
+                Ext_path.absolute_cwd_path
                   output_dir)
               ~to_:(
-                Ext_path.absolute_cwd_path 
+                Ext_path.absolute_cwd_path
 
                   dirname)
-              basename  
-          | None -> 
+              basename
+          | None ->
             Bs_exception.error (Js_not_found js_file))
 
 #endif
diff --git a/compiler/core/res_compmisc.ml b/compiler/core/res_compmisc.ml
@@ -25,7 +25,7 @@
 let init_path () =
   let stdlib_dir =
     let ( // ) = Filename.concat in
-    Runtime_package.path // "lib" // "ocaml"
+    !Runtime_package.path // "lib" // "ocaml"
   in
   let dirs = !Clflags.include_dirs in
   let exp_dirs = List.map (Misc.expand_directory stdlib_dir) dirs in
diff --git a/compiler/ext/runtime_package.ml b/compiler/ext/runtime_package.ml
@@ -1,8 +1,7 @@
 let name = "@rescript/runtime"
 
-(* 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 path =
+(* Simple default approach to find the runtime package path. This will not work with all package managers/layouts. *)
+let default_path =
   let build_path rest path =
     String.concat Filename.dir_sep (List.rev_append rest path)
   in
@@ -11,24 +10,20 @@ let path =
     |> String.split_on_char Filename.dir_sep.[0]
     |> List.rev
   with
-  (* 1. Packages installed via pnpm
-     - bin:     node_modules/.pnpm/@rescript+darwin-arm64@12.0.0-alpha.13/node_modules/@rescript/darwin-arm64/bin
-     - runtime: node_modules/.pnpm/node_modules/@rescript/runtime (symlink)
-  *)
-  | "bin" :: _platform :: "@rescript" :: "node_modules" :: _package :: ".pnpm"
-    :: "node_modules" :: rest ->
-    build_path rest
-      ["node_modules"; ".pnpm"; "node_modules"; "@rescript"; "runtime"]
-  (* 2. Packages installed via npm
+  (* 1. Packages installed via npm
      - bin:     node_modules/@rescript/{platform}/bin
      - runtime: node_modules/@rescript/runtime
   *)
   | "bin" :: _platform :: "@rescript" :: "node_modules" :: rest ->
     build_path rest ["node_modules"; "@rescript"; "runtime"]
-  (* 3. Several other cases that can occur in local development, e.g.
+  (* 2. Several other cases that can occur in local development, e.g.
      - bin:     <repo>/packages/@rescript/{platform}/bin, <repo>/_build/install/default/bin
      - runtime: <repo>/packages/@rescript/runtime
   *)
   | _ :: _ :: _ :: _ :: rest ->
     build_path rest ["packages"; "@rescript"; "runtime"]
   | _ -> ""
+
+(* To support pnpm and other package managers/layouts, we determine the path on the JS side and pass it in
+via -runtime-path to override the default. *)
+let path = ref default_path
diff --git a/compiler/ext/runtime_package.mli b/compiler/ext/runtime_package.mli
@@ -1,3 +1,3 @@
 val name : string
 
-val path : string
+val path : string ref

Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,3 @@`
`1`	`1`	`val name : string`
`2`	`2`
`3`		`-val path : string`
	`3`	`+val path : string ref`