@rescript/runtime package (#7796)

* move minisocket.js

# Conflicts:
#	cli/common/bsb.js

* move runtime codes

* move runtime artifacts

* new runtime resolution

* fix ci

* clean-lib-bsb

* yarn constraints --fix

* move cppo script

* fix a diff script in ci workflow

* update artifacts

* remove an unused import mapping

* sync gentype results

* Format some files

* Fix rewatch tests

* Bring back advanced logic for finding runtime path

* Hack to fix finding runtime module in analysis/tools

* Fix package name for tools test

* Fix playground build

* Improve build step names

* Fix apidocs generation

* Remove buildRuntime.sh

* Fix pkg-pr-new

* Fix pnpm

* CHANGELOG

* Do not include *.res(i) in the runtime files

* Add comment

---------

Co-authored-by: Hyeseong Kim <[email protected]>

Author: cknitt

.github/workflows/ci.yml

@@ -328,12 +328,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
@@ -439,7 +440,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

@@ -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

Makefile

@@ -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/BuildSystem.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/Files.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/FindFiles.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

analysis/src/ModuleResolution.ml

@@ -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");