tools: add source field (Loc) (#900)

* tools: add source field

* tools: refactor

* tools: fix dir_sep and update rescript files

* update CHANGELOG.md

* disable in-source

* remove findRelativePath

* fix dir_sep on windows

Author: aspeddro

analysis/src/ProcessCmt.ml

@@ -60,6 +60,7 @@ let rec forTypeSignatureItem ~(env : SharedTypes.Env.t) ~(exported : Exported.t)
         name = declared.name.txt;
         docstring = declared.docstring;
         deprecated = declared.deprecated;
+        loc = declared.extentLoc;
       };
     ]
   | Sig_type
@@ -134,6 +135,7 @@ let rec forTypeSignatureItem ~(env : SharedTypes.Env.t) ~(exported : Exported.t)
         name = declared.name.txt;
         docstring = declared.docstring;
         deprecated = declared.deprecated;
+        loc = declared.extentLoc;
       };
     ]
   | Sig_module (ident, {md_type; md_attributes; md_loc}, _) ->
@@ -152,6 +154,7 @@ let rec forTypeSignatureItem ~(env : SharedTypes.Env.t) ~(exported : Exported.t)
         name = declared.name.txt;
         docstring = declared.docstring;
         deprecated = declared.deprecated;
+        loc = declared.extentLoc;
       };
     ]
   | _ -> []
@@ -316,6 +319,7 @@ let forTypeDeclaration ~env ~(exported : Exported.t)
     name = declared.name.txt;
     docstring = declared.docstring;
     deprecated = declared.deprecated;
+    loc = declared.extentLoc;
   }
 
 let rec forSignatureItem ~env ~(exported : Exported.t)
@@ -335,6 +339,7 @@ let rec forSignatureItem ~env ~(exported : Exported.t)
         name = declared.name.txt;
         docstring = declared.docstring;
         deprecated = declared.deprecated;
+        loc = declared.extentLoc;
       };
     ]
   | Tsig_type (recFlag, decls) ->
@@ -366,6 +371,7 @@ let rec forSignatureItem ~env ~(exported : Exported.t)
         name = declared.name.txt;
         docstring = declared.docstring;
         deprecated = declared.deprecated;
+        loc = declared.extentLoc;
       };
     ]
   | Tsig_recmodule modDecls ->
@@ -443,6 +449,7 @@ let rec forStructureItem ~env ~(exported : Exported.t) item =
             name = declared.name.txt;
             docstring = declared.docstring;
             deprecated = declared.deprecated;
+            loc = declared.extentLoc;
           }
           :: !items
       | Tpat_tuple pats | Tpat_array pats | Tpat_construct (_, _, pats) ->
@@ -478,6 +485,7 @@ let rec forStructureItem ~env ~(exported : Exported.t) item =
         name = declared.name.txt;
         docstring = declared.docstring;
         deprecated = declared.deprecated;
+        loc = declared.extentLoc;
       };
     ]
   | Tstr_recmodule modDecls ->
@@ -509,6 +517,7 @@ let rec forStructureItem ~env ~(exported : Exported.t) item =
         name = declared.name.txt;
         docstring = declared.docstring;
         deprecated = declared.deprecated;
+        loc = declared.extentLoc;
       };
     ]
   | Tstr_include {incl_mod; incl_type} ->
@@ -538,6 +547,7 @@ let rec forStructureItem ~env ~(exported : Exported.t) item =
         name = declared.name.txt;
         docstring = declared.docstring;
         deprecated = declared.deprecated;
+        loc = declared.extentLoc;
       };
     ]
   | Tstr_type (recFlag, decls) ->

analysis/src/SharedTypes.ml

@@ -125,6 +125,7 @@ module Module = struct
   and item = {
     kind: kind;
     name: string;
+    loc: Location.t;
     docstring: string list;
     deprecated: string option;
   }

tools/CHANGELOG.md

@@ -12,6 +12,10 @@
 
 ## master
 
+#### :rocket: New Feature
+
+- Add `source` property to type, value, module and module alias. https://github.com/rescript-lang/rescript-vscode/pull/900.
+
 #### :bug: Bug Fix
 
 - Print docstrings for nested submodules. https://github.com/rescript-lang/rescript-vscode/pull/897

tools/bin/main.ml

@@ -41,7 +41,7 @@ let main () =
         | Some "true" -> Analysis.Cfg.isDocGenFromCompiler := true
         | _ -> ()
       in
-      logAndExit (Tools.extractDocs ~path ~debug:false)
+      logAndExit (Tools.extractDocs ~entryPointFile:path ~debug:false)
     | _ -> logAndExit (Error docHelp))
   | "reanalyze" :: _ ->
     let len = Array.length Sys.argv in

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>,
 }
 

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

tools/rescript.json

@@ -9,6 +9,6 @@
   "suffix": ".bs.js",
   "package-specs": {
     "module": "commonjs",
-    "in-source": true
+    "in-source": false
   }
 }