add docstrings compiler tests

biome.json

@@ -25,6 +25,7 @@
       "tests/tests/**",
       "tests/tools_tests/**",
       "tests/analysis_tests/**",
+      "tests/docstrings_examples/**",
       "analysis/examples/**",
       "analysis/reanalyze/examples/**",
       "lib/**",

runtime/Belt_Array.resi

@@ -362,6 +362,7 @@ arr == [0, 1, 9, 9, 4]
 Belt.Array.fill(arr, ~offset=7, ~len=2, 8)
 
 arr == [0, 1, 9, 9, 4]
+```
 */
 let fill: (t<'a>, ~offset: int, ~len: int, 'a) => unit
 

runtime/Exn.resi

@@ -52,12 +52,13 @@ a value passed to a Promise.catch callback)
 ## Examples
 
 ```rescript
-switch (Js.Exn.unsafeAnyToExn("test")) {
+switch (Js.Exn.anyToExnInternal("test")) {
 | Js.Exn.Error(v) =>
   switch(Js.Exn.message(v)) {
-  | Some(str) => Js.log("We won't end up here")
+  | Some(_) => Js.log("We won't end up here")
   | None => Js.log2("We will land here: ", v)
   }
+| _ => assert(false)
 }
 ```
 */

runtime/Js_dict.resi

@@ -53,6 +53,7 @@ type key = string
 ## Examples
 
 ```rescript
+let ages = dict{"Maria": 30, "Vinh": 22, "Fred": 49}
 Js.Dict.get(ages, "Vinh") == Some(22)
 Js.Dict.get(ages, "Paul") == None
 ```
@@ -66,6 +67,7 @@ let get: (t<'a>, key) => option<'a>
 ## Examples
 
 ```rescript
+let ages = dict{"Maria": 30, "Vinh": 22, "Fred": 49}
 Js.Dict.unsafeGet(ages, "Fred") == 49
 Js.Dict.unsafeGet(ages, "Paul") // returns undefined
 ```
@@ -82,6 +84,7 @@ the key does not exist, and entry will be created for it.
 ## Examples
 
 ```rescript
+let ages = dict{"Maria": 30, "Vinh": 22, "Fred": 49}
 Js.Dict.set(ages, "Maria", 31)
 Js.log(ages == Js.Dict.fromList(list{("Maria", 31), ("Vinh", 22), ("Fred", 49)}))
 
@@ -98,6 +101,7 @@ Returns all the keys in the dictionary `dict`.
 ## Examples
 
 ```rescript
+let ages = dict{"Maria": 30, "Vinh": 22, "Fred": 49}
 Js.Dict.keys(ages) == ["Maria", "Vinh", "Fred"]
 ```
 */
@@ -115,6 +119,7 @@ Returns an array of key/value pairs in the given dictionary (ES2017).
 ## Examples
 
 ```rescript
+let ages = dict{"Maria": 30, "Vinh": 22, "Fred": 49}
 Js.Dict.entries(ages) == [("Maria", 30), ("Vinh", 22), ("Fred", 49)]
 ```
 */
@@ -126,6 +131,7 @@ Returns the values in the given dictionary (ES2017).
 ## Examples
 
 ```rescript
+let ages = dict{"Maria": 30, "Vinh": 22, "Fred": 49}
 Js.Dict.values(ages) == [30, 22, 49]
 ```
 */

runtime/Js_types.resi

@@ -55,9 +55,9 @@ This is useful for doing runtime reflection on any given value.
 ## Examples
 
 ```rescript
-test("test", String) == true
-test(() => true, Function) == true
-test("test", Boolean) == false
+Js.Types.test("test", String) == true
+Js.Types.test(() => true, Function) == true
+Js.Types.test("test", Boolean) == false
 ```
 */
 let test: ('a, t<'b>) => bool

scripts/test.js

@@ -12,6 +12,7 @@ let ounitTest = false;
 let mochaTest = false;
 let bsbTest = false;
 let formatTest = false;
+let runtimeDocstrings = false;
 
 if (process.argv.includes("-ounit")) {
   ounitTest = true;
@@ -29,11 +30,16 @@ if (process.argv.includes("-format")) {
   formatTest = true;
 }
 
+if (process.argv.includes("-docstrings")) {
+  runtimeDocstrings = true;
+}
+
 if (process.argv.includes("-all")) {
   ounitTest = true;
   mochaTest = true;
   bsbTest = true;
   formatTest = true;
+  runtimeDocstrings = true;
 }
 
 async function runTests() {
@@ -120,6 +126,18 @@ async function runTests() {
       process.exit(1);
     }
   }
+
+  if (runtimeDocstrings) {
+    console.log("Running runtime docstrings tests");
+    cp.execSync(`${rescript_exe} build`, {
+      cwd: path.join(__dirname, "..", "tests/docstrings_examples"),
+      stdio: [0, 1, 2],
+    });
+    cp.execSync("node tests/docstrings_examples/DocTest.res.mjs", {
+      cwd: path.join(__dirname, ".."),
+      stdio: [0, 1, 2],
+    });
+  }
 }
 
 runTests();

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

@@ -745,7 +745,7 @@ Path Js.Dict.u
     "kind": 12,
     "tags": [],
     "detail": "(t<'a>, key) => 'a",
-    "documentation": {"kind": "markdown", "value": "\n`Js.Dict.unsafeGet(key)` returns the value if the key exists, otherwise an `undefined` value is returned. Use this only when you are sure the key exists (i.e. when having used the `keys()` function to check that the key is valid).\n\n## Examples\n\n```rescript\nJs.Dict.unsafeGet(ages, \"Fred\") == 49\nJs.Dict.unsafeGet(ages, \"Paul\") // returns undefined\n```\n"}
+    "documentation": {"kind": "markdown", "value": "\n`Js.Dict.unsafeGet(key)` returns the value if the key exists, otherwise an `undefined` value is returned. Use this only when you are sure the key exists (i.e. when having used the `keys()` function to check that the key is valid).\n\n## Examples\n\n```rescript\nlet ages = dict{\"Maria\": 30, \"Vinh\": 22, \"Fred\": 49}\nJs.Dict.unsafeGet(ages, \"Fred\") == 49\nJs.Dict.unsafeGet(ages, \"Paul\") // returns undefined\n```\n"}
   }, {
     "label": "unsafeDeleteKey",
     "kind": 12,