Frontmatter: extract all frontmatters in a single page

Author: panglesd

src/model/comment.ml

@@ -145,19 +145,16 @@ let extract_frontmatter docs : _ =
       (fun line -> Astring.String.cut ~sep:":" line)
       lines
   in
-  let extracted =
-    let rec aux acc = function
-      | [] -> None
-      | doc :: l -> (
+  let fm, content =
+    let fm, rev_content =
+      List.fold_left
+        (fun (fm_acc, content_acc) doc ->
           match doc.Location_.value with
           | `Code_block (Some "frontmatter", content, None) ->
-              Some
-                ( parse_frontmatter content.Location_.value,
-                  List.rev_append acc l )
-          | _ -> aux (doc :: acc) l)
+              (parse_frontmatter content.Location_.value :: fm_acc, content_acc)
+          | _ -> (fm_acc, doc :: content_acc))
+        ([], []) docs
     in
-    aux [] docs
+    (List.concat fm, List.rev rev_content)
   in
-  match extracted with
-  | None -> (None, docs)
-  | Some (fm, docs) -> (Some fm, docs)
+  (fm, content)

src/model/lang.ml

@@ -532,7 +532,7 @@ module rec Page : sig
     root : Root.t;
     content : Comment.docs;
     children : child list;
-    frontmatter : Frontmatter.t option;
+    frontmatter : Frontmatter.t;
     digest : Digest.t;
     linked : bool;
   }

src/model/root.ml

@@ -32,7 +32,7 @@ module Odoc_file = struct
   type page = {
     name : string;
     title : Comment.link_content option;
-    frontmatter : Frontmatter.t option;
+    frontmatter : Frontmatter.t;
   }
 
   type t =

src/model/root.mli

@@ -31,7 +31,7 @@ module Odoc_file : sig
   type page = {
     name : string;
     title : Comment.link_content option;
-    frontmatter : Frontmatter.t option;
+    frontmatter : Frontmatter.t;
   }
 
   type t =
@@ -42,8 +42,7 @@ module Odoc_file : sig
 
   val create_unit : force_hidden:bool -> string -> t
 
-  val create_page :
-    string -> Comment.link_content option -> Frontmatter.t option -> t
+  val create_page : string -> Comment.link_content option -> Frontmatter.t -> t
 
   val create_impl : string -> t
 

src/model_desc/lang_desc.ml

@@ -697,10 +697,7 @@ and page_t =
     [
       F ("name", (fun t -> t.name), identifier);
       F ("root", (fun t -> t.root), root);
-      F
-        ( "frontmatter",
-          (fun t -> t.frontmatter),
-          Option (List (Pair (string, string))) );
+      F ("frontmatter", (fun t -> t.frontmatter), List (Pair (string, string)));
       F ("content", (fun t -> t.content), docs);
       F ("digest", (fun t -> t.digest), Digest.t);
     ]

test/pages/frontmatter.t/run.t

@@ -2,24 +2,22 @@ When there is no frontmatter, everything is normal
 
   $ odoc compile zero_frontmatter.mld
   $ odoc_print page-zero_frontmatter.odoc | jq '.frontmatter'
-  "None"
+  []
 
 When there is one frontmatter, it is extracted from the content:
 
   $ odoc compile one_frontmatter.mld
   $ odoc_print page-one_frontmatter.odoc | jq '.frontmatter'
-  {
-    "Some": [
-      [
-        "bli1",
-        " bloblobloblo1"
-      ],
-      [
-        "bli2",
-        " bloblobloblo2"
-      ]
+  [
+    [
+      "bli1",
+      " bloblobloblo1"
+    ],
+    [
+      "bli2",
+      " bloblobloblo2"
     ]
-  }
+  ]
   $ odoc_print page-one_frontmatter.odoc | jq '.content'
   [
     {
@@ -52,18 +50,20 @@ When there is more than one frontmatter, they are all extracted from the content
 
   $ odoc compile two_frontmatters.mld
   $ odoc_print page-two_frontmatters.odoc | jq '.frontmatter'
-  {
-    "Some": [
-      [
-        "bli1",
-        " bloblobloblo1"
-      ],
-      [
-        "bli2",
-        " bloblobloblo2"
-      ]
+  [
+    [
+      "bli3",
+      " bloblobloblo1"
+    ],
+    [
+      "bli1",
+      " bloblobloblo1"
+    ],
+    [
+      "bli2",
+      " bloblobloblo2"
     ]
-  }
+  ]
   $ odoc_print page-two_frontmatters.odoc | jq '.content'
   [
     {
@@ -89,13 +89,5 @@ When there is more than one frontmatter, they are all extracted from the content
           }
         ]
       ]
-    },
-    {
-      "`Code_block": [
-        {
-          "Some": "frontmatter"
-        },
-        "bli3: bloblobloblo1"
-      ]
     }
   ]