Include the contents of @rescript/runtime in the artifact list

Author: cknitt

.github/workflows/ci.yml

@@ -478,7 +478,9 @@ jobs:
         shell: bash
 
       - name: Check artifact list
-        run: node ./scripts/npmPack.js
+        run: |
+          node ./scripts/updateArtifactList.js
+          git diff --exit-code packages/artifacts.json
 
       - name: Publish packages to pkg.pr.new
         run: |

CONTRIBUTING.md

@@ -111,11 +111,11 @@ make artifacts
 - OCaml Code: snake case format is used, e.g, `to_string`
 - ReScript Code: the camel case format is used, e.g `toString`
 
-## Adding new Files to the Npm Package
+## Adding new Files to the Npm Packages
 
-To make sure that no files are added to or removed from the npm package inadvertently, an artifact list is kept at `packages/artifacts.txt`. During CI build, it is verified that only the files that are listed there are actually included in the npm package.
+To make sure that no files are added to or removed from the `rescript` or `@rescript/runtime` npm package inadvertently, an artifact list is kept at `packages/artifacts.json`. During CI build, it is verified that only the files that are listed there are actually included in the npm packages.
 
-After adding a new file to the repository that should go into the npm package - e.g., a new stdlib module -, run `make artifacts`.
+After adding a new file to the repository that should go into one of the npm packages - e.g., a new stdlib module -, run `make artifacts`.
 
 ## Test the compiler
 

Makefile

@@ -55,7 +55,7 @@ lib:
 	yarn workspace @rescript/runtime build
 
 artifacts: lib
-	./scripts/npmPack.js --updateArtifactList
+	./scripts/updateArtifactList.js
 
 # Builds the core playground bundle (without the relevant cmijs files for the runtime)
 playground:

lib_dev/paths.js

@@ -67,12 +67,12 @@ export const compilerVersionFile = path.resolve(
 );
 
 /**
- * path: `<projectDir>/packages/artifacts.txt`
+ * path: `<projectDir>/packages/artifacts.json`
  */
 export const artifactListFile = path.resolve(
   projectDir,
   "packages",
-  "artifacts.txt",
+  "artifacts.json",
 );
 
 /**

packages/artifacts.json

@@ -0,0 +1,27 @@
+{
+  "rescript": [
+    "CHANGELOG.md",
+    "COPYING",
+    "COPYING.LESSER",
+    "CREDITS.md",
+    "LICENSE",
+    "README.md",
+    "cli/bsc.js",
+    "cli/bstracing.js",
+    "cli/common/args.js",
+    "cli/common/bins.js",
+    "cli/common/bsb.js",
+    "cli/common/minisocket.js",
+    "cli/rescript-legacy.js",
+    "cli/rescript-legacy/dump.js",
+    "cli/rescript-legacy/format.js",
+    "cli/rescript-tools.js",
+    "cli/rescript.js",
+    "docs/docson/build-schema.json",
+    "ninja/COPYING",
+    "package.json"
+  ],
+  "@rescript/runtime": [
+    "package.json"
+  ]
+}

packages/artifacts.txt

@@ -0,0 +1,65 @@
+#!/usr/bin/env node
+
+// @ts-check
+
+import { spawn } from "node:child_process";
+import * as fs from "node:fs/promises";
+import * as readline from "node:readline/promises";
+import { artifactListFile } from "#dev/paths";
+
+/**
+ * @typedef {(
+ *   | { "base": string }
+ *   | { "location": string }
+ *   | { "output": string }
+ * )} YarnPackOutputLine
+ */
+
+/**
+ * @param {string} pkg
+ */
+async function getArtifacts(pkg) {
+  const args = ["workspace", pkg, "pack", "--json", "--dry-run"];
+
+  const files = [];
+
+  const child = spawn("yarn", args);
+
+  const exitCode = new Promise((resolve, reject) => {
+    child.once("error", reject);
+    child.once("close", code => resolve(code));
+  });
+
+  for await (const line of readline.createInterface({
+    input: child.stdout.setEncoding("utf8"),
+    crlfDelay: Number.POSITIVE_INFINITY,
+  })) {
+    /** @type {YarnPackOutputLine} */
+    const json = JSON.parse(line);
+    if ("location" in json) {
+      // Workaround for false positive reports
+      // See https://github.com/yarnpkg/berry/issues/6766
+      if (json.location.startsWith("_build")) {
+        continue;
+      }
+
+      files.push(json.location);
+    }
+  }
+
+  await exitCode;
+
+  return files;
+}
+
+/** @type {Record<string, string[]>} */
+const artifactsPerPackage = {};
+
+for (const pkg of ["rescript", "@rescript/runtime"]) {
+  artifactsPerPackage[pkg] = await getArtifacts(pkg);
+}
+
+await fs.writeFile(
+  artifactListFile,
+  JSON.stringify(artifactsPerPackage, null, 2),
+);