Override module type for CommonJS runtime (#8194)

* Explicitly add type commonjs for commonjs runtime

* Update artifacts.json

* Remove es6 package.json because it's already the default

* Update CHANGELOG

* WIP: Add tests

* commit yarn.lock

* Update CHANGELOG.md

Co-authored-by: Christoph Knittel <christoph@knittel.cc>

---------

Co-authored-by: Christoph Knittel <christoph@knittel.cc>

Author: shulhi

CHANGELOG.md

@@ -34,6 +34,7 @@
 - Reanalyze: fix reactive/server stale results when cross-file references change without changing dead declarations (non-transitive mode). https://github.com/rescript-lang/rescript/pull/8173
 - Add duplicate package detection to rewatch. https://github.com/rescript-lang/rescript/pull/8180
 - Rewatch: do not warn about "reanalyze" config field. https://github.com/rescript-lang/rescript/pull/8181
+- Fix error when importing CommonJS runtime modules with `require()`. https://github.com/rescript-lang/rescript/pull/8194
 
 #### :memo: Documentation
 

biome.json

@@ -55,6 +55,7 @@
       "!**/.yarn",
       "!**/tests/analysis_tests/**/src",
       "!**/tests/build_tests/**/src",
+      "!**/tests/commonjs_tests/src",
       "!**/tests/docstring_tests",
       "!**/tests/gentype_tests",
       "**/tests/gentype_tests/typescript-react-example/**",

lib_dev/paths.js

@@ -52,6 +52,11 @@ export const buildTestDir = path.resolve(testDir, "build_tests");
  */
 export const docstringTestDir = path.resolve(testDir, "docstring_tests");
 
+/**
+ * path: `<projectDir>/tests/commonjs_tests/`
+ */
+export const commonjsTestDir = path.resolve(testDir, "commonjs_tests");
+
 /**
  * path: `<projectDir>/compiler/common/bs_version.ml`
  */

package.json

@@ -103,6 +103,7 @@
     "tests/docstring_tests",
     "tests/gentype_tests/**",
     "tests/tools_tests",
+    "tests/commonjs_tests",
     "scripts/res"
   ],
   "packageManager": "yarn@4.12.0",

packages/@rescript/runtime/lib/es6/package.json

@@ -0,0 +1 @@
+{"type" : "commonjs"}

packages/@rescript/runtime/lib/js/package.json

@@ -191,7 +191,6 @@
     "lib/es6/Stdlib_Uint8ClampedArray.js",
     "lib/es6/Stdlib_WeakMap.js",
     "lib/es6/Stdlib_WeakSet.js",
-    "lib/es6/package.json",
     "lib/js/Belt.js",
     "lib/js/Belt_Array.js",
     "lib/js/Belt_Float.js",
@@ -366,6 +365,7 @@
     "lib/js/Stdlib_Uint8ClampedArray.js",
     "lib/js/Stdlib_WeakMap.js",
     "lib/js/Stdlib_WeakSet.js",
+    "lib/js/package.json",
     "lib/ocaml/Belt.cmi",
     "lib/ocaml/Belt.cmj",
     "lib/ocaml/Belt.cmt",

packages/artifacts.json

@@ -106,6 +106,18 @@ if (mochaTest) {
     cwd: projectDir,
     stdio: "inherit",
   });
+
+  // CommonJS tests
+  const commonjsTestDir = path.join(projectDir, "tests/commonjs_tests");
+  await execBuild([], {
+    cwd: commonjsTestDir,
+    stdio: "inherit",
+  });
+
+  await node("tests/commonjs_tests/src/belt_import.js", [], {
+    cwd: projectDir,
+    stdio: "inherit",
+  });
 }
 
 if (buildTest) {

scripts/test.js

@@ -0,0 +1,4 @@
+{
+  "name": "rescript-commonjs-tests",
+  "type": "commonjs"
+}

tests/commonjs_tests/package.json

@@ -0,0 +1,18 @@
+{
+  "name": "rescript-commonjs-tests",
+  "sources": [
+    {
+      "dir": "src",
+      "subdirs": true
+    }
+  ],
+  "package-specs": {
+    "module": "commonjs",
+    "in-source": true,
+    "suffix": ".js"
+  },
+  "compiler-flags": [
+    "-w -3-6-26-27-29-30-32..40-44-45-52-60-9-106+104",
+    "-warn-error A"
+  ]
+}