use yarn pack to handle workspace protocol

Author: cometkim

.github/workflows/ci.yml

@@ -463,14 +463,14 @@ jobs:
       - name: Move artifacts
         run: ./scripts/moveArtifacts.sh
 
-      - name: npm pack (rescript) + check artifact list
+      - name: yarn pack (rescript) + check artifact list
         run: node ./scripts/npmPack.js
 
       - name: Copy JS files to stdlib package
         run: mkdir -p packages/std/lib && cp -R lib/es6 lib/js packages/std/lib
 
-      - name: npm pack (@rescript/std)
-        run: npm pack
+      - name: yarn pack (@rescript/std)
+        run: yarn pack
         working-directory: packages/std
 
       - name: Prepare package upload
@@ -557,8 +557,8 @@ jobs:
         env:
           NODE_AUTH_TOKEN: ${{ secrets.NPM_ACCESS_TOKEN }}
         run: |
-          npm publish rescript-${{ needs.package.outputs.rescript_version }}.tgz --tag ci
-          npm publish rescript-std-${{ needs.package.outputs.rescript_version }}.tgz --tag ci
+          yarn npm publish rescript-${{ needs.package.outputs.rescript_version }}.tgz --tag ci
+          yarn npm publish rescript-std-${{ needs.package.outputs.rescript_version }}.tgz --tag ci
 
       - name: Update Website Playground
         env:

.gitignore

@@ -90,3 +90,5 @@ tests/analysis_tests/**/*.bs.js
 !.yarn/versions
 
 *.tsbuildinfo
+
+*.tgz

package.json

@@ -55,9 +55,10 @@
     "typecheck": "tsc"
   },
   "files": [
+    "COPYING",
+    "COPYING.LESSER",
     "CHANGELOG.md",
     "CREDITS.md",
-    "ninja.COPYING",
     "darwin",
     "darwinarm64",
     "linux",
@@ -87,6 +88,7 @@
     "typescript": "5.8.2"
   },
   "workspaces": [
+    "tools",
     "packages/*",
     "tests/dependencies/**",
     "tests/analysis_tests/**",

packages/artifacts.txt

@@ -1242,11 +1242,12 @@ linuxarm64/rescript-tools.exe
 linuxarm64/rescript.exe
 linuxarm64/rewatch.exe
 ninja.COPYING
+ninja/COPYING
 package.json
 win32/bsb_helper.exe
 win32/bsc.exe
 win32/ninja.exe
 win32/rescript-editor-analysis.exe
 win32/rescript-tools.exe
 win32/rescript.exe
-win32/rewatch.exe
+win32/rewatch.exe

scripts/moveArtifacts.sh

@@ -35,7 +35,6 @@ mv binaries-linuxarm64/* rewatch-linuxarm64/* linuxarm64
 mv binaries-win32/* rewatch-win32/* win32
 
 mv lib-ocaml lib/ocaml
-mv ninja/COPYING ninja.COPYING
 
 check_statically_linked "linux"
 check_statically_linked "linuxarm64"

scripts/npmPack.js

@@ -2,70 +2,96 @@
 
 // @ts-check
 
-// TODO: Use `yarn pack --json` instead.
-
-// This performs `npm pack` and retrieves the list of artifact files from the output.
+// This performs `yarn pack --json` and retrieves the list of artifact files from the output.
 //
 // In local dev, invoke it with `-updateArtifactList` to perform a dry run of `npm pack`
-// and recreate `packages/artifacts.txt`.
+// and recreate `packages/artifacts.jsonl`.
 // The exes for all platforms will then be included in the list, even if not present locally.
 //
-// In CI, the scripts is invoked without options. It then performs `npm pack` for real,
+// In CI, the scripts is invoked without options. It then performs `yarn pack` for real,
 // recreates the artifact list and verifies that it has no changes compared to the committed state.
 
-/**
- * @typedef {{
- *   path: string,
- *   size: number,
- *   mode: number,
- * }} PackOutputFile
- *
- * @typedef {{
- *   files: PackOutputFile[],
- *   entryCount: number,
- *   bundled: unknown[],
- * }} PackOutputEntry
- *
- * @typedef {[PackOutputEntry]} PackOutput
- */
-
-import { execSync, spawnSync } from "node:child_process";
+import { execSync, spawn } from "node:child_process";
 import fs from "node:fs";
 import path from "node:path";
 import { projectDir } from "#dev/paths";
 
+/**
+ * @typedef {{ base: string }} YarnPackBase
+ * @typedef {{ location: string }} YarnPackEntry
+ * @typedef {{ output: string }} YarnPackResult
+ *
+ * @typedef {(
+ *   | YarnPackBase
+ *   | YarnPackEntry
+ *   | YarnPackResult
+ * )} YarnPackOutput
+ */
+
 const mode = process.argv.includes("-updateArtifactList")
   ? "updateArtifactList"
   : "package";
 
 const fileListPath = path.join(projectDir, "packages", "artifacts.txt");
 
-const output = spawnSync(
-  `npm pack --json${mode === "updateArtifactList" ? " --dry-run" : ""}`,
+/** @type {Set<string>} */
+const fileList = new Set();
+
+const child = spawn(
+  "yarn",
+  [
+    "pack",
+    "--json",
+    mode === "updateArtifactList" ? "--dry-run" : "",
+  ].filter(Boolean),
   {
     cwd: projectDir,
-    encoding: "utf8",
-    shell: true,
+    shell: process.platform === "win32",
+    stdio: ["inherit", "pipe", "pipe"],
   },
-).stdout;
+);
+
+const exitCode = new Promise((res, rej) => {
+  child.once("close", code => res(code));
+  child.once("error", rej);
+});
+
+for await (const chunk of child.stdout.setEncoding("utf8")) {
+  const lines = /** @type {string} */ (chunk).trim().split(/\s/);
+  for (const line of lines) {
+    /** @type {YarnPackOutput} */
+    const json = JSON.parse(line);
+    if ("location" in json) {
+      fileList.add(json.location);
+    }
+  }
+}
 
-/** @type {PackOutput} */
-const parsedOutput = JSON.parse(output);
-let filePaths = parsedOutput[0].files.map(file => file.path);
+await exitCode;
 
-if (mode === "updateArtifactList") {
-  filePaths = Array.from(new Set(filePaths.concat(getFilesAddedByCI())));
+for await (const file of getFilesAddedByCI()) {
+  fileList.add(file);
 }
 
-filePaths.sort();
-fs.writeFileSync(fileListPath, filePaths.join("\n"));
+fs.unlinkSync(fileListPath);
+for (const file of [...fileList].toSorted()) {
+  fs.appendFileSync(fileListPath, file + "\n");
+}
 
 if (mode === "package") {
   execSync(`git diff --exit-code ${fileListPath}`, { stdio: "inherit" });
 }
 
-function getFilesAddedByCI() {
-  const platforms = ["darwin", "darwinarm64", "linux", "linuxarm64", "win32"];
+function *getFilesAddedByCI() {
+  yield "ninja.COPYING";
+
+  const platforms = [
+    "darwin",
+    "darwinarm64",
+    "linux",
+    "linuxarm64",
+    "win32",
+  ];
   const exes = [
     "bsb_helper.exe",
     "bsc.exe",
@@ -76,13 +102,9 @@ function getFilesAddedByCI() {
     "rewatch.exe",
   ];
 
-  const files = ["ninja.COPYING"];
-
   for (const platform of platforms) {
     for (const exe of exes) {
-      files.push(`${platform}/${exe}`);
+      yield `${platform}/${exe}`;
     }
   }
-
-  return files;
 }

tools/CHANGELOG.md

@@ -1,6 +1,6 @@
 {
   "compilerOptions": {
-    "target": "ES2022",
+    "target": "ESNext",
     "module": "NodeNext",
     "moduleResolution": "NodeNext",
     "allowJs": true,