Rename Belt functions from Exn to OrThrow (#7581)

* Add Belt.Array.getOrThrow and setOrThrow

* Add Belt.Map.getOrThrow and Belt.MutableMap.getOrThrow

* Add Belt.Set.getOrThrow and Belt.MutableSet.getOrThrow

* Exclude rewatch from biome checks

* Add Belt.List.getOrThrow, headOrThrow and tailOrThrow

* Add Belt.MutableQueue.peekOrThrow and popOrThrow

* Add Belt.Option.getOrThrow

* Add Belt.Result.getOrThrow

* Update runtime JS output

* Add xxxOrThrow functions to specialised Belt Map and Set data structures

* Update CHANGELOG entries to be in alpha 15 instead of alpha 14

Author: mediremi

CHANGELOG.md

@@ -15,6 +15,21 @@
 #### :boom: Breaking Change
 
 - The legacy rescript cli can be called through rewatch via `rewatch legacy`. Arguments to rewatch need to be passed after the subcommand. Argument `--compiler-args` is now a subcommand `compiler-args`. https://github.com/rescript-lang/rescript/pull/7551
+- Rename `Belt` functions ending with `Exn` to end with `OrThrow` https://github.com/rescript-lang/rescript/pull/7581 The following `Exn` functions are now deprecated:
+  - `Belt.Array.getExn` → `Belt.Array.getOrThrow`
+  - `Belt.Array.setExn` → `Belt.Array.setOrThrow`
+  - `Belt.Map.getExn` → `Belt.Map.getOrThrow`
+  - `Belt.MutableMap.getExn` → `Belt.MutableMap.getOrThrow`
+  - `Belt.Set.getExn` → `Belt.Set.getOrThrow`
+  - `Belt.MutableSet.getExn` → `Belt.MutableSet.getOrThrow`
+  - `Belt.List.getExn` → `Belt.List.getOrThrow`
+  - `Belt.List.tailExn` → `Belt.List.tailOrThrow`
+  - `Belt.List.headExn` → `Belt.List.headOrThrow`
+  - `Belt.MutableQueue.peekExn` → `Belt.MutableQueue.peekOrThrow`
+  - `Belt.MutableQueue.popExn` → `Belt.MutableQueue.popOrThrow`
+  - `Belt.Option.getExn` → `Belt.Option.getOrThrow`
+  - `Belt.Result.getExn` → `Belt.Result.getOrThrow`
+  - Old functions remain available but are marked as deprecated with guidance to use the new `OrThrow` variants.
 
 #### :bug: Bug fix
 

analysis/reanalyze/src/ExnLib.ml

@@ -1,17 +1,38 @@
 let raisesLibTable : (Name.t, Exceptions.t) Hashtbl.t =
   let table = Hashtbl.create 15 in
   let open Exn in
-  let beltArray = [("getExn", [assertFailure]); ("setExn", [assertFailure])] in
+  let beltArray =
+    [
+      ("getExn", [assertFailure]);
+      ("getOrThrow", [assertFailure]);
+      ("setExn", [assertFailure]);
+      ("setOrThrow", [assertFailure]);
+    ]
+  in
   let beltList =
-    [("getExn", [notFound]); ("headExn", [notFound]); ("tailExn", [notFound])]
+    [
+      ("getExn", [notFound]);
+      ("getOrThrow", [notFound]);
+      ("headExn", [notFound]);
+      ("headOrThrow", [notFound]);
+      ("tailExn", [notFound]);
+      ("tailOrThrow", [notFound]);
+    ]
   in
-  let beltMap = [("getExn", [notFound])] in
+  let beltMap = [("getExn", [notFound]); ("getOrThrow", [notFound])] in
   let beltMutableMap = beltMap in
-  let beltMutableQueue = [("peekExn", [notFound]); ("popExn", [notFound])] in
-  let beltMutableSet = [("getExn", [notFound])] in
-  let beltOption = [("getExn", [notFound])] in
-  let beltResult = [("getExn", [notFound])] in
-  let beltSet = [("getExn", [notFound])] in
+  let beltMutableQueue =
+    [
+      ("peekExn", [notFound]);
+      ("peekOrThrow", [notFound]);
+      ("popExn", [notFound]);
+      ("popOrThrow", [notFound]);
+    ]
+  in
+  let beltSet = [("getExn", [notFound]); ("getOrThrow", [notFound])] in
+  let beltMutableSet = beltSet in
+  let beltOption = [("getExn", [notFound]); ("getOrThrow", [notFound])] in
+  let beltResult = [("getExn", [notFound]); ("getOrThrow", [notFound])] in
   let bsJson =
     (* bs-json *)
     [

biome.json

@@ -62,6 +62,7 @@
       "tests/tests/**/src/**",
       "tests/tools_tests/**/src/**",
       "analysis/examples/**/src/**",
+      "rewatch/**",
       "lib/es6/**",
       "lib/js/**",
       "ninja/**",

lib/es6/Belt_Array.js

@@ -10,7 +10,7 @@ function get(arr, i) {
 
 }
 
-function getExn(arr, i) {
+function getOrThrow(arr, i) {
   if (!(i >= 0 && i < arr.length)) {
     throw {
       RE_EXN_ID: "Assert_failure",
@@ -34,13 +34,13 @@ function set(arr, i, v) {
   }
 }
 
-function setExn(arr, i, v) {
+function setOrThrow(arr, i, v) {
   if (!(i >= 0 && i < arr.length)) {
     throw {
       RE_EXN_ID: "Assert_failure",
       _1: [
         "Belt_Array.res",
-        49,
+        51,
         2
       ],
       Error: new Error()
@@ -582,6 +582,10 @@ function init(n, f) {
   return v;
 }
 
+let getExn = getOrThrow;
+
+let setExn = setOrThrow;
+
 let makeByU = makeBy;
 
 let makeByAndShuffleU = makeByAndShuffle;
@@ -637,8 +641,10 @@ let initU = init;
 export {
   get,
   getExn,
+  getOrThrow,
   set,
   setExn,
+  setOrThrow,
   shuffleInPlace,
   shuffle,
   reverseInPlace,

lib/es6/Belt_List.js

@@ -11,7 +11,7 @@ function head(x) {
 
 }
 
-function headExn(x) {
+function headOrThrow(x) {
   if (x !== 0) {
     return x.hd;
   }
@@ -28,7 +28,7 @@ function tail(x) {
 
 }
 
-function tailExn(x) {
+function tailOrThrow(x) {
   if (x !== 0) {
     return x.tl;
   }
@@ -67,7 +67,7 @@ function get(x, n) {
   }
 }
 
-function getExn(x, n) {
+function getOrThrow(x, n) {
   if (n < 0) {
     throw {
       RE_EXN_ID: "Not_found",
@@ -1286,6 +1286,12 @@ function zip(l1, l2) {
 
 let size = length;
 
+let headExn = headOrThrow;
+
+let tailExn = tailOrThrow;
+
+let getExn = getOrThrow;
+
 let makeByU = makeBy;
 
 let mapU = map;
@@ -1357,11 +1363,14 @@ export {
   size,
   head,
   headExn,
+  headOrThrow,
   tail,
   tailExn,
+  tailOrThrow,
   add,
   get,
   getExn,
+  getOrThrow,
   make,
   makeByU,
   makeBy,

lib/es6/Belt_Map.js

@@ -215,8 +215,8 @@ function getWithDefault(map, x, def) {
   return Belt_MapDict.getWithDefault(map.data, x, def, map.cmp);
 }
 
-function getExn(map, x) {
-  return Belt_MapDict.getExn(map.data, x, map.cmp);
+function getOrThrow(map, x) {
+  return Belt_MapDict.getOrThrow(map.data, x, map.cmp);
 }
 
 function has(map, x) {
@@ -273,6 +273,8 @@ let everyU = every;
 
 let someU = some;
 
+let getExn = getOrThrow;
+
 let updateU = update;
 
 let mergeU = merge;
@@ -324,6 +326,7 @@ export {
   getUndefined,
   getWithDefault,
   getExn,
+  getOrThrow,
   remove,
   removeMany,
   set,

lib/es6/Belt_MapDict.js

@@ -326,7 +326,9 @@ let getUndefined = Belt_internalAVLtree.getUndefined;
 
 let getWithDefault = Belt_internalAVLtree.getWithDefault;
 
-let getExn = Belt_internalAVLtree.getExn;
+let getExn = Belt_internalAVLtree.getOrThrow;
+
+let getOrThrow = Belt_internalAVLtree.getOrThrow;
 
 let checkInvariantInternal = Belt_internalAVLtree.checkInvariantInternal;
 
@@ -386,6 +388,7 @@ export {
   getUndefined,
   getWithDefault,
   getExn,
+  getOrThrow,
   checkInvariantInternal,
   remove,
   removeMany,

lib/es6/Belt_MapInt.js

@@ -218,7 +218,9 @@ let getUndefined = Belt_internalMapInt.getUndefined;
 
 let getWithDefault = Belt_internalMapInt.getWithDefault;
 
-let getExn = Belt_internalMapInt.getExn;
+let getExn = Belt_internalMapInt.getOrThrow;
+
+let getOrThrow = Belt_internalMapInt.getOrThrow;
 
 let checkInvariantInternal = Belt_internalAVLtree.checkInvariantInternal;
 
@@ -282,6 +284,7 @@ export {
   getUndefined,
   getWithDefault,
   getExn,
+  getOrThrow,
   checkInvariantInternal,
   remove,
   removeMany,

lib/es6/Belt_MapString.js

@@ -218,7 +218,9 @@ let getUndefined = Belt_internalMapString.getUndefined;
 
 let getWithDefault = Belt_internalMapString.getWithDefault;
 
-let getExn = Belt_internalMapString.getExn;
+let getExn = Belt_internalMapString.getOrThrow;
+
+let getOrThrow = Belt_internalMapString.getOrThrow;
 
 let checkInvariantInternal = Belt_internalAVLtree.checkInvariantInternal;
 
@@ -282,6 +284,7 @@ export {
   getUndefined,
   getWithDefault,
   getExn,
+  getOrThrow,
   checkInvariantInternal,
   remove,
   removeMany,

lib/es6/Belt_MutableMap.js

@@ -257,8 +257,8 @@ function getWithDefault(m, x, def) {
   return Belt_internalAVLtree.getWithDefault(m.data, x, def, m.cmp);
 }
 
-function getExn(m, x) {
-  return Belt_internalAVLtree.getExn(m.data, x, m.cmp);
+function getOrThrow(m, x) {
+  return Belt_internalAVLtree.getOrThrow(m.data, x, m.cmp);
 }
 
 function has(m, x) {
@@ -318,6 +318,8 @@ let everyU = every;
 
 let someU = some;
 
+let getExn = getOrThrow;
+
 let updateU = update;
 
 let mapU = map;
@@ -361,6 +363,7 @@ export {
   getUndefined,
   getWithDefault,
   getExn,
+  getOrThrow,
   checkInvariantInternal,
   remove,
   removeMany,

lib/es6/Belt_MutableMapInt.js

@@ -272,8 +272,8 @@ function getWithDefault(d, x, def) {
   return Belt_internalMapInt.getWithDefault(d.data, x, def);
 }
 
-function getExn(d, x) {
-  return Belt_internalMapInt.getExn(d.data, x);
+function getOrThrow(d, x) {
+  return Belt_internalMapInt.getOrThrow(d.data, x);
 }
 
 let cmpU = cmp;
@@ -288,6 +288,8 @@ let everyU = every;
 
 let someU = some;
 
+let getExn = getOrThrow;
+
 let updateU = update;
 
 let mapU = map;
@@ -329,6 +331,7 @@ export {
   getUndefined,
   getWithDefault,
   getExn,
+  getOrThrow,
   checkInvariantInternal,
   remove,
   removeMany,

lib/es6/Belt_MutableMapString.js

@@ -272,8 +272,8 @@ function getWithDefault(d, x, def) {
   return Belt_internalMapString.getWithDefault(d.data, x, def);
 }
 
-function getExn(d, x) {
-  return Belt_internalMapString.getExn(d.data, x);
+function getOrThrow(d, x) {
+  return Belt_internalMapString.getOrThrow(d.data, x);
 }
 
 let cmpU = cmp;
@@ -288,6 +288,8 @@ let everyU = every;
 
 let someU = some;
 
+let getExn = getOrThrow;
+
 let updateU = update;
 
 let mapU = map;
@@ -329,6 +331,7 @@ export {
   getUndefined,
   getWithDefault,
   getExn,
+  getOrThrow,
   checkInvariantInternal,
   remove,
   removeMany,

lib/es6/Belt_MutableQueue.js

@@ -49,7 +49,7 @@ function peekUndefined(q) {
 
 }
 
-function peekExn(q) {
+function peekOrThrow(q) {
   let v = q.first;
   if (v !== undefined) {
     return v.content;
@@ -76,7 +76,7 @@ function pop(q) {
   }
 }
 
-function popExn(q) {
+function popOrThrow(q) {
   let x = q.first;
   if (x !== undefined) {
     let next = x.next;
@@ -260,6 +260,10 @@ function fromArray(arr) {
   return q;
 }
 
+let peekExn = peekOrThrow;
+
+let popExn = popOrThrow;
+
 let mapU = map;
 
 let forEachU = forEach;
@@ -275,9 +279,11 @@ export {
   peek,
   peekUndefined,
   peekExn,
+  peekOrThrow,
   pop,
   popUndefined,
   popExn,
+  popOrThrow,
   copy,
   size,
   mapU,