add moduletype field for modules with explicitly

annotated module type

Author: aspeddro

tools/src/tools.ml

@@ -44,7 +44,14 @@ type docItem =
           (** Additional documentation for constructors and record fields, if available. *)
     }
   | Module of docsForModule
-  | ModuleType of docsForModule
+  | ModuleType of {
+      id: string;
+      docstring: string list;
+      deprecated: string option;
+      name: string;
+      source: source;
+      items: docItem list;
+    }
   | ModuleAlias of {
       id: string;
       docstring: string list;
@@ -57,6 +64,7 @@ and docsForModule = {
   docstring: string list;
   deprecated: string option;
   name: string;
+  moduletype: string option;
   source: source;
   items: docItem list;
 }
@@ -195,6 +203,10 @@ let rec stringifyDocItem ?(indentation = 0) ~originalEnv (item : docItem) =
           match m.deprecated with
           | Some d -> Some (wrapInQuotes d)
           | None -> None );
+        ( "moduletype",
+          match m.moduletype with
+          | Some path -> Some (wrapInQuotes path)
+          | None -> None );
         ("docstrings", Some (stringifyDocstrings m.docstring));
         ( "source",
           Some (stringifySource ~indentation:(indentation + 1) m.source) );
@@ -356,6 +368,7 @@ let extractDocs ~entryPointFile ~debug =
             id = modulePath |> List.rev |> ident;
             docstring = structure.docstring |> List.map String.trim;
             name = structure.name;
+            moduletype = None;
             deprecated = structure.deprecated;
             source =
               {
@@ -439,6 +452,7 @@ let extractDocs ~entryPointFile ~debug =
                             {
                               id = modulePath |> List.rev |> ident;
                               name = m.name;
+                              moduletype = None;
                               docstring = item.docstring @ m.docstring;
                               deprecated = item.deprecated;
                               source;
@@ -469,12 +483,13 @@ let extractDocs ~entryPointFile ~debug =
                             (extractDocsForModule
                                ~modulePath:(interface.name :: modulePath)
                                interface))
-                     | Module {type_ = Constraint (Structure m, Ident _)} ->
-                       (* module M: T = {  }. Print M *)
-                       Some
-                         (Module
-                            (extractDocsForModule
-                               ~modulePath:(m.name :: modulePath) m))
+                     | Module {type_ = Constraint (Structure m, Ident p)} ->
+                       (* module M: T = { <impl> }. Print M *)
+                       let docs =
+                         extractDocsForModule ~modulePath:(m.name :: modulePath)
+                           m
+                       in
+                       Some (Module {docs with moduletype = Some (Path.name p)})
                      | _ -> None);
           }
         in

tools/tests/src/expected/DocExtractionRes.res.json

@@ -311,6 +311,7 @@
     "id": "DocExtractionRes.M",
     "name": "M",
     "kind": "module",
+    "moduletype": "Example",
     "docstrings": ["implementation of Example module type"],
     "source": {
       "filepath": "src/DocExtractionRes.res",