feat(error): add panic/Error.panic

refactor(error): less magic needed

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

docs(error): panic fixes

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

docs(error): ReScript, not OCaml

Author: glennsl

src/Core__Error.mjs

@@ -13,12 +13,17 @@ var $$TypeError = {};
 
 var $$URIError = {};
 
+function panic(msg) {
+  throw new Error("Panic! " + msg);
+}
+
 export {
   $$EvalError ,
   $$RangeError ,
   $$ReferenceError ,
   $$SyntaxError ,
   $$TypeError ,
   $$URIError ,
+  panic ,
 }
 /* No side effect */

src/Core__Error.res

@@ -35,3 +35,5 @@ module URIError = {
 }
 
 external raise: t => 'a = "%raise"
+
+let panic = msg => make(j`Panic! $msg`)->raise

src/Core__Error.resi

@@ -155,3 +155,17 @@ if 5 > 10 {
 ```
 */
 external raise: t => 'a = "%raise"
+
+/**
+Raises a panic exception with the given message.
+
+A panic exception is a native JavaScript exception that is not intended to be caught and
+handled. Compared to a ReScript exception this will give a better stack trace and
+debugging experience.
+
+## Examples
+```rescript
+Error.panic("Uh oh. This was unexpected!")
+```
+*/
+let panic: string => 'a

src/RescriptCore.mjs

@@ -1,5 +1,6 @@
 // Generated by ReScript, PLEASE EDIT WITH CARE
 
+import * as Core__Error from "./Core__Error.mjs";
 
 var $$Array;
 
@@ -93,6 +94,8 @@ var List;
 
 var Result;
 
+var panic = Core__Error.panic;
+
 export {
   $$Array ,
   Console ,
@@ -140,5 +143,6 @@ export {
   $$Option ,
   List ,
   Result ,
+  panic ,
 }
 /* No side effect */

src/RescriptCore.res

@@ -65,3 +65,5 @@ type null<+'a> = Js.null<'a>
 type undefined<+'a> = Js.undefined<'a>
 
 type nullable<+'a> = Js.nullable<'a>
+
+let panic = Core__Error.panic