Convert to ESM, with refactoring codebase

Author: cometkim

.github/workflows/get_artifact_dir_name.js

@@ -1,7 +1,7 @@
-const fs = require("node:fs");
-const os = require("node:os");
+import * as fs from "node:fs";
+import * as os from "node:os";
 
-const { platformName } = require("#cli/bin_path");
+import { platformName } from "#cli/paths";
 
 // Pass artifactDirName to subsequent GitHub actions
 fs.appendFileSync(

.github/workflows/prepare_package_upload.js

@@ -1,8 +1,7 @@
-const fs = require("node:fs");
-const os = require("node:os");
+import * as fs from "node:fs";
+import * as os from "node:os";
 
-const packageSpec = require("rescript/package.json");
-const { version } = packageSpec;
+import { version } from "rescript/package.json" with { type: "json" };
 
 const commitHash = process.argv[2] || process.env.GITHUB_SHA;
 const commitHashShort = commitHash.substring(0, 7);

Makefile

@@ -89,7 +89,7 @@ clean-rewatch:
 	cargo clean --manifest-path rewatch/Cargo.toml && rm -f rewatch/rewatch
 
 clean:
-	(cd runtime && ../cli/rescript clean)
+	(cd runtime && ../cli/rescript.js clean)
 	dune clean
 
 clean-all: clean clean-gentype clean-rewatch 

biome.json

@@ -10,6 +10,9 @@
     "enabled": true,
     "rules": {
       "recommended": true,
+      "nursery": {
+        "noCommonJs": "error"
+      },
       "correctness": {
         "useImportExtensions": "error",
         "noUndeclaredDependencies": "error",
@@ -48,6 +51,7 @@
       "tests/analysis_tests/**/src/**",
       "tests/build_tests/**/src/**",
       "tests/docstring_tests/**",
+      "tests/gentype_tests/**",
       "tests/tests/**/src/**",
       "tests/tools_tests/**/src/**",
       "analysis/examples/**/src/**",

cli/rescript_arg.js renamed to cli/_args.js

@@ -15,12 +15,12 @@ class StringBuilder {
   }
 }
 
-class ArgError extends Error {}
+export class ArgError extends Error {}
 
 /**
  * @param {string} s
  */
-function bad_arg(s) {
+export function bad_arg(s) {
   throw new ArgError(s);
 }
 
@@ -118,7 +118,7 @@ function stop_raise(usage, error, specs) {
  * @param {number} start
  * @param {number} finish
  */
-function parse_exn(
+export function parse_exn(
   usage,
   argv,
   specs,
@@ -174,6 +174,3 @@ function parse_exn(
   }
   annofun(list);
 }
-exports.bad_arg = bad_arg;
-exports.parse_exn = parse_exn;
-exports.ArgError = ArgError;

cli/rescript_bsb.js renamed to cli/_bsb.js

@@ -1,12 +1,13 @@
 // @ts-check
 
-const fs = require("node:fs");
-const path = require("node:path");
-const os = require("node:os");
-const child_process = require("node:child_process");
-const { createServer } = require("node:http");
-const { MiniWebSocket: WebSocket } = require("#lib/minisocket");
-const { rescript_exe } = require("#cli/bin_path");
+import * as child_process from "node:child_process";
+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_exe } from "./_paths.js";
 
 const cwd = process.cwd();
 const lockFileName = path.join(cwd, ".bsb.lock");
@@ -27,7 +28,7 @@ const lockFileName = path.join(cwd, ".bsb.lock");
  * @type {child_process.ChildProcess | null}
  */
 let ownerProcess = null;
-function releaseBuild() {
+export function releaseBuild() {
   if (ownerProcess) {
     ownerProcess.kill("SIGHUP");
     try {
@@ -100,14 +101,14 @@ function delegate(args, maybeOnClose) {
 /**
  * @param {Array<string>} args
  */
-function info(args) {
+export function info(args) {
   delegate(["info", ...args]);
 }
 
 /**
  * @param {Array<string>} args
  */
-function clean(args) {
+export function clean(args) {
   delegate(["clean", ...args]);
 }
 
@@ -475,7 +476,7 @@ Please pick a different one using the \`-ws [host:]port\` flag from bsb.`);
 /**
  * @param {Array<string>} args
  */
-function build(args) {
+export function build(args) {
   // We want to show the compile time for build
   // But bsb might show a help message when --help or invalid arguments are passed
   // We don't want to show the compile time in that case
@@ -499,8 +500,3 @@ function build(args) {
   }
   delegate(["build", ...args]);
 }
-
-exports.releaseBuild = releaseBuild;
-exports.info = info;
-exports.clean = clean;
-exports.build = build;

cli/_paths.js

@@ -0,0 +1,37 @@
+// @ts-check
+
+import * as path from "node:path";
+import { fileURLToPath } from "node:url";
+
+const __dirname = path.dirname(fileURLToPath(import.meta.url));
+
+export const cliPath = path.join(__dirname, "rescript.js");
+
+/**
+ * For compatibility reasons, if the architecture is x64, omit it from the bin directory name.
+ * So we'll have "darwin", "linux" and "win32" for x64 arch,
+ * but "darwinarm64" and "linuxarm64" for arm64 arch.
+ * Also, we do not have Windows ARM binaries yet. But the x64 binaries do work on Windows 11 ARM.
+ * So omit the architecture for Windows, too.
+ */
+export const platformName =
+  process.arch === "x64" || process.platform === "win32"
+    ? process.platform
+    : process.platform + process.arch;
+
+export const platformDir = path.resolve(__dirname, "..", platformName);
+
+export const bsc_exe = path.join(platformDir, "bsc.exe");
+
+export const ninja_exe = path.join(platformDir, "ninja.exe");
+
+export const rescript_exe = path.join(platformDir, "rescript.exe");
+
+export const rescript_tools_exe = path.join(platformDir, "rescript-tools.exe");
+
+export const rescript_editor_analysis_exe = path.join(
+  platformDir,
+  "rescript-editor-analysis.exe",
+);
+
+export const rewatch_exe = path.join(platformDir, "rewatch.exe");

cli/bin_path.js

@@ -2,15 +2,14 @@
 
 // @ts-check
 
-"use strict";
+import { execFileSync } from "node:child_process";
 
-const child_process = require("child_process");
-const { bsc_exe } = require("./bin_path.js");
+import { bsc_exe } from "./_paths.js";
 
 const delegate_args = process.argv.slice(2);
 
 try {
-  child_process.execFileSync(bsc_exe, delegate_args, { stdio: "inherit" });
+  execFileSync(bsc_exe, delegate_args, { stdio: "inherit" });
 } catch (e) {
   if (e.code === "ENOENT") {
     console.error(String(e));

cli/bsc renamed to cli/bsc.js

@@ -2,10 +2,9 @@
 
 // @ts-check
 
-"use strict";
+import * as child_process from "node:child_process";
 
-const child_process = require("node:child_process");
-const { rescript_tools_exe } = require("./bin_path.js");
+import { rescript_tools_exe } from "./_paths.js";
 
 const args = process.argv.slice(2);
 

cli/rescript-tools renamed to cli/rescript-tools.js

@@ -2,15 +2,15 @@
 
 //@ts-check
 
-"use strict";
-
 // This script is supposed to be running in project root directory
 // It matters since we need read .sourcedirs(location)
 // and its content are file/directories with regard to project root
 
-const tty = require("node:tty");
-const { bsc_exe, rescript_exe } = require("./bin_path.js");
-const bsb = require("./rescript_bsb.js");
+import * as tty from "node:tty";
+import packageJson from "rescript/package.json" with { type: "json" };
+
+import * as bsb from "./_bsb.js";
+import { bsc_exe, rescript_exe } from "./_paths.js";
 
 const cwd = process.cwd();
 process.env.BSB_PROJECT_ROOT = cwd;
@@ -21,7 +21,10 @@ if (process.env.FORCE_COLOR === undefined) {
     process.env.NINJA_ANSI_FORCED = "1";
   }
 } else {
-  if (process.env.FORCE_COLOR === "1" && process.env.NINJA_ANSI_FORCED === undefined) {
+  if (
+    process.env.FORCE_COLOR === "1" &&
+    process.env.NINJA_ANSI_FORCED === undefined
+  ) {
     process.env.NINJA_ANSI_FORCED = "1";
   }
   if (process.argv.includes("-verbose")) {
@@ -77,19 +80,20 @@ try {
 
 const args = process.argv.slice(2);
 const argPatterns = {
-  help: ['help', '-h', '-help', '--help'],
-  version: ['version', '-v', '-version', '--version'],
+  help: ["help", "-h", "-help", "--help"],
+  version: ["version", "-v", "-version", "--version"],
 };
 
 const helpArgIndex = args.findIndex(arg => argPatterns.help.includes(arg));
 const firstPositionalArgIndex = args.findIndex(arg => !arg.startsWith("-"));
 
-if (helpArgIndex !== -1 && (firstPositionalArgIndex === -1 || helpArgIndex <= firstPositionalArgIndex)) {
+if (
+  helpArgIndex !== -1 &&
+  (firstPositionalArgIndex === -1 || helpArgIndex <= firstPositionalArgIndex)
+) {
   console.log(helpMessage);
-
 } else if (argPatterns.version.includes(args[0])) {
-  console.log(require("../package.json").version);
-
+  console.log(packageJson.version);
 } else if (firstPositionalArgIndex !== -1) {
   const subcmd = args[firstPositionalArgIndex];
   const subcmdArgs = args.slice(firstPositionalArgIndex + 1);
@@ -108,25 +112,17 @@ if (helpArgIndex !== -1 && (firstPositionalArgIndex === -1 || helpArgIndex <= fi
       break;
     }
     case "format": {
-      require("./rescript_format.js").main(
-        subcmdArgs,
-        rescript_exe,
-        bsc_exe
-      );
+      const mod = await import("./rescript/rescript_format.js");
+      await mod.main(subcmdArgs, rescript_exe, bsc_exe);
       break;
     }
     case "dump": {
-      require("./rescript_dump.js").main(
-        subcmdArgs,
-        rescript_exe,
-        bsc_exe
-      );
+      const mod = await import("./rescript/rescript_dump.js");
+      mod.main(subcmdArgs, rescript_exe, bsc_exe);
       break;
     }
     default: {
-      console.error(
-        `Error: Unknown command "${subcmd}".\n${helpMessage}`
-      );
+      console.error(`Error: Unknown command "${subcmd}".\n${helpMessage}`);
       process.exit(2);
     }
   }