Merge branch 'main' into doc-test-js-outuput

Author: aspeddro

CHANGELOG.md

@@ -2,9 +2,16 @@
 
 ## Next version
 
+- BREAKING: Use new native `bigint` type. This requires ReScript compiler version "11.1.0-rc.6" or higher. https://github.com/rescript-association/rescript-core/pull/207
+
+## 1.2.0
+
+- Add optional arguments to `JSON.stringify` and `JSON.parseExn` and deprecate `JSON.stringifyWithIndent`, `JSON.stringifyWithReplacer`, `JSON.parseExnWithReviver` etc. https://github.com/rescript-association/rescript-core/pull/201
+- Add `Array.join` and deprecate `Array.joinWith`. https://github.com/rescript-association/rescript-core/pull/205
 - BREAKING: Intl types: simplify bindings for constructors / functions with optional arguments. https://github.com/rescript-association/rescript-core/pull/198
 - Fix: Expose Intl.Common. https://github.com/rescript-association/rescript-core/pull/197
 - Add `Array.flatMapWithIndex` https://github.com/rescript-association/rescript-core/pull/199
+- Add `Promise.any`, `Promise.allSettled`, `Promise.withResolvers` https://github.com/rescript-association/rescript-core/pull/204
 
 ## 1.1.0
 

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "@rescript/core",
-  "version": "1.1.0",
+  "version": "1.2.0",
   "scripts": {
     "clean": "rescript clean",
     "build": "rescript",
@@ -24,11 +24,11 @@
     "src/**/*.mjs"
   ],
   "peerDependencies": {
-    "rescript": ">=11.0.0 || ^11.1.0-rc.2"
+    "rescript": "^11.1.0-rc.7"
   },
   "devDependencies": {
     "@babel/code-frame": "7.18.6",
     "@rescript/tools": "^0.5.0",
-    "rescript": "11.1.0-rc.2"
+    "rescript": "^11.1.0-rc.7"
   }
-}
+}

package.json

@@ -48,7 +48,7 @@ var bscBin = Path.join(compilerDir, "node_modules", ".bin", "bsc");
 var rescriptCoreCompiled = Path.join(compilerDir, "node_modules", "@rescript", "core", "lib", "ocaml");
 
 function makePackageJson(coreVersion) {
-  return "{\n  \"name\": \"test-compiler-examples\",\n  \"version\": \"1.0.0\",\n  \"dependencies\": {\n    \"@rescript/core\": \"file:rescript-core-" + coreVersion + ".tgz\",\n    \"rescript\": \"^11.0.1\"\n  }\n}\n";
+  return "{\n  \"name\": \"test-compiler-examples\",\n  \"version\": \"1.0.0\",\n  \"dependencies\": {\n    \"@rescript/core\": \"file:rescript-core-" + coreVersion + ".tgz\",\n    \"rescript\": \"11.1.0-rc.7\"\n  }\n}\n";
 }
 
 var rescriptJson = "{\n  \"name\": \"dummy\",\n  \"sources\": {\n    \"dir\": \"dummy\",\n    \"subdirs\": true\n  },\n  \"bs-dependencies\": [\n    \"@rescript/core\"\n  ],\n  \"bsc-flags\": [\n    \"-open RescriptCore\"\n  ]\n}";
@@ -143,7 +143,7 @@ async function compileTest(id, code) {
     "-I",
     rescriptCoreCompiled,
     "-w",
-    "-109",
+    "-3-109",
     "-uncurried",
     "-open",
     "RescriptCore"

scripts/DocTests.mjs

@@ -89,7 +89,7 @@ let makePackageJson = coreVersion =>
   "version": "1.0.0",
   "dependencies": {
     "@rescript/core": "file:rescript-core-${coreVersion}.tgz",
-    "rescript": "^11.0.1"
+    "rescript": "11.1.0-rc.7"
   }
 }
 `
@@ -163,7 +163,7 @@ let compileTest = async (~id, ~code) => {
     "-I",
     rescriptCoreCompiled,
     "-w",
-    "-109",
+    "-3-109",
     "-uncurried",
     "-open",
     "RescriptCore",
@@ -190,7 +190,7 @@ let compileTest = async (~id, ~code) => {
   | true =>
     stderr
     ->Array.map(e => e->Buffer.toString)
-    ->Array.joinWith("")
+    ->Array.join("")
     ->Error
   | false =>
     stdout
@@ -293,7 +293,7 @@ let getCodeBlocks = example => {
             code
             ->List.reverse
             ->List.toArray
-            ->Array.joinWith("\n"),
+            ->Array.join("\n"),
             ...acc,
           },
         )
@@ -359,9 +359,9 @@ let main = async () => {
         e
         ->String.split("\n")
         ->Array.filterWithIndex((_, i) => i !== 2)
-        ->Array.joinWith("\n")
+        ->Array.join("\n")
       })
-      ->Array.joinWith("\n")
+      ->Array.join("\n")
 
     let message = `${"error"->red}: failed to compile examples from ${kind} ${test.id->cyan}\n${errorMessage}`
 

scripts/DocTests.res

@@ -124,9 +124,15 @@ let indexOfOpt = (arr, item) =>
   }
 @send external indexOfFrom: (array<'a>, 'a, int) => int = "indexOf"
 
-@send external joinWith: (array<string>, string) => string = "join"
+@send external join: (array<string>, string) => string = "join"
 
-@send external joinWithUnsafe: (array<'a>, string) => string = "join"
+@deprecated("Use `join` instead") @send
+external joinWith: (array<string>, string) => string = "join"
+
+@send external joinUnsafe: (array<'a>, string) => string = "join"
+
+@deprecated("Use `joinUnsafe` instead") @send
+external joinWithUnsafe: (array<'a>, string) => string = "join"
 
 @send external lastIndexOf: (array<'a>, 'a) => int = "lastIndexOf"
 let lastIndexOfOpt = (arr, item) =>

src/Core__Array.res

@@ -397,6 +397,21 @@ Console.log([{"language": "ReScript"}]->Array.indexOfOpt({"language": "ReScript"
 let indexOfOpt: (array<'a>, 'a) => option<int>
 @send external indexOfFrom: (array<'a>, 'a, int) => int = "indexOf"
 
+/**
+`join(array, separator)` produces a string where all items of `array` are printed, separated by `separator`. Array items must be strings, to join number or other arrays, use `joinUnsafe`. Under the hood this will run JavaScript's `toString` on all the array items.
+
+See [Array.join](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/join)
+
+## Examples
+```rescript
+let array = ["One", "Two", "Three"]
+
+Console.log(array->Array.join(" -- ")) // One -- Two -- Three
+```
+*/
+@send
+external join: (array<string>, string) => string = "join"
+
 /**
 `joinWith(array, separator)` produces a string where all items of `array` are printed, separated by `separator`. Array items must be strings, to join number or other arrays, use `joinWithUnsafe`. Under the hood this will run JavaScript's `toString` on all the array items.
 
@@ -407,9 +422,25 @@ let array = ["One", "Two", "Three"]
 Console.log(array->Array.joinWith(" -- ")) // One -- Two -- Three
 ```
 */
+@deprecated("Use `join` instead")
 @send
 external joinWith: (array<string>, string) => string = "join"
 
+/**
+`joinUnsafe(array, separator)` produces a string where all items of `array` are printed, separated by `separator`. Under the hood this will run JavaScript's `toString` on all the array items.
+
+See [Array.join](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/join)
+
+## Examples
+```rescript
+let array = [1, 2, 3]
+
+Console.log(array->Array.joinUnsafe(" -- ")) // 1 -- 2 -- 3
+```
+*/
+@send
+external joinUnsafe: (array<'a>, string) => string = "join"
+
 /**
 `joinWithUnsafe(array, separator)` produces a string where all items of `array` are printed, separated by `separator`. Under the hood this will run JavaScript's `toString` on all the array items.
 
@@ -420,6 +451,7 @@ let array = [1, 2, 3]
 Console.log(array->Array.joinWithUnsafe(" -- ")) // 1 -- 2 -- 3
 ```
 */
+@deprecated("Use `joinUnsafe` instead")
 @send
 external joinWithUnsafe: (array<'a>, string) => string = "join"
 @send external lastIndexOf: (array<'a>, 'a) => int = "lastIndexOf"

src/Core__Array.resi

@@ -5,12 +5,12 @@ function toInt(t) {
   return Number(t) | 0;
 }
 
-function exp(x, y) {
-  return (x ** y);
+function lnot(x) {
+  return x ^ -1n;
 }
 
 export {
   toInt ,
-  exp ,
+  lnot ,
 }
 /* No side effect */

src/Core__BigInt.mjs

@@ -1,41 +1,95 @@
-type t = Js.Types.bigint_val
+@val external asIntN: (~width: int, bigint) => bigint = "BigInt.asIntN"
+@val external asUintN: (~width: int, bigint) => bigint = "BigInt.asUintN"
 
-@val external asIntN: (~width: int, t) => t = "BigInt.asIntN"
-@val external asUintN: (~width: int, t) => t = "BigInt.asUintN"
+@val external fromString: string => bigint = "BigInt"
 
-@val external fromString: string => t = "BigInt"
-@val external fromInt: int => t = "BigInt"
-@val external fromFloat: float => t = "BigInt"
+@val
+/**
+Parses the given `string` into a `bigint` using JavaScript semantics. Return the
+number as a `bigint` if successfully parsed. Uncaught syntax exception otherwise.
 
-@send external toString: t => string = "toString"
-@send external toStringWithRadix: (t, ~radix: int) => string = "toString"
-@send external toLocaleString: t => string = "toLocaleString"
+## Examples
 
-@val external toFloat: t => float = "Number"
+```rescript
+/* returns 123n */
+BigInt.fromStringExn("123")
+
+/* returns 0n */
+BigInt.fromStringExn("")
+
+/* returns 17n */
+BigInt.fromStringExn("0x11")
+
+/* returns 3n */
+BigInt.fromStringExn("0b11")
+
+/* returns 9n */
+BigInt.fromStringExn("0o11")
+
+/* catch exception */
+try {
+  BigInt.fromStringExn("a")
+} catch {
+| Exn.Error(_error) => 0n
+}
+```
+*/
+external fromStringExn: string => bigint = "BigInt"
+@val external fromInt: int => bigint = "BigInt"
+@val external fromFloat: float => bigint = "BigInt"
+
+@send
+/**
+Formats a `bigint` as a string. Return a `string` representing the given value.
+See [`toString`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number/toString) on MDN.
+
+## Examples
+
+```rescript
+/* prints "123" */
+Js.BigInt.toString(123n)->Js.log
+```
+*/
+external toString: bigint => string = "toString"
+@send external toStringWithRadix: (bigint, ~radix: int) => string = "toString"
+
+@send
+/**
+Returns a string with a language-sensitive representation of this BigInt value.
+
+## Examples
+
+```rescript
+/* prints "123" */
+Js.BigInt.toString(123n)->Js.log
+```
+*/
+external toLocaleString: bigint => string = "toLocaleString"
+
+@val external toFloat: bigint => float = "Number"
 
 let toInt = t => t->toFloat->Core__Int.fromFloat
 
-external \"+": (t, t) => t = "%addfloat"
-external \"-": (t, t) => t = "%subfloat"
-external \"*": (t, t) => t = "%mulfloat"
-external \"/": (t, t) => t = "%divfloat"
+external \"+": (bigint, bigint) => bigint = "%addbigint"
+external \"-": (bigint, bigint) => bigint = "%subbigint"
+external \"*": (bigint, bigint) => bigint = "%mulbigint"
+external \"/": (bigint, bigint) => bigint = "%divbigint"
+external \"~-": bigint => bigint = "%negbigint"
+external \"~+": bigint => bigint = "%identity"
+external \"**": (bigint, bigint) => bigint = "%powbigint"
 
-external add: (t, t) => t = "%addfloat"
-external sub: (t, t) => t = "%subfloat"
-external mul: (t, t) => t = "%mulfloat"
-external div: (t, t) => t = "%divfloat"
+external add: (bigint, bigint) => bigint = "%addfloat"
+external sub: (bigint, bigint) => bigint = "%subfloat"
+external mul: (bigint, bigint) => bigint = "%mulfloat"
+external div: (bigint, bigint) => bigint = "%divfloat"
 
-@noalloc external mod: (t, t) => t = "?fmod_float"
+external mod: (bigint, bigint) => bigint = "%modbigint"
 
-external land: (t, t) => t = "%andint"
-external lor: (t, t) => t = "%orint"
-external lxor: (t, t) => t = "%xorint"
+external land: (bigint, bigint) => bigint = "%andbigint"
+external lor: (bigint, bigint) => bigint = "%orbigint"
+external lxor: (bigint, bigint) => bigint = "%xorbigint"
 
-external lsl: (t, t) => t = "%lslint"
-external asr: (t, t) => t = "%asrint"
+external lsl: (bigint, bigint) => bigint = "%lslbigint"
+external asr: (bigint, bigint) => bigint = "%asrbigint"
 
-let exp = (x: t, y: t) => {
-  let _ = x
-  let _ = y
-  %raw(`x ** y`)
-}
+let lnot = x => lxor(x, -1n)

src/Core__BigInt.res

@@ -20,8 +20,8 @@ external fromBufferWithRange: (Core__ArrayBuffer.t, ~byteOffset: int, ~length: i
 @send external getFloat32: t => float = "getFloat32"
 @send external getFloat64: t => float = "getFloat64"
 
-@send external getBigInt64: t => Core__BigInt.t = "getBigInt64"
-@send external getBigUint64: t => Core__BigInt.t = "getBigUint64"
+@send external getBigInt64: t => bigint = "getBigInt64"
+@send external getBigUint64: t => bigint = "getBigUint64"
 
 @send external setInt8: (t, int) => unit = "setInt8"
 @send external setUint8: (t, int) => unit = "setUint8"
@@ -33,5 +33,5 @@ external fromBufferWithRange: (Core__ArrayBuffer.t, ~byteOffset: int, ~length: i
 @send external setFloat32: (t, float) => unit = "setFloat32"
 @send external setFloat64: (t, float) => unit = "setFloat64"
 
-@send external setBigInt64: (t, Core__BigInt.t) => unit = "setBigInt64"
-@send external setBigUint64: (t, Core__BigInt.t) => unit = "setBigUint64"
+@send external setBigInt64: (t, bigint) => unit = "setBigInt64"
+@send external setBigUint64: (t, bigint) => unit = "setBigUint64"