Add type t to Stdlib modules (#7302)

* add a type t as an alias of the built-in types

Author: tsnobip

CHANGELOG.md

@@ -20,6 +20,7 @@
 
 - Allow single newline in JSX. https://github.com/rescript-lang/rescript/pull/7269
 - Editor: Always complete from Core first. Use actual native regex syntax in code snippets for regexps. https://github.com/rescript-lang/rescript/pull/7295
+- Add `type t` to Stdlib modules. https://github.com/rescript-lang/rescript/pull/7302
 
 #### :bug: Bug fix
 

runtime/Stdlib_Array.res

@@ -1,3 +1,4 @@
+type t<'a> = array<'a>
 type arrayLike<'a>
 
 @new external makeUninitializedUnsafe: int => array<'a> = "Array"

runtime/Stdlib_Array.resi

@@ -1,3 +1,13 @@
+/***
+A mutable array.
+
+Compiles to a regular JavaScript array.*/
+
+/**
+Type representing an array of value `'a`.
+*/
+type t<'a> = array<'a>
+
 type arrayLike<'a>
 
 /**

runtime/Stdlib_BigInt.res

@@ -1,3 +1,8 @@
+/**
+Type representing a bigint.
+*/
+type t = bigint
+
 @val external asIntN: (~width: int, bigint) => bigint = "BigInt.asIntN"
 @val external asUintN: (~width: int, bigint) => bigint = "BigInt.asUintN"
 

runtime/Stdlib_Float.res

@@ -1,3 +1,5 @@
+type t = float
+
 module Constants = {
   @val external nan: float = "NaN"
   @val external epsilon: float = "Number.EPSILON"

runtime/Stdlib_Float.resi

@@ -26,6 +26,11 @@
 Functions for interacting with float.
 */
 
+/**
+Type representing a float.
+*/
+type t = float
+
 /**
 Float constants.
 */

runtime/Stdlib_Int.res

@@ -1,3 +1,5 @@
+type t = int
+
 module Constants = {
   @inline let minValue = -2147483648
   @inline let maxValue = 2147483647

runtime/Stdlib_Int.resi

@@ -27,6 +27,11 @@ Functions for interacting with JavaScript Number.
 See: [`Number`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number).
 */
 
+/**
+Type representing an int.
+*/
+type t = int
+
 module Constants: {
   /**
   The smallest positive number represented in JavaScript.

runtime/Stdlib_List.res

@@ -61,6 +61,8 @@
 
 @@config({flags: ["-bs-noassertfalse"]})
 
+type t<'a> = list<'a>
+
 module A = {
   @new external makeUninitializedUnsafe: int => array<'a> = "Array"
   external min: ('a, 'a) => 'a = "%bs_min"

runtime/Stdlib_List.resi

@@ -31,6 +31,11 @@ Collection functions for manipulating the `list` data structures, a singly-linke
 - Better interop with JavaScript
 - Better memory usage & performance.
 */
+/**
+Type representing a list of value `'a`.
+*/
+type t<'a> = list<'a>
+
 /**
 `length(list)` returns the length of `list`.
 

runtime/Stdlib_Option.res

@@ -21,6 +21,7 @@
  * You should have received a copy of the GNU Lesser General Public License
  * along with this program; if not, write to the Free Software
  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. */
+type t<'a> = option<'a> = None | Some('a)
 
 let filter = (opt, p) =>
   switch opt {

runtime/Stdlib_Option.resi

@@ -39,6 +39,11 @@ let someString: option<string> = Some("hello")
 ```
 */
 
+/**
+Type representing an option of type 'a.
+*/
+type t<'a> = option<'a> = None | Some('a)
+
 /**
 `filter(opt, f)` applies `f` to `opt`, if `f` returns `true`, then it returns `Some(value)`, otherwise returns `None`.
 

runtime/Stdlib_Result.res

@@ -21,6 +21,7 @@
  * You should have received a copy of the GNU Lesser General Public License
  * along with this program; if not, write to the Free Software
  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. */
+type t<'res, 'err> = result<'res, 'err> = Ok('res) | Error('err)
 
 let getExn = x =>
   switch x {

runtime/Stdlib_Result.resi

@@ -45,13 +45,18 @@
   }
 ```
 */
+type t<'res, 'err> = result<'res, 'err> = Ok('res) | Error('err)
+
 /**
   `getExn(res)`: when `res` is `Ok(n)`, returns `n` when `res` is `Error(m)`, raise an exception
 
   ```res example
   Result.getExn(Result.Ok(42)) == 42
 
-  Result.getExn(Result.Error("Invalid data")) /* raises exception */
+  switch Result.getExn(Error("Invalid data")) {
+  | exception Not_found => assert(true)
+  | _ => assert(false)
+  }
   ```
 */
 let getExn: result<'a, 'b> => 'a

runtime/Stdlib_String.res

@@ -1,3 +1,5 @@
+type t = string
+
 @val external make: 'a => string = "String"
 
 @val external fromCharCode: int => string = "String.fromCharCode"

runtime/Stdlib_String.resi

@@ -27,6 +27,11 @@ Functions for interacting with JavaScript strings.
 See: [`String`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String).
 */
 
+/**
+Type representing a string.
+*/
+type t = string
+
 /**
 `make(value)` converts the given value to a `string`.
 

tests/analysis_tests/tests/src/expected/Completion.res.txt

@@ -1951,7 +1951,7 @@ Path this
     "kind": 12,
     "tags": [],
     "detail": "\\\"Type Not Known\"",
-    "documentation": {"kind": "markdown", "value": "```rescript\ntype props<'first, 'zoo, 'second> = {\n  first?: 'first,\n  zoo?: 'zoo,\n  second: 'second,\n}\n```"}
+    "documentation": null
   }]
 
 Hover src/Completion.res 349:14
@@ -2511,7 +2511,7 @@ Path Stdlib.Result.g
     "kind": 12,
     "tags": [],
     "detail": "result<'a, 'b> => 'a",
-    "documentation": {"kind": "markdown", "value": "\n  Result types are really useful to describe the result of a certain operation\n  without relying on exceptions or `option` types.\n\n  This module gives you useful utilities to create and combine `Result` data.\n"}
+    "documentation": {"kind": "markdown", "value": "\n  `getExn(res)`: when `res` is `Ok(n)`, returns `n` when `res` is `Error(m)`, raise an exception\n\n  ```res example\n  Result.getExn(Result.Ok(42)) == 42\n\n  switch Result.getExn(Error(\"Invalid data\")) {\n  | exception Not_found => assert(true)\n  | _ => assert(false)\n  }\n  ```\n"}
   }, {
     "label": "Result.getOr",
     "kind": 12,