produce what id to link to in linkables

Author: zth

analysis/src/DocExtraction.ml

@@ -121,17 +121,20 @@ let stringifyLinkables ?(indentation = 0)
   let open Protocol in
   linkables
   |> List.map (fun l ->
+         let isExternal = originalEnv.file.uri <> l.env.file.uri in
          stringifyObject ~indentation:(indentation + 1)
            [
+             ( "linkId",
+               Some
+                 ((if isExternal then "" else l.env.file.moduleName ^ ".")
+                  ^ (l.path |> SharedTypes.pathIdentToString)
+                 |> Json.escape |> wrapInQuotes) );
              ( "path",
                Some
                  (l.path |> SharedTypes.pathIdentToString |> Json.escape
                 |> wrapInQuotes) );
              ("moduleName", Some (l.env.file.moduleName |> wrapInQuotes));
-             ( "external",
-               Some
-                 (Printf.sprintf "%b" (originalEnv.file.uri <> l.env.file.uri))
-             );
+             ("external", Some (Printf.sprintf "%b" isExternal));
            ])
   |> array
 

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

@@ -21,6 +21,7 @@ preferring found resi file for impl: src/DocExtraction2.resi
     "signature": "let make: unit => t",
     "docstrings": ["Makerz of stuffz."],
     "linkables": [{
+        "linkId": "DocExtraction2.t",
         "path": "t",
         "moduleName": "DocExtraction2",
         "external": false
@@ -49,6 +50,7 @@ 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",
             "external": false

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

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

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

@@ -33,6 +33,7 @@ extracting docs for src/DocExtractionRes.res
     "signature": "let make: string => t",
     "docstrings": ["Create stuff.\\n\\n```rescript example\\nlet stuff = make(\\\"My name\\\")\\n```"],
     "linkables": [{
+        "linkId": "DocExtractionRes.t",
         "path": "t",
         "moduleName": "DocExtractionRes",
         "external": false
@@ -45,6 +46,7 @@ extracting docs for src/DocExtractionRes.res
     "signature": "let asOffline: t => t",
     "docstrings": ["Stuff goes offline."],
     "linkables": [{
+        "linkId": "DocExtractionRes.t",
         "path": "t",
         "moduleName": "DocExtractionRes",
         "external": false
@@ -65,6 +67,7 @@ extracting docs for src/DocExtractionRes.res
         "signature": "type status = Started(t) | Stopped | Idle",
         "docstrings": [],
         "linkables": [{
+            "linkId": "DocExtractionRes.t",
             "path": "t",
             "moduleName": "DocExtractionRes",
             "external": false
@@ -105,10 +108,12 @@ extracting docs for src/DocExtractionRes.res
         "signature": "type callback = (t, ~status: status) => unit",
         "docstrings": [],
         "linkables": [{
+            "linkId": "DocExtractionRes.t",
             "path": "t",
             "moduleName": "DocExtractionRes",
             "external": false
           }, {
+            "linkId": "DocExtractionRes.status",
             "path": "status",
             "moduleName": "DocExtractionRes",
             "external": false
@@ -131,6 +136,7 @@ extracting docs for src/DocExtractionRes.res
         "signature": "type callback = SomeInnerModule.status => unit",
         "docstrings": ["Testing what this looks like."],
         "linkables": [{
+            "linkId": "DocExtractionRes.SomeInnerModule.status",
             "path": "SomeInnerModule.status",
             "moduleName": "DocExtractionRes",
             "external": false
@@ -143,6 +149,7 @@ extracting docs for src/DocExtractionRes.res
         "signature": "let isGoodStatus: SomeInnerModule.status => bool",
         "docstrings": [],
         "linkables": [{
+            "linkId": "DocExtractionRes.SomeInnerModule.status",
             "path": "SomeInnerModule.status",
             "moduleName": "DocExtractionRes",
             "external": false
@@ -173,6 +180,7 @@ extracting docs for src/DocExtractionRes.res
         "signature": "type domRoot = unit => ReactDOM.Client.Root.t",
         "docstrings": ["Callback to get the DOM root..."],
         "linkables": [{
+            "linkId": "ReactDOM.Client.Root.t",
             "path": "ReactDOM.Client.Root.t",
             "moduleName": "ReactDOM",
             "external": true
@@ -203,6 +211,7 @@ extracting docs for src/DocExtractionRes.res
         "signature": "let make: unit => t",
         "docstrings": ["The maker of stuff!"],
         "linkables": [{
+            "linkId": "DocExtractionRes.t",
             "path": "t",
             "moduleName": "DocExtractionRes",
             "external": false