Merge pull request #388 from ocsigen/rescript/use-core

rescript: use Core instead of Js
ocsigen · Feb 27, 2024 · 0559bef · 0559bef
2 parents 2858aa5 + 0e036c0
commit 0559bef
Show file tree

Hide file tree

Showing 17 changed files with 256 additions and 131 deletions.
diff --git a/dist/res/package.json b/dist/res/package.json
@@ -12,9 +12,11 @@
   "author": "",
   "license": "Apache-2.0",
   "devDependencies": {
+    "@rescript/core": "^1.1.0",
     "rescript": "11.0.1"
   },
   "peerDependencies": {
+    "@rescript/core": "1.1.0",
     "rescript": "^11.0.1"
   }
 }
diff --git a/dist/res/rescript.json b/dist/res/rescript.json
@@ -11,6 +11,7 @@
   },
   "suffix": ".bs.js",
   "bs-dependencies": [
+    "@rescript/core"
   ],
   "warnings": {
     "error" : "+101"

diff --git a/dist/res/src/ts2ocaml.res b/dist/res/src/ts2ocaml.res
diff --git a/dist/res/yarn.lock b/dist/res/yarn.lock
@@ -2,6 +2,11 @@
 # yarn lockfile v1
 
 
+"@rescript/core@^1.1.0":
+  version "1.1.0"
+  resolved "https://registry.yarnpkg.com/@rescript/core/-/core-1.1.0.tgz#e228a2635665b6b6a3288f7fd58552d5c361e253"
+  integrity sha512-pz/CL8+9hBUTeMpUouvZohNsa5rqIwurlXoa1CZWN0ZKuWjMVjaoQ3V+0NB72J/QBbs6/8W82VABKBaDn3fGCA==
+
 [email protected]:
   version "11.0.1"
   resolved "https://registry.yarnpkg.com/rescript/-/rescript-11.0.1.tgz#c74af134dc8a16d152169b2456d0720324835f54"

diff --git a/docs/rescript.md b/docs/rescript.md
@@ -1,5 +1,5 @@
 > **Note:** ReScript support is currently available in `2.0.0-beta.0` or later.
-> 
+>
 > Please install it with `npm install -g @ocsigen/ts2ocaml@beta`.
 
 # ts2ocaml for ReScript
@@ -18,6 +18,20 @@ The documentation for the `ts2ocaml` command and its options comes after the wal
 
 `ts2ocaml` targets ReScript v11 or later.
 
+Also, `ts2ocaml` depends on ReScript's new standard library `Core`.
+You may need to add `@rescript/core` to your project dependencies (`dependencies` in `package.json` and `bs-dependencies` in `rescript.json`).
+Please see [ReScript's official documentation](https://rescript-lang.org/docs/manual/latest/api) for details.
+
+> Every code generated by `ts2ocaml` explicitly opens `RescriptCore`, so you don't have to set
+>
+> ```json
+> "bsc-flags": [
+>   "-open RescriptCore"
+> ]
+> ```
+>
+> in your `rescript.json`.
+
 ## Adding `ts2ocaml.res`
 
 ReScript has a rich standard library to use JS and DOM APIs and `ts2ocaml` makes use of it as much as possible. In addition to that, `ts2ocaml` uses a small standard library to handle some TypeScript-specific concepts:
@@ -82,7 +96,7 @@ let result = Ts.transpileModule(
   ),
 )
 
-Js.log(result->Ts.TranspileOutput.get_outputText)
+Console.log(result->Ts.TranspileOutput.get_outputText)
 ```
 
 # Conventions

diff --git a/src/Targets/ReScript/ReScriptHelper.fs b/src/Targets/ReScript/ReScriptHelper.fs
@@ -220,16 +220,18 @@ module Type =
   /// non-primitive types defined in the standard library
   let predefinedTypes =
     let builtins = [
-      "RegExp", ("Re.t", 0)
+      "RegExp", ("RegExp.t", 0)
       "PromiseLike", ("Promise.t", 1)
       "Array", ("array", 1)
-      "ArrayLike", ("Array2.array_like", 1)
+      "ArrayLike", ("Js.Array2.array_like", 1)
+      "Iterable", ("Js.Array2.array_like", 1)
       "ReadonlyArray", ("array", 1)
-      "ArrayBuffer", ("TypedArray2.ArrayBuffer.t", 0)
-      "Error", ("Exn.t", 0)
+      "ArrayBuffer", ("ArrayBuffer.t", 0)
+      "Error", ("Error.t", 0)
+      "ReadonlyMap", ("Map.t", 2)
     ]
     let typedArrays =
-      let typedArray name = name, (sprintf "TypedArray2.%s.t" name, 0)
+      let typedArray name = name, (sprintf "%s.t" name, 0)
       [
         typedArray "DataView"
         typedArray "Int8Array"
@@ -330,12 +332,12 @@ module Type =
 
   // JS types
   // ES5
-  let object = str "untypedObject"
-  let function_ = str "untypedFunction"
-  let symbol = str "symbol"
-  let regexp = str "Re.t"
+  let object = str "object"
+  let function_ = str "function"
+  let symbol = str "Symbol.t"
+  let regexp = str "RegExp.t"
   // ES2020
-  let bigint = str "Bigint.t"
+  let bigint = str "BigInt.t"
 
   // TS types
   let never = str "never"

diff --git a/src/Targets/ReScript/Writer.fs b/src/Targets/ReScript/Writer.fs
@@ -2102,7 +2102,7 @@ let private emitImpl (sources: SourceFile list) (info: PackageInfo option) (ctx:
   let m = emitModule dt flags ctx st
 
   let opens = [
-    yield Statement.open_ "Js"
+    yield Statement.open_ "RescriptCore"
     yield Statement.open_ "Ts2ocaml"
     for src in sources do
       yield! emitReferenceTypeDirectives ctx src

diff --git a/test/res/package.json b/test/res/package.json
@@ -15,6 +15,7 @@
     "@ocsigen/ts2ocaml": "link:../../"
   },
   "dependencies": {
+    "@rescript/core": "^1.1.0",
     "rescript": "11.0.1"
   }
 }
diff --git a/test/res/rescript.json b/test/res/rescript.json
@@ -10,5 +10,8 @@
     "in-source": true
   },
   "suffix": ".bs.js",
+  "bs-dependencies": [
+    "@rescript/core"
+  ],
   "uncurried": true
 }
diff --git a/test/res/src/main.res b/test/res/src/main.res
@@ -1,3 +1,5 @@
+open RescriptCore
+
 module Ts = Typescript.Export
 
 let source = "let x: string = 'hello, world!'"
@@ -9,4 +11,4 @@ let result = Ts.transpileModule(
   ),
 )
 
-Js.log(result->Ts.TranspileOutput.get_outputText)
+Console.log(result->Ts.TranspileOutput.get_outputText)
diff --git a/test/res/src/placeholders/Iterable.res b/test/res/src/placeholders/Iterable.res
diff --git a/test/res/src/placeholders/Map.res b/test/res/src/placeholders/Map.res
diff --git a/test/res/src/placeholders/ReadonlyMap.res b/test/res/src/placeholders/ReadonlyMap.res
diff --git a/test/res/src/placeholders/Set.res b/test/res/src/placeholders/Set.res
diff --git a/test/res/src/placeholders/WeakMap.res b/test/res/src/placeholders/WeakMap.res
diff --git a/test/res/src/placeholders/WeakSet.res b/test/res/src/placeholders/WeakSet.res
diff --git a/test/res/yarn.lock b/test/res/yarn.lock
@@ -27,6 +27,11 @@
   version "0.0.0"
   uid ""
 
+"@rescript/core@^1.1.0":
+  version "1.1.0"
+  resolved "https://registry.yarnpkg.com/@rescript/core/-/core-1.1.0.tgz#e228a2635665b6b6a3288f7fd58552d5c361e253"
+  integrity sha512-pz/CL8+9hBUTeMpUouvZohNsa5rqIwurlXoa1CZWN0ZKuWjMVjaoQ3V+0NB72J/QBbs6/8W82VABKBaDn3fGCA==
+
 ansi-regex@^5.0.1:
   version "5.0.1"
   resolved "https://registry.yarnpkg.com/ansi-regex/-/ansi-regex-5.0.1.tgz#082cb2c89c9fe8659a311a53bd6a4dc5301db304"