migrations for Exn

Author: zth

packages/@rescript/runtime/Stdlib_Exn.resi

@@ -27,18 +27,44 @@ Provide utilities for dealing with JS exceptions.
 */
 
 /** Represents a JS exception */
-@deprecated("Use `JsExn.t` instead")
+@deprecated({
+  reason: "Use `JsExn.t` instead",
+  migrate: %replace.type(: JsExn.t),
+})
 type t
 
 type exn += private Error(t)
 
-@deprecated("Use `JsExn.fromException` instead")
+@deprecated({
+  reason: "Use `JsExn.fromException` instead",
+  migrate: JsExn.fromException(),
+})
 let asJsExn: exn => option<t>
 
-@deprecated("Use `JsExn.stack` instead") @get external stack: t => option<string> = "stack"
-@deprecated("Use `JsExn.message` instead") @get external message: t => option<string> = "message"
-@deprecated("Use `JsExn.name` instead") @get external name: t => option<string> = "name"
-@deprecated("Use `JsExn.fileName` instead") @get external fileName: t => option<string> = "fileName"
+@deprecated({
+  reason: "Use `JsExn.stack` instead",
+  migrate: JsExn.stack(),
+})
+@get
+external stack: t => option<string> = "stack"
+@deprecated({
+  reason: "Use `JsExn.message` instead",
+  migrate: JsExn.message(),
+})
+@get
+external message: t => option<string> = "message"
+@deprecated({
+  reason: "Use `JsExn.name` instead",
+  migrate: JsExn.name(),
+})
+@get
+external name: t => option<string> = "name"
+@deprecated({
+  reason: "Use `JsExn.fileName` instead",
+  migrate: JsExn.fileName(),
+})
+@get
+external fileName: t => option<string> = "fileName"
 
 /**
 `anyToExnInternal(obj)` will take any value `obj` and wrap it
@@ -51,23 +77,47 @@ a value passed to a Promise.catch callback)
 
 **IMPORTANT**: This is an internal API and may be changed / removed any time in the future.
 */
-@deprecated("Use `JsExn.anyToExnInternal` instead")
+@deprecated({
+  reason: "Use `JsExn.anyToExnInternal` instead",
+  migrate: JsExn.anyToExnInternal(),
+})
 external anyToExnInternal: 'a => exn = "%wrap_exn"
 
 /** Raise Js exception Error object with stacktrace */
-@deprecated("Use `JsError.throwWithMessage` instead")
+@deprecated({
+  reason: "Use `JsError.throwWithMessage` instead",
+  migrate: JsError.throwWithMessage(),
+})
 let raiseError: string => 'a
-@deprecated("Use `JsError.EvalError.throwWithMessage` instead")
+@deprecated({
+  reason: "Use `JsError.EvalError.throwWithMessage` instead",
+  migrate: JsError.EvalError.throwWithMessage(),
+})
 let raiseEvalError: string => 'a
-@deprecated("Use `JsError.RangeError.throwWithMessage` instead")
+@deprecated({
+  reason: "Use `JsError.RangeError.throwWithMessage` instead",
+  migrate: JsError.RangeError.throwWithMessage(),
+})
 let raiseRangeError: string => 'a
-@deprecated("Use `JsError.ReferenceError.throwWithMessage` instead")
+@deprecated({
+  reason: "Use `JsError.ReferenceError.throwWithMessage` instead",
+  migrate: JsError.ReferenceError.throwWithMessage(),
+})
 let raiseReferenceError: string => 'a
-@deprecated("Use `JsError.SyntaxError.throwWithMessage` instead")
+@deprecated({
+  reason: "Use `JsError.SyntaxError.throwWithMessage` instead",
+  migrate: JsError.SyntaxError.throwWithMessage(),
+})
 let raiseSyntaxError: string => 'a
-@deprecated("Use `JsError.TypeError.throwWithMessage` instead")
+@deprecated({
+  reason: "Use `JsError.TypeError.throwWithMessage` instead",
+  migrate: JsError.TypeError.throwWithMessage(),
+})
 let raiseTypeError: string => 'a
-@deprecated("Use `JsError.URIError.throwWithMessage` instead")
+@deprecated({
+  reason: "Use `JsError.URIError.throwWithMessage` instead",
+  migrate: JsError.URIError.throwWithMessage(),
+})
 let raiseUriError: string => 'a
 
 /**
@@ -76,5 +126,8 @@ let raiseUriError: string => 'a
   This helper is useful when you want to discard a value (for example, the result of an operation with side effects)
   without having to store or process it further.
 */
-@deprecated("Use `JsExn.ignore` instead")
+@deprecated({
+  reason: "Use `JsExn.ignore` instead",
+  migrate: JsExn.ignore(),
+})
 external ignore: t => unit = "%ignore"

tests/tools_tests/src/expected/StdlibMigration_Exn.res.expected

@@ -0,0 +1,41 @@
+// Use deprecated Exn APIs to validate migration to JsExn/JsError
+
+external someExn: exn = "whatever"
+external someJsExn: JsExn.t = "whatever"
+
+// fromException (asJsExn)
+let fromExn1 = someExn->JsExn.fromException
+let fromExn2 = JsExn.fromException(someExn)
+
+// Property accessors on Exn.t
+let stack1 = someJsExn->JsExn.stack
+let stack2 = JsExn.stack(someJsExn)
+
+let message1 = someJsExn->JsExn.message
+let message2 = JsExn.message(someJsExn)
+
+let name1 = someJsExn->JsExn.name
+let name2 = JsExn.name(someJsExn)
+
+let fileName1 = someJsExn->JsExn.fileName
+let fileName2 = JsExn.fileName(someJsExn)
+
+// Type alias migration
+let exnT: JsExn.t = someJsExn
+
+// anyToExnInternal
+let _coerced = JsExn.anyToExnInternal(1)
+
+// ignore
+let ignore1 = someJsExn->JsExn.ignore
+let ignore2 = JsExn.ignore(someJsExn)
+
+// Raise helpers
+let throws1 = () => JsError.throwWithMessage("err")
+let throws2 = () => JsError.EvalError.throwWithMessage("err")
+let throws3 = () => JsError.RangeError.throwWithMessage("err")
+let throws4 = () => JsError.ReferenceError.throwWithMessage("err")
+let throws5 = () => JsError.SyntaxError.throwWithMessage("err")
+let throws6 = () => JsError.TypeError.throwWithMessage("err")
+let throws7 = () => JsError.URIError.throwWithMessage("err")
+

tests/tools_tests/src/migrate/StdlibMigration_Exn.res

@@ -0,0 +1,40 @@
+// Use deprecated Exn APIs to validate migration to JsExn/JsError
+
+external someExn: exn = "whatever"
+external someJsExn: Exn.t = "whatever"
+
+// fromException (asJsExn)
+let fromExn1 = someExn->Exn.asJsExn
+let fromExn2 = Exn.asJsExn(someExn)
+
+// Property accessors on Exn.t
+let stack1 = someJsExn->Exn.stack
+let stack2 = Exn.stack(someJsExn)
+
+let message1 = someJsExn->Exn.message
+let message2 = Exn.message(someJsExn)
+
+let name1 = someJsExn->Exn.name
+let name2 = Exn.name(someJsExn)
+
+let fileName1 = someJsExn->Exn.fileName
+let fileName2 = Exn.fileName(someJsExn)
+
+// Type alias migration
+let exnT: Exn.t = someJsExn
+
+// anyToExnInternal
+let _coerced = Exn.anyToExnInternal(1)
+
+// ignore
+let ignore1 = someJsExn->Exn.ignore
+let ignore2 = Exn.ignore(someJsExn)
+
+// Raise helpers
+let throws1 = () => Exn.raiseError("err")
+let throws2 = () => Exn.raiseEvalError("err")
+let throws3 = () => Exn.raiseRangeError("err")
+let throws4 = () => Exn.raiseReferenceError("err")
+let throws5 = () => Exn.raiseSyntaxError("err")
+let throws6 = () => Exn.raiseTypeError("err")
+let throws7 = () => Exn.raiseUriError("err")