tools: fix dir_sep and update rescript files

rescript-lang · Jan 27, 2024 · 10818a4 · 10818a4
1 parent 79e7e1e
commit 10818a4
Show file tree

Hide file tree

Showing 10 changed files with 64 additions and 16 deletions.
diff --git a/tools/npm/RescriptTools.bs.js b/tools/npm/RescriptTools.bs.js
diff --git a/tools/npm/Tools_Docgen.bs.js b/tools/npm/Tools_Docgen.bs.js
diff --git a/tools/npm/Tools_Docgen.res b/tools/npm/Tools_Docgen.res
@@ -22,6 +22,12 @@ type detail =
   | @as("record") Record({items: array<field>})
   | @as("variant") Variant({items: array<constructor>})
 
+type source = {
+  filepath: string,
+  line: int,
+  col: int,
+}
+
 @tag("kind")
 type rec item =
   | @as("value")
@@ -31,6 +37,7 @@ type rec item =
       signature: string,
       name: string,
       deprecated?: string,
+      source: source,
     })
   | @as("type")
   Type({
@@ -39,6 +46,7 @@ type rec item =
       signature: string,
       name: string,
       deprecated?: string,
+      source: source,
       /** Additional documentation for constructors and record fields, if available. */
       detail?: detail,
     })
@@ -48,20 +56,23 @@ type rec item =
       docstrings: array<string>,
       deprecated?: string,
       name: string,
+      source: source,
       items: array<item>,
     })
   | @as("moduleAlias")
   ModuleAlias({
       id: string,
       docstrings: array<string>,
       name: string,
+      source: source,
       items: array<item>,
     })
 
 type doc = {
   name: string,
   deprecated: option<string>,
   docstrings: array<string>,
+  source: source,
   items: array<item>,
 }
 

diff --git a/tools/npm/Tools_Docgen.resi b/tools/npm/Tools_Docgen.resi
@@ -21,6 +21,12 @@ type detail =
   | @as("record") Record({items: array<field>})
   | @as("variant") Variant({items: array<constructor>})
 
+type source = {
+  filepath: string,
+  line: int,
+  col: int,
+}
+
 @tag("kind")
 type rec item =
   | @as("value")
@@ -30,6 +36,7 @@ type rec item =
       signature: string,
       name: string,
       deprecated?: string,
+      source: source,
     })
   | @as("type")
   Type({
@@ -38,6 +45,7 @@ type rec item =
       signature: string,
       name: string,
       deprecated?: string,
+      source: source,
       /** Additional documentation for constructors and record fields, if available. */
       detail?: detail,
     })
@@ -47,16 +55,24 @@ type rec item =
       docstrings: array<string>,
       deprecated?: string,
       name: string,
+      source: source,
       items: array<item>,
     })
   | @as("moduleAlias")
   ModuleAlias({
       id: string,
       docstrings: array<string>,
       name: string,
+      source: source,
       items: array<item>,
     })
 
-type doc = {name: string, deprecated: option<string>, docstrings: array<string>, items: array<item>}
+type doc = {
+  name: string,
+  deprecated: option<string>,
+  docstrings: array<string>,
+  source: source,
+  items: array<item>,
+}
 
 let decodeFromJson: Js.Json.t => doc
diff --git a/tools/src/tools.ml b/tools/src/tools.ml
@@ -280,6 +280,9 @@ let typeDetail typ ~env ~full =
 let makeId modulePath ~identifier =
   identifier :: modulePath |> List.rev |> SharedTypes.ident
 
+(**
+Get relative path to res/resi file
+*)
 let findRelativePath ~rootPath ~path =
   let open Filename in
   let realPath =
@@ -290,7 +293,7 @@ let findRelativePath ~rootPath ~path =
   in
   let rec loop dirPath acc =
     match dirname dirPath = realPath with
-    | true -> basename dirPath :: acc |> String.concat dir_sep
+    | true -> basename dirPath :: acc |> String.concat "/"
     | false -> (
       match dirPath with
       | "/" -> failwith "Failed to find relative path of package"
@@ -359,8 +362,8 @@ let extractDocs ~entryPointFile ~debug =
                   | true -> file.uri |> Uri.toPath
                   | false ->
                     findRelativePath ~rootPath ~path:(file.uri |> Uri.toPath));
-                line = 0;
-                col = 0;
+                line = 1;
+                col = 1;
               };
             items =
               structure.items

diff --git a/tools/tests/src/expected/DocExtraction2.res.json b/tools/tests/src/expected/DocExtraction2.res.json
@@ -4,8 +4,8 @@
   "docstrings": ["Module level doc here."],
   "source": {
     "filepath": "src/DocExtraction2.resi",
-    "line": 0,
-    "col": 0
+    "line": 1,
+    "col": 1
   },
   "items": [
   {

diff --git a/tools/tests/src/expected/DocExtraction2.resi.json b/tools/tests/src/expected/DocExtraction2.resi.json
@@ -4,8 +4,8 @@
   "docstrings": ["Module level doc here."],
   "source": {
     "filepath": "src/DocExtraction2.resi",
-    "line": 0,
-    "col": 0
+    "line": 1,
+    "col": 1
   },
   "items": [
   {

diff --git a/tools/tests/src/expected/DocExtractionRes.res.json b/tools/tests/src/expected/DocExtractionRes.res.json
@@ -4,8 +4,8 @@
   "docstrings": ["Module level documentation goes here."],
   "source": {
     "filepath": "src/DocExtractionRes.res",
-    "line": 0,
-    "col": 0
+    "line": 1,
+    "col": 1
   },
   "items": [
   {
@@ -242,8 +242,8 @@
     "docstrings": [],
     "source": {
       "filepath": "src/DocExtractionRes.res",
-      "line": 0,
-      "col": 0
+      "line": 1,
+      "col": 1
     },
     "items": [
     {

diff --git a/tools/tests/src/expected/ModC.res.json b/tools/tests/src/expected/ModC.res.json
@@ -4,8 +4,8 @@
   "docstrings": [],
   "source": {
     "filepath": "src/ModC.resi",
-    "line": 0,
-    "col": 0
+    "line": 1,
+    "col": 1
   },
   "items": [
   {

diff --git a/tools/tests/src/expected/ModC.resi.json b/tools/tests/src/expected/ModC.resi.json
@@ -4,8 +4,8 @@
   "docstrings": [],
   "source": {
     "filepath": "src/ModC.resi",
-    "line": 0,
-    "col": 0
+    "line": 1,
+    "col": 1
   },
   "items": [
   {