@rescript/runtime package

.github/workflows/ci.yml

@@ -336,12 +336,13 @@ jobs:
  run: ./scripts/test_syntax.sh
  shell: bash
 
- - name: Build runtime/stdlib
- run: ./scripts/buildRuntime.sh
+ - name: Build @rescript/runtime
+ run: yarn workspace @rescript/runtime rescript build
  shell: bash
 
- - name: Check for changes in lib folder
+ - name: Check for changes in @rescript/runtime/lib
  run: git diff --exit-code lib/js lib/es6
+ working-directory: packages/@rescript/runtime
 
  - name: Version Check
  run: yarn constraints
@@ -447,7 +448,7 @@ jobs:
  uses: actions/upload-artifact@v4
  with:
  name: lib-ocaml
- path: lib/ocaml
+ path: packages/@rescript/runtime/lib/ocaml
 
  - name: Generate API Docs
  if: ${{ matrix.generate_api_docs }}

.github/workflows/moveArtifacts.sh

@@ -26,7 +26,7 @@ check_statically_linked() {
 }
 
 # rescript
-mv lib-ocaml lib/ocaml
+mv lib-ocaml packages/@rescript/runtime/lib/ocaml
 
 # @rescript/{target}
 chmod +x binaries-*/*.exe
@@ -40,4 +40,4 @@ check_statically_linked "packages/@rescript/linux-arm64/bin"
 
 # @rescript/std
 mkdir -p packages/std/lib
-cp -R lib/es6 lib/js packages/std/lib
+cp -R packages/@rescript/runtime/lib/es6 packages/@rescript/runtime/lib/js packages/std/lib

CHANGELOG.md

@@ -14,6 +14,8 @@
 
 #### :boom: Breaking Change
 
+- Extract ReScript runtime files from main `rescript` package to separate `@rescript/runtime` package. https://github.com/rescript-lang/rescript/pull/7796
+
 #### :eyeglasses: Spec Compliance
 
 #### :rocket: New Feature

Makefile

@@ -52,7 +52,7 @@ reanalyze:
 reanalyze.exe -set-exit-code -all-cmt _build/default/compiler _build/default/tests -exclude-paths compiler/outcome_printer,compiler/ml,compiler/frontend,compiler/ext,compiler/depends,compiler/core,compiler/common,compiler/cmij,compiler/bsb_helper,compiler/bsb
 
 lib:
-./scripts/buildRuntime.sh
+yarn workspace @rescript/runtime build
 
 artifacts: lib
 ./scripts/npmPack.js --updateArtifactList
@@ -84,8 +84,10 @@ clean-gentype:
 clean-rewatch:
 cargo clean --manifest-path rewatch/Cargo.toml && rm -f rewatch/rewatch
 
-clean:
-(cd runtime && ../cli/rescript.js clean)
+clean-lib:
+yarn workspace @rescript/runtime rescript clean
+
+clean: clean-lib
 dune clean
 
 clean-all: clean clean-gentype clean-rewatch

analysis/src/BuildSystem.ml

@@ -5,23 +5,24 @@ let namespacedName namespace name =
 
 let ( /+ ) = Filename.concat
 
-let getBsPlatformDir rootPath =
+let getRuntimeDir rootPath =
  match !Cfg.isDocGenFromCompiler with
  | false -> (
  let result =
- ModuleResolution.resolveNodeModulePath ~startPath:rootPath "rescript"
+ ModuleResolution.resolveNodeModulePath ~startPath:rootPath
+ "@rescript/runtime"
  in
  match result with
  | Some path -> Some path
  | None ->
- let message = "rescript could not be found" in
+ 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 getBsPlatformDir base with
+ match getRuntimeDir base with
  | None -> None
- | Some bsPlatformDir -> Some (bsPlatformDir /+ "lib" /+ "ocaml")
+ | Some runtimeDir -> Some (runtimeDir /+ "lib" /+ "ocaml")

analysis/src/Files.ml

@@ -84,16 +84,26 @@ let rec collectDirs path =
  |> List.concat)
  | _ -> []
 
-let rec collect ?(checkDir = fun _ -> true) path test =
- match maybeStat path with
- | None -> []
- | Some {Unix.st_kind = Unix.S_DIR} ->
+let rec collect ?(checkDir = fun _ -> true) ?maxDepth path test =
+ match (maxDepth, maybeStat path) with
+ | None, None -> []
+ | Some 0, _ -> []
+ | None, Some {Unix.st_kind = Unix.S_DIR} ->
  if checkDir path then
  readDirectory path
  |> List.map (fun name ->
  collect ~checkDir (Filename.concat path name) test)
  |> List.concat
  else []
+ | Some n, Some {Unix.st_kind = Unix.S_DIR} ->
+ if checkDir path then
+ readDirectory path
+ |> List.map (fun name ->
+ collect ~checkDir ~maxDepth:(n - 1)
+ (Filename.concat path name)
+ test)
+ |> List.concat
+ else []
  | _ -> if test path then [path] else []
 
 type classifiedFile = Res | Resi | Other

analysis/src/FindFiles.ml

@@ -141,8 +141,10 @@ let findProjectFiles ~public ~namespace ~path ~sourceDirectories ~libBs =
  sourceDirectories |> List.map (Filename.concat path) |> StringSet.of_list
  in
  let files =
+ (* Use maxDepth to prevent infinite recursion where `rescript` depends on `@rescript/runtime`,
+ but `@rescript/runtime` also has `rescript` as a dev dependency *)
  dirs |> StringSet.elements
- |> List.map (fun name -> Files.collect name isSourceFile)
+ |> List.map (fun name -> Files.collect ~maxDepth:2 name isSourceFile)
  |> List.concat |> StringSet.of_list
  in
  dirs

analysis/src/ModuleResolution.ml

@@ -1,7 +1,18 @@
 let ( /+ ) = Filename.concat
 
 let rec resolveNodeModulePath ~startPath name =
- 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

cli/common/bsb.js

@@ -5,9 +5,9 @@ import * as fs from "node:fs";
 import { createServer } from "node:http";
 import * as os from "node:os";
 import * as path from "node:path";
-import { WebSocket } from "#lib/minisocket";
 
 import { rescript_legacy_exe } from "./bins.js";
+import { WebSocket } from "./minisocket.js";
 
 const cwd = process.cwd();
 const lockFileName = path.join(cwd, ".bsb.lock");

compiler/bsc/rescript_compiler_main.ml

@@ -205,12 +205,6 @@ let eval (s : string) ~suffix =
 
 (* let (//) = Filename.concat *)
 
-let print_standard_library () =
- let standard_library = Config.standard_library in
- print_string standard_library;
- print_newline ();
- exit 0
-
 let bs_version_string = "ReScript " ^ Bs_version.version
 
 let print_version_string () =
@@ -378,9 +372,6 @@ let command_line_flags : (string * Bsc_args.spec * string) array =
  ( "-ignore-parse-errors",
  set Clflags.ignore_parse_errors,
  "*internal* continue after parse errors" );
- ( "-where",
- unit_call print_standard_library,
- "*internal* Print location of standard library and exit" );
  ( "-verbose",
  set Clflags.verbose,
  "*internal* Print calls to external commands" );

compiler/common/bs_version.ml

@@ -23,4 +23,4 @@
  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. *)
 let version = "12.0.0-beta.8"
 let header = "// Generated by ReScript, PLEASE EDIT WITH CARE"
-let package_name = ref "rescript"
+let package_name = ref "@rescript/runtime"

compiler/ext/config.ml

@@ -1,6 +1,6 @@
-(* This resolves the location of the standard library starting from the location of bsc.exe,
- handling different supported package layouts. *)
-let standard_library =
+(* 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 runtime_module_path =
  let build_path rest path =
  String.concat Filename.dir_sep (List.rev_append rest path)
  in
@@ -10,25 +10,31 @@ let standard_library =
  |> 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
- - stdlib: node_modules/rescript/lib/ocaml (symlink)
+ - 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"; "rescript"; "lib"; "ocaml"]
+ build_path rest
+ ["node_modules"; ".pnpm"; "node_modules"; "@rescript"; "runtime"]
  (* 2. Packages installed via npm
- - bin: node_modules/@rescript/{platform}/bin
- - stdlib: node_modules/rescript/lib/ocaml
+ - bin:  node_modules/@rescript/{platform}/bin
+ - runtime: node_modules/@rescript/runtime
  *)
  | "bin" :: _platform :: "@rescript" :: "node_modules" :: rest ->
- build_path rest ["node_modules"; "rescript"; "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>/lib/ocaml
+ - bin:  <repo>/packages/@rescript/{platform}/bin, <repo>/_build/install/default/bin
+ - runtime: <repo>/packages/@rescript/runtime
  *)
- | _ :: _ :: _ :: _ :: rest -> build_path rest ["lib"; "ocaml"]
+ | _ :: _ :: _ :: _ :: rest ->
+ 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
 

package.json

@@ -62,7 +62,6 @@
  "CREDITS.md",
  "ninja.COPYING",
  "docs/docson/build-schema.json",
- "lib",
  "cli"
  ],
  "exports": {
@@ -72,8 +71,10 @@
  },
  "imports": {
  "#cli/*": "./cli/common/*.js",
- "#dev/*": "./lib_dev/*.js",
- "#lib/minisocket": "./lib/minisocket.js"
+ "#dev/*": "./lib_dev/*.js"
+ },
+ "dependencies": {
+ "@rescript/runtime": "workspace:packages/@rescript/runtime"
  },
  "optionalDependencies": {
  "@rescript/darwin-arm64": "workspace:packages/@rescript/darwin-arm64",

packages/@rescript/runtime/.gitignore

@@ -0,0 +1,3 @@
+lib/bs
+lib/ocaml
+*.lock

runtime/cppo/internal_map.res.cppo → packages/@rescript/runtime/cppo/internal_map.res.cppo

@@ -71,7 +71,7 @@ let rec getUndefined = (n, x: key) =>
 
 let rec getExn = (n, x: key) =>
  switch n {
- | None => raise(Not_found)
+ | None => throw(Not_found)
  | Some(n) =>
  let v = n.N.key
  if x == v {

runtime/cppo/internal_set.res.cppo → packages/@rescript/runtime/cppo/internal_set.res.cppo

@@ -113,7 +113,7 @@ let rec getUndefined = (n: t, x: value) =>
 
 let rec getExn = (n: t, x: value) =>
  switch n {
- | None => raise(Not_found)
+ | None => throw(Not_found)
  | Some(t) =>
  let v = t.value
  if x == v {

runtime/cppo/map.resi.cppo → packages/@rescript/runtime/cppo/map.resi.cppo

@@ -36,9 +36,24 @@ let findFirstByU: (t<'v>, (key, 'v) => bool) => option<(key, 'v)>
 `findFirstBy(m, p)` uses funcion `f` to find the first key value pair
 to match predicate `p`.
 
+## Examples
+
 ```rescript
-let s0 = fromArray(~id=module(IntCmp), [(4, "4"), (1, "1"), (2, "2,"(3, ""))])
-findFirstBy(s0, (k, v) => k == 4) == option((4, "4"))
+#ifdef TYPE_STRING
+let mapString = Belt.Map.String.fromArray([("1", "one"), ("2", "two"), ("3", "three")])
+
+mapString->
+Belt.Map.String.findFirstBy((k, v) => k == "1" && v == "one")
+->assertEqual(Some("1", "one"))
+#elif defined TYPE_INT
+let mapInt = Belt.Map.Int.fromArray([(1, "one"), (2, "two"), (3, "three")])
+
+mapInt->
+Belt.Map.Int.findFirstBy((k, v) => k == 1 && v == "one")
+->assertEqual(Some(1, "one"))
+#else
+[%error "unknown type"]
+#endif
 ```
 */
 let findFirstBy: (t<'v>, (key, 'v) => bool) => option<(key, 'v)>