fix linkable link ids

Author: zth

analysis/src/DocExtraction.ml

@@ -1,5 +1,6 @@
 type linkableType = {
   name: string;
+  modulePath: string list;
   path: Path.t;
   env: SharedTypes.QueryEnv.t;
   loc: Location.t;
@@ -109,9 +110,17 @@ module Linkables = struct
     let fromConstructorPath ~env path =
       match References.digConstructor ~env ~package:full.package path with
       | None -> None
-      | Some (env, {name = {txt}; extentLoc}) ->
+      | Some (env, {name = {txt}; extentLoc; modulePath}) ->
         if Utils.isUncurriedInternal path then None
-        else Some {name = txt; env; loc = extentLoc; path}
+        else
+          Some
+            {
+              name = txt;
+              env;
+              loc = extentLoc;
+              modulePath = SharedTypes.ModulePath.toPath modulePath txt;
+              path;
+            }
     in
     let constructors = Shared.findTypeConstructors typesToSearch in
     constructors |> List.filter_map (fromConstructorPath ~env:envToSearch)
@@ -130,18 +139,16 @@ let stringifyLinkables ?(indentation = 0)
   linkables
   |> List.map (fun l ->
          let isExternal = originalEnv.file.uri <> l.env.file.uri in
+         let linkId = l.env.file.moduleName :: l.modulePath in
          stringifyObject ~indentation:(indentation + 1)
            [
              ( "linkId",
-               Some
-                 ((if isExternal then "" else l.env.file.moduleName ^ ".")
-                  ^ (l.path |> SharedTypes.pathIdentToString)
-                 |> Json.escape |> wrapInQuotes) );
-             ( "path",
+               Some (linkId |> SharedTypes.ident |> Json.escape |> wrapInQuotes)
+             );
+             ( "name",
                Some
                  (l.path |> SharedTypes.pathIdentToString |> Json.escape
                 |> wrapInQuotes) );
-             ("moduleName", Some (l.env.file.moduleName |> wrapInQuotes));
              ("external", Some (Printf.sprintf "%b" isExternal));
            ])
   |> array

analysis/tests/src/expected/DocExtraction2.res.txt

@@ -22,8 +22,7 @@ preferring found resi file for impl: src/DocExtraction2.resi
     "docstrings": ["Makerz of stuffz."],
     "linkables": [{
         "linkId": "DocExtraction2.t",
-        "path": "t",
-        "moduleName": "DocExtraction2",
+        "name": "t",
         "external": false
       }]
   }, 
@@ -50,9 +49,8 @@ preferring found resi file for impl: src/DocExtraction2.resi
         "signature": "let make: unit => t",
         "docstrings": ["Maker of tea."],
         "linkables": [{
-            "linkId": "DocExtraction2.t",
-            "path": "t",
-            "moduleName": "DocExtraction2",
+            "linkId": "DocExtraction2.InnerModule.t",
+            "name": "t",
             "external": false
           }]
       }]

analysis/tests/src/expected/DocExtraction2.resi.txt

@@ -21,8 +21,7 @@ extracting docs for src/DocExtraction2.resi
     "docstrings": ["Makerz of stuffz."],
     "linkables": [{
         "linkId": "DocExtraction2.t",
-        "path": "t",
-        "moduleName": "DocExtraction2",
+        "name": "t",
         "external": false
       }]
   }, 
@@ -49,9 +48,8 @@ extracting docs for src/DocExtraction2.resi
         "signature": "let make: unit => t",
         "docstrings": ["Maker of tea."],
         "linkables": [{
-            "linkId": "DocExtraction2.t",
-            "path": "t",
-            "moduleName": "DocExtraction2",
+            "linkId": "DocExtraction2.InnerModule.t",
+            "name": "t",
             "external": false
           }]
       }]

analysis/tests/src/expected/DocExtractionRes.res.txt

@@ -36,8 +36,7 @@ extracting docs for src/DocExtractionRes.res
     "docstrings": ["Create stuff.\\n\\n```rescript example\\nlet stuff = make(\\\"My name\\\")\\n```"],
     "linkables": [{
         "linkId": "DocExtractionRes.t",
-        "path": "t",
-        "moduleName": "DocExtractionRes",
+        "name": "t",
         "external": false
       }]
   }, 
@@ -49,8 +48,7 @@ extracting docs for src/DocExtractionRes.res
     "docstrings": ["Stuff goes offline."],
     "linkables": [{
         "linkId": "DocExtractionRes.t",
-        "path": "t",
-        "moduleName": "DocExtractionRes",
+        "name": "t",
         "external": false
       }]
   }, 
@@ -70,8 +68,7 @@ extracting docs for src/DocExtractionRes.res
         "docstrings": [],
         "linkables": [{
             "linkId": "DocExtractionRes.t",
-            "path": "t",
-            "moduleName": "DocExtractionRes",
+            "name": "t",
             "external": false
           }],
         "detail": 
@@ -84,8 +81,7 @@ extracting docs for src/DocExtractionRes.res
             "signature": "Started(t)",
             "linkables": [{
               "linkId": "DocExtractionRes.t",
-              "path": "t",
-              "moduleName": "DocExtractionRes",
+              "name": "t",
               "external": false
             }]
           }, 
@@ -119,13 +115,11 @@ extracting docs for src/DocExtractionRes.res
         "docstrings": [],
         "linkables": [{
             "linkId": "DocExtractionRes.t",
-            "path": "t",
-            "moduleName": "DocExtractionRes",
+            "name": "t",
             "external": false
           }, {
-            "linkId": "DocExtractionRes.status",
-            "path": "status",
-            "moduleName": "DocExtractionRes",
+            "linkId": "DocExtractionRes.SomeInnerModule.status",
+            "name": "status",
             "external": false
           }]
       }]
@@ -147,8 +141,7 @@ extracting docs for src/DocExtractionRes.res
         "docstrings": ["Testing what this looks like."],
         "linkables": [{
             "linkId": "DocExtractionRes.SomeInnerModule.status",
-            "path": "SomeInnerModule.status",
-            "moduleName": "DocExtractionRes",
+            "name": "SomeInnerModule.status",
             "external": false
           }]
       }, 
@@ -160,8 +153,7 @@ extracting docs for src/DocExtractionRes.res
         "docstrings": [],
         "linkables": [{
             "linkId": "DocExtractionRes.SomeInnerModule.status",
-            "path": "SomeInnerModule.status",
-            "moduleName": "DocExtractionRes",
+            "name": "SomeInnerModule.status",
             "external": false
           }]
       }, 
@@ -192,8 +184,7 @@ extracting docs for src/DocExtractionRes.res
         "docstrings": ["Callback to get the DOM root..."],
         "linkables": [{
             "linkId": "ReactDOM.Client.Root.t",
-            "path": "ReactDOM.Client.Root.t",
-            "moduleName": "ReactDOM",
+            "name": "ReactDOM.Client.Root.t",
             "external": true
           }]
       }]
@@ -222,9 +213,8 @@ extracting docs for src/DocExtractionRes.res
         "signature": "let make: unit => t",
         "docstrings": ["The maker of stuff!"],
         "linkables": [{
-            "linkId": "DocExtractionRes.t",
-            "path": "t",
-            "moduleName": "DocExtractionRes",
+            "linkId": "DocExtractionRes.ModuleWithThingsThatShouldNotBeExported.t",
+            "name": "t",
             "external": false
           }]
       }]