Fix tests and add changelog

DZakh · DZakh · commit 43e5c68af34a · 2025-06-16T19:33:21.000+04:00
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -20,7 +20,15 @@
   - `JSON.parseExn` → `JSON.parseOrThrow`
   - Changed `BigInt.fromFloat` to return an option rather than throwing an error.
   - Added `BigInt.fromFloatOrThrow`
+  - `Option.getExn` → `Option.getOrThrow`
+  - `Null.getExn` → `Null.getOrThrow`
+  - `Nullable.getExn` → `Nullable.getOrThrow`
+  - `Result.getExn` → `Result.getOrThrow`
+  - `List.getExn` → `List.getOrThrow`
+  - `List.tailExn` → `List.tailOrThrow`
+  - `List.headExn` → `List.headOrThrow`
   - Old functions remain available but are marked as deprecated with guidance to use the new `OrThrow` variants.
+  - https://github.com/rescript-lang/rescript/pull/7518, https://github.com/rescript-lang/rescript/pull/7554
 
 #### :rocket: New Feature
 
diff --git a/lib/es6/Stdlib_List.js b/lib/es6/Stdlib_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",
@@ -1298,18 +1298,27 @@ function zip(l1, l2) {
 
 let size = length;
 
+let headExn = headOrThrow;
+
+let tailExn = tailOrThrow;
+
+let getExn = getOrThrow;
+
 let toShuffled = shuffle;
 
 export {
   length,
   size,
   head,
   headExn,
+  headOrThrow,
   tail,
   tailExn,
+  tailOrThrow,
   add,
   get,
   getExn,
+  getOrThrow,
   make,
   fromInitializer,
   shuffle,
diff --git a/lib/es6/Stdlib_Null.js b/lib/es6/Stdlib_Null.js
@@ -27,13 +27,13 @@ function getOr(value, $$default) {
   }
 }
 
-function getExn(value) {
+function getOrThrow(value) {
   if (value !== null) {
     return value;
   }
   throw {
     RE_EXN_ID: "Invalid_argument",
-    _1: "Null.getExn: value is null",
+    _1: "Null.getOrThrow: value is null",
     Error: new Error()
   };
 }
@@ -71,6 +71,8 @@ function flatMap(value, f) {
 
 let getWithDefault = getOr;
 
+let getExn = getOrThrow;
+
 let mapWithDefault = mapOr;
 
 export {
@@ -80,6 +82,7 @@ export {
   getOr,
   getWithDefault,
   getExn,
+  getOrThrow,
   forEach,
   map,
   mapOr,
diff --git a/lib/es6/Stdlib_Nullable.js b/lib/es6/Stdlib_Nullable.js
@@ -26,13 +26,13 @@ function getOr(value, $$default) {
   }
 }
 
-function getExn(value) {
+function getOrThrow(value) {
   if (!(value == null)) {
     return value;
   }
   throw {
     RE_EXN_ID: "Invalid_argument",
-    _1: "Nullable.getExn: value is null or undefined",
+    _1: "Nullable.getOrThrow: value is null or undefined",
     Error: new Error()
   };
 }
@@ -70,6 +70,8 @@ function flatMap(value, f) {
 
 let getWithDefault = getOr;
 
+let getExn = getOrThrow;
+
 let mapWithDefault = mapOr;
 
 export {
@@ -79,6 +81,7 @@ export {
   getOr,
   getWithDefault,
   getExn,
+  getOrThrow,
   forEach,
   map,
   mapOr,
diff --git a/lib/es6/Stdlib_Option.js b/lib/es6/Stdlib_Option.js
@@ -17,11 +17,11 @@ function forEach(opt, f) {
   
 }
 
-function getExn(x, message) {
+function getOrThrow(x, message) {
   if (x !== undefined) {
     return Primitive_option.valFromOption(x);
   } else {
-    return Stdlib_Error.panic(message !== undefined ? message : "Option.getExn called for None value");
+    return Stdlib_Error.panic(message !== undefined ? message : "Option.getOrThrow called for None value");
   }
 }
 
@@ -197,6 +197,8 @@ function all6(param) {
   
 }
 
+let getExn = getOrThrow;
+
 let mapWithDefault = mapOr;
 
 let getWithDefault = getOr;
@@ -205,6 +207,7 @@ export {
   filter,
   forEach,
   getExn,
+  getOrThrow,
   mapOr,
   mapWithDefault,
   map,
diff --git a/lib/js/Stdlib_List.js b/lib/js/Stdlib_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",
@@ -1298,17 +1298,26 @@ function zip(l1, l2) {
 
 let size = length;
 
+let headExn = headOrThrow;
+
+let tailExn = tailOrThrow;
+
+let getExn = getOrThrow;
+
 let toShuffled = shuffle;
 
 exports.length = length;
 exports.size = size;
 exports.head = head;
 exports.headExn = headExn;
+exports.headOrThrow = headOrThrow;
 exports.tail = tail;
 exports.tailExn = tailExn;
+exports.tailOrThrow = tailOrThrow;
 exports.add = add;
 exports.get = get;
 exports.getExn = getExn;
+exports.getOrThrow = getOrThrow;
 exports.make = make;
 exports.fromInitializer = fromInitializer;
 exports.shuffle = shuffle;
diff --git a/lib/js/Stdlib_Null.js b/lib/js/Stdlib_Null.js
@@ -27,13 +27,13 @@ function getOr(value, $$default) {
   }
 }
 
-function getExn(value) {
+function getOrThrow(value) {
   if (value !== null) {
     return value;
   }
   throw {
     RE_EXN_ID: "Invalid_argument",
-    _1: "Null.getExn: value is null",
+    _1: "Null.getOrThrow: value is null",
     Error: new Error()
   };
 }
@@ -71,6 +71,8 @@ function flatMap(value, f) {
 
 let getWithDefault = getOr;
 
+let getExn = getOrThrow;
+
 let mapWithDefault = mapOr;
 
 exports.equal = equal;
@@ -79,6 +81,7 @@ exports.fromOption = fromOption;
 exports.getOr = getOr;
 exports.getWithDefault = getWithDefault;
 exports.getExn = getExn;
+exports.getOrThrow = getOrThrow;
 exports.forEach = forEach;
 exports.map = map;
 exports.mapOr = mapOr;
diff --git a/lib/js/Stdlib_Nullable.js b/lib/js/Stdlib_Nullable.js
@@ -26,13 +26,13 @@ function getOr(value, $$default) {
   }
 }
 
-function getExn(value) {
+function getOrThrow(value) {
   if (!(value == null)) {
     return value;
   }
   throw {
     RE_EXN_ID: "Invalid_argument",
-    _1: "Nullable.getExn: value is null or undefined",
+    _1: "Nullable.getOrThrow: value is null or undefined",
     Error: new Error()
   };
 }
@@ -70,6 +70,8 @@ function flatMap(value, f) {
 
 let getWithDefault = getOr;
 
+let getExn = getOrThrow;
+
 let mapWithDefault = mapOr;
 
 exports.equal = equal;
@@ -78,6 +80,7 @@ exports.fromOption = fromOption;
 exports.getOr = getOr;
 exports.getWithDefault = getWithDefault;
 exports.getExn = getExn;
+exports.getOrThrow = getOrThrow;
 exports.forEach = forEach;
 exports.map = map;
 exports.mapOr = mapOr;
diff --git a/lib/js/Stdlib_Option.js b/lib/js/Stdlib_Option.js
@@ -17,11 +17,11 @@ function forEach(opt, f) {
   
 }
 
-function getExn(x, message) {
+function getOrThrow(x, message) {
   if (x !== undefined) {
     return Primitive_option.valFromOption(x);
   } else {
-    return Stdlib_Error.panic(message !== undefined ? message : "Option.getExn called for None value");
+    return Stdlib_Error.panic(message !== undefined ? message : "Option.getOrThrow called for None value");
   }
 }
 
@@ -197,13 +197,16 @@ function all6(param) {
   
 }
 
+let getExn = getOrThrow;
+
 let mapWithDefault = mapOr;
 
 let getWithDefault = getOr;
 
 exports.filter = filter;
 exports.forEach = forEach;
 exports.getExn = getExn;
+exports.getOrThrow = getOrThrow;
 exports.mapOr = mapOr;
 exports.mapWithDefault = mapWithDefault;
 exports.map = map;
diff --git a/runtime/Stdlib_List.resi b/runtime/Stdlib_List.resi
@@ -149,18 +149,22 @@ switch List.tailExn(list{}) {
 let tailExn: list<'a> => list<'a>
 
 /**
-  `tailOrThrow(list)` same as [`tail`](#tail).
-  Raises an Error if list is empty.
+`tailOrThrow(list)` same as [`tail`](#tail).
 
-  ## Examples
-  ```res
-  List.tailOrThrow(list{1, 2, 3})->assertEqual(list{2, 3})
+## Examples
+
+```rescript
+List.tailOrThrow(list{1, 2, 3})->assertEqual(list{2, 3})
 
-  switch List.tailOrThrow(list{}) {
-  | _ => Console.log("never happens")
-  | exception _ => Console.log("error")
-  }
-  ```
+switch List.tailOrThrow(list{}) {
+| exception Not_found => assert(true)
+| _ => assert(false)
+}
+```
+
+## Exceptions
+
+- Raises an Error if list is empty.
 */
 let tailOrThrow: list<'a> => list<'a>
 
@@ -219,19 +223,26 @@ switch abc->List.getExn(4) {
 let getExn: (list<'a>, int) => 'a
 
 /**
-  `getOrThrow(list, index)` same as [`get`](#get).
-  Raises an Error if `index` is larger than the length of list.
+`getOrThrow(list, index)` same as [`get`](#get).
+
+## Examples
 
-  ## Examples
-  ```res
-  let abc = list{"A", "B", "C"}
-  abc->List.getOrThrow(1)->assertEqual("B")
+```rescript
+let abc = list{"A", "B", "C"}
 
-  switch abc->List.getOrThrow(4) {
-  | _ => Console.log("never happens")
-  | exception _ => Console.log("error")
-  }
-  ```
+abc
+->List.getOrThrow(1)
+->assertEqual("B")
+
+switch abc->List.getOrThrow(4) {
+| exception Not_found => assert(true)
+| _ => assert(false)
+}
+```
+
+## Exceptions
+
+- Raises an Error if `index` is larger than the length of list.
 */
 let getOrThrow: (list<'a>, int) => 'a
 
diff --git a/tests/analysis_tests/tests/src/expected/Completion.res.txt b/tests/analysis_tests/tests/src/expected/Completion.res.txt
diff --git a/tests/docstring_tests/DocTest.res b/tests/docstring_tests/DocTest.res
diff --git a/tests/docstring_tests/DocTest.res.js b/tests/docstring_tests/DocTest.res.js

Original file line number	Diff line number	Diff line change
`@@ -17,11 +17,11 @@ function forEach(opt, f) {`
`17`	`17`
`18`	`18`	`}`
`19`	`19`
`20`		`-function getExn(x, message) {`
	`20`	`+function getOrThrow(x, message) {`
`21`	`21`	`if (x !== undefined) {`
`22`	`22`	`return Primitive_option.valFromOption(x);`
`23`	`23`	`} else {`
`24`		`- return Stdlib_Error.panic(message !== undefined ? message : "Option.getExn called for None value");`
	`24`	`+ return Stdlib_Error.panic(message !== undefined ? message : "Option.getOrThrow called for None value");`
`25`	`25`	`}`
`26`	`26`	`}`
`27`	`27`
`@@ -197,6 +197,8 @@ function all6(param) {`
`197`	`197`
`198`	`198`	`}`
`199`	`199`
	`200`	`+let getExn = getOrThrow;`
	`201`	`+`
`200`	`202`	`let mapWithDefault = mapOr;`
`201`	`203`
`202`	`204`	`let getWithDefault = getOr;`
`@@ -205,6 +207,7 @@ export {`
`205`	`207`	`filter,`
`206`	`208`	`forEach,`
`207`	`209`	`getExn,`
	`210`	`+ getOrThrow,`
`208`	`211`	`mapOr,`
`209`	`212`	`mapWithDefault,`
`210`	`213`	`map,`