rename constructor payload field and prepare for potentially adding more detail for other constructor payload types as well

Author: zth

analysis/src/DocExtraction.ml

@@ -6,12 +6,14 @@ type fieldDoc = {
   deprecated: string option;
 }
 
+type constructorPayload = InlineRecord of {fieldDocs: fieldDoc list}
+
 type constructorDoc = {
   constructorName: string;
   docstrings: string list;
   signature: string;
   deprecated: string option;
-  inlineRecordFields: fieldDoc list option;
+  items: constructorPayload option;
 }
 
 type docItemDetail =
@@ -69,6 +71,21 @@ let stringifyFieldDoc ~indentation (fieldDoc : fieldDoc) =
       ("signature", Some (wrapInQuotes fieldDoc.signature));
     ]
 
+let stringifyConstructorPayload ~indentation
+    (constructorPayload : constructorPayload) =
+  let open Protocol in
+  match constructorPayload with
+  | InlineRecord {fieldDocs} ->
+    stringifyObject ~indentation:(indentation + 1)
+      [
+        ("kind", Some (wrapInQuotes "inlineRecord"));
+        ( "fields",
+          Some
+            (fieldDocs
+            |> List.map (stringifyFieldDoc ~indentation:(indentation + 1))
+            |> array) );
+      ]
+
 let stringifyDetail ?(indentation = 0) (detail : docItemDetail) =
   let open Protocol in
   match detail with
@@ -101,16 +118,14 @@ let stringifyDetail ?(indentation = 0) (detail : docItemDetail) =
                          Some (stringifyDocstrings constructorDoc.docstrings) );
                        ( "signature",
                          Some (wrapInQuotes constructorDoc.signature) );
-                       ( "inlineRecordFields",
-                         match constructorDoc.inlineRecordFields with
+                       ( "items",
+                         match constructorDoc.items with
                          | None -> None
-                         | Some fieldDocs ->
+                         | Some constructorPayload ->
                            Some
-                             (fieldDocs
-                             |> List.map
-                                  (stringifyFieldDoc
-                                     ~indentation:(indentation + 1))
-                             |> array) );
+                             (stringifyConstructorPayload
+                                ~indentation:(indentation + 1)
+                                constructorPayload) );
                      ])
             |> array) );
       ]
@@ -223,10 +238,12 @@ let typeDetail typ ~env ~full =
                       docstrings = c.docstring;
                       signature = CompletionBackEnd.showConstructor c;
                       deprecated = c.deprecated;
-                      inlineRecordFields =
+                      items =
                         (match c.args with
                         | InlineRecord fields ->
-                          Some (fields |> List.map fieldToFieldDoc)
+                          Some
+                            (InlineRecord
+                               {fieldDocs = fields |> List.map fieldToFieldDoc})
                         | _ -> None);
                     });
          })
@@ -325,7 +342,9 @@ let extractDocs ~path ~debug =
                           id;
                           name = item.name;
                           items;
-                          docstring = item.docstring @ internalDocstrings |> List.map String.trim;
+                          docstring =
+                            item.docstring @ internalDocstrings
+                            |> List.map String.trim;
                         })
                  | Module (Structure m) ->
                    (* module Whatever = {} in res or module Whatever: {} in resi. *)

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

@@ -130,17 +130,20 @@ extracting docs for src/DocExtractionRes.res
           "name": "SomeStuff",
           "docstrings": ["This has inline records..."],
           "signature": "SomeStuff({offline: bool, online?: bool})",
-          "inlineRecordFields": [{
-            "name": "offline",
-            "optional": false,
-            "docstrings": [],
-            "signature": "bool"
-          }, {
-            "name": "online",
-            "optional": true,
-            "docstrings": ["Is the user online?"],
-            "signature": "option<bool>"
-          }]
+          "items": {
+            "kind": "inlineRecord",
+            "fields": [{
+              "name": "offline",
+              "optional": false,
+              "docstrings": [],
+              "signature": "bool"
+            }, {
+              "name": "online",
+              "optional": true,
+              "docstrings": ["Is the user online?"],
+              "signature": "option<bool>"
+            }]
+          }
         }]
       }
     }, 

tools/src/Tools_Docgen.res

@@ -6,12 +6,15 @@ type field = {
   deprecated?: string,
 }
 
+@tag("kind")
+type constructorPayload = | @as("inlineRecord") InlineRecord({fields: array<field>})
+
 type constructor = {
   name: string,
   docstrings: array<string>,
   signature: string,
   deprecated?: string,
-  inlineRecordFields?: array<field>,
+  constructorPayload?: constructorPayload,
 }
 
 @tag("kind")

tools/src/Tools_Docgen.resi

@@ -5,12 +5,16 @@ type field = {
   optional: bool,
   deprecated?: string,
 }
+
+@tag("kind")
+type constructorPayload = | @as("inlineRecord") InlineRecord({fields: array<field>})
+
 type constructor = {
   name: string,
   docstrings: array<string>,
   signature: string,
   deprecated?: string,
-  inlineRecordFields?: array<field>,
+  constructorPayload?: constructorPayload,
 }
 @tag("kind")
 type detail =