Use Yarn workspace (#7357)

* Use NPM workspace

* fix Makefiles

* ignore lockfiles in temp packages

* ignore lockfiles in alaysis example projects

* Switch to Yarn (Berry) workspace

* vendor rescript-react for testing

* Use link (or portal) protocol to avoid force-hoisting

* add doc

* immutable is default in CI

* fix test

* removed a module to keep it as minimal

* biome should ignore yarn binary

* add changelog

Author: cometkim

.devcontainer/Dockerfile

@@ -4,6 +4,7 @@ LABEL org.opencontainers.image.description="Docker image for ReScript developmen
 
 RUN apt-get update && export DEBIAN_FRONTEND=noninteractive \
     && apt-get -y install --no-install-recommends \
+    yarn \
     opam \
     musl-tools \
     python-is-python3 \

.gitattributes

@@ -2,3 +2,5 @@
 *.mli linguist-language=OCaml
 *.res linguist-language=ReScript
 *.resi linguist-language=ReScript
+
+.yarn/releases/* binary linguist-vendored

.github/workflows/ci.yml

@@ -135,6 +135,7 @@ jobs:
       - name: Use Node.js
         uses: actions/setup-node@v4
         with:
+          cache: yarn
           node-version-file: .nvmrc
 
       - name: Get artifact dir name
@@ -281,7 +282,7 @@ jobs:
           key: ${{ steps.compiler-build-state-key.outputs.value }}
 
       - name: Install npm packages
-        run: npm ci --ignore-scripts
+        run: yarn install
 
       - name: Copy compiler exes to platform bin dir
         run: node ./scripts/copyExes.js -compiler
@@ -429,10 +430,11 @@ jobs:
       - name: Use Node.js
         uses: actions/setup-node@v4
         with:
+          cache: yarn
           node-version-file: .nvmrc
 
       - name: NPM install
-        run: npm ci --ignore-scripts
+        run: yarn install
 
       - name: Download artifacts
         uses: actions/download-artifact@v4
@@ -523,6 +525,7 @@ jobs:
       - name: Use Node.js
         uses: actions/setup-node@v4
         with:
+          cache: yarn
           node-version-file: .nvmrc
           registry-url: https://registry.npmjs.org # Needed to make auth work for publishing
 

.gitignore

@@ -81,3 +81,10 @@ tests/tools_tests/**/*.res.js
 tests/tools_tests/lib
 tests/analysis_tests*/lib
 tests/analysis_tests/**/*.bs.js
+
+.yarn/*
+!.yarn/patches
+!.yarn/plugins
+!.yarn/releases
+!.yarn/sdks
+!.yarn/versions

.yarn/releases/yarn-4.7.0.cjs

@@ -0,0 +1,5 @@
+yarnPath: .yarn/releases/yarn-4.7.0.cjs
+
+nodeLinker: node-modules
+
+nmMode: hardlinks-global

.yarnrc.yml

@@ -33,6 +33,7 @@
 #### :house: Internal
 
 - Clean up legacy tags handling. https://github.com/rescript-lang/rescript/pull/7309
+- Use Yarn (Berry) workspaces for internal tooling. https://github.com/rescript-lang/rescript/pull/7309
 
 #### :nail_care: Polish
 

CHANGELOG.md

@@ -15,6 +15,7 @@ Happy hacking!
 > Most of our contributors are working on Apple machines, so all our instructions are currently macOS / Linux centric. Contributions for Windows development welcome!
 
 - [Node.js](https://nodejs.org/) v20.x
+- [Yarn CLI](https://yarnpkg.com/getting-started/install) (can be installed with `corepack`, Homebrew, etc)
 - C compiler toolchain (usually installed with `xcode` on Mac)
 - Python <= 3.11 (required to build ninja)
 - Rust toolchain (required to build rewatch; follow the instructions at https://www.rust-lang.org/tools/install)
@@ -58,7 +59,7 @@ opam install . --deps-only --with-test --with-dev-setup -y
 
 #### npm install
 
-Run `npm install --ignore-scripts`. This will install the npm dependencies required for the build scripts.
+Run `yarn install`. This will install the npm dependencies required for the build scripts.
 
 ### B. Devcontainer
 

CONTRIBUTING.md

@@ -26,9 +26,6 @@ ninja/ninja:
 
 ninja: ninja/ninja
 
-node_modules/.bin/semver:
-	npm install
-
 test: lib
 	node scripts/test.js -all
 
@@ -54,7 +51,7 @@ test-all: test test-gentype test-analysis test-tools
 reanalyze:
 	reanalyze.exe -set-exit-code -all-cmt _build/default/compiler _build/default/tests -exclude-paths compiler/outcome_printer,compiler/ml,compiler/js_parser,compiler/frontend,compiler/ext,compiler/depends,compiler/core,compiler/common,compiler/cmij,compiler/bsb_helper,compiler/bsb
 
-lib: build node_modules/.bin/semver
+lib: build
 	./scripts/buildRuntime.sh
 	./scripts/prebuilt.js
 

Makefile

@@ -1,2 +1,4 @@
 lib
-.merlin
+.merlin
+package-lock.json
+yarn.lock

analysis/examples/example-project/.gitignore

@@ -1,2 +1,4 @@
 /node_modules
-/lib
+/lib
+package-lock.json
+yarn.lock

analysis/examples/example-project/package-lock.json

@@ -91,7 +91,7 @@ type callback<'input, 'output> = React.callback<'input, 'output>
 type testReactContext = React.Context.t<int>
 
 @genType
-type testReactRef = React.Ref.t<int>
+type testReactRef = React.ref<int>
 
 @genType
 type testDomRef = ReactDOM.domRef

analysis/examples/larger-project/.gitignore

@@ -25,3 +25,5 @@ lib
 .merlin
 .bsb.lock
 /node_modules/
+package-lock.json
+yarn.lock

analysis/examples/larger-project/package-lock.json

@@ -21,6 +21,7 @@
     "lineWidth": 80,
     "attributePosition": "auto",
     "ignore": [
+      ".yarn/**",
       "tests/build_tests/**",
       "tests/tests/**",
       "tests/tools_tests/**",