fix how fsx outputs display inline html

Author: nhirschey

src/FSharp.Formatting.Literate/Literate.fs

@@ -568,18 +568,16 @@ type Literate private () =
             rootInputFolder,
             crefResolver,
             mdlinkResolver,
-            parseOptions,
             onError,
             filesWithFrontMatter: FrontMatterFile array
         ) =
 
         let parseOptions =
             match outputKind with
-            | OutputKind.Markdown
             | OutputKind.Fsx
-            | OutputKind.Pynb -> parseOptions ||| MarkdownParseOptions.ParseCodeAsOther
-            //||| MarkdownParseOptions.ParseNonCodeAsOther
-            | _ -> parseOptions
+            | OutputKind.Pynb -> 
+                (MarkdownParseOptions.ParseCodeAsOther)
+            | _ -> MarkdownParseOptions.None
 
         let fsx = ParsePynb.pynbToFsx input
 

src/FSharp.Formatting.Literate/ParsePynb.fs

@@ -25,6 +25,7 @@ module internal ParsePynb =
                 | Some outputs ->
                     let outputsString = outputs |> String.concat "\n"
                     sprintf $"{codeBlock}\n{outputsString}"
+
         member this.ToFsx() =
             match this with
             | Markdown source -> $"(**\n{source}\n*)"
@@ -36,14 +37,17 @@ module internal ParsePynb =
                 | Some outputs ->
                     let outputsString = outputs |> String.concat "\n"
                     sprintf $"{codeBlock}\n(**\n{outputsString}\n*)"
-            | Code _ ->
-                $"(**\n{this.ToMarkdown()}\n*)" 
+            | Code _ -> $"(**\n{this.ToMarkdown()}\n*)"
 
     module Output =
         let (|TextHtml|_|) (x: JsonElement) =
             match x.TryGetProperty("text/html") with
             | true, html ->
-                let html = html.EnumerateArray() |> Seq.map (fun x -> x.GetString()) |> String.concat "\n"
+                let html =
+                    html.EnumerateArray()
+                    |> Seq.map (fun x -> x.GetString().Replace("\r\n", "\n") |> addLineEnd)
+                    |> String.concat ""
+
                 Some $"<p>{html}</p>"
             | _ -> None
 

src/FSharp.Formatting.Markdown/FsxFormatting.fs

@@ -6,12 +6,43 @@ module internal FSharp.Formatting.Markdown.FsxFormatting
 
 open MarkdownUtils
 
+/// Like MarkdownUtils.isCode, but does not treat InlineHtmlBlock as code
+let isFsxCode =
+    (function
+    | CodeBlock _ -> true
+    | _ -> false)
+
+/// Like MarkdownUtils.splitParagraphs, but does not treat InlineHtmlBlock as code
+let splitFsxParagraphs paragraphs =
+    let firstCode = paragraphs |> List.tryFindIndex isFsxCode
+
+    match firstCode with
+    | Some 0 ->
+        let code = paragraphs.[0]
+        let codeLines = getCode code
+        let otherParagraphs = paragraphs.[1..]
+
+        // Collect the code output(s) that follows this cell if any
+        let codeOutput = otherParagraphs |> List.takeWhile isCodeOutput |> List.map getCodeOutput
+
+        let otherParagraphs = otherParagraphs |> List.skipWhile isCodeOutput
+
+        Choice1Of2(codeLines, codeOutput, getExecutionCount code), otherParagraphs
+
+    | Some _
+    | None ->
+        let markdownParagraphs = paragraphs |> List.takeWhile (isFsxCode >> not)
+
+        let otherParagraphs = paragraphs |> List.skipWhile (isFsxCode >> not)
+
+        Choice2Of2 markdownParagraphs, otherParagraphs
+
 /// Write a list of MarkdownParagraph values to a TextWriter
 let rec formatParagraphs ctx paragraphs =
     match paragraphs with
     | [] -> []
     | _ ->
-        let k, otherParagraphs = splitParagraphs paragraphs
+        let k, otherParagraphs = splitFsxParagraphs paragraphs
 
         let cell =
             match k with

src/fsdocs-tool/BuildCommand.fs

@@ -422,7 +422,6 @@ type internal DocContent
                                   rootInputFolder = rootInputFolder,
                                   crefResolver = crefResolver,
                                   mdlinkResolver = mdlinkResolver,
-                                  parseOptions = MarkdownParseOptions.AllowYamlFrontMatter,
                                   onError = Some onError,
                                   filesWithFrontMatter = filesWithFrontMatter
                               )

tests/FSharp.Literate.Tests/LiterateTests.fs

@@ -1359,7 +1359,7 @@ let hello5 = 4 // Doc preparation code is not present in generated notebooks
 
 [<Test>]
 let ``Notebook output is exactly right`` () =
-    let md =
+    let doc =
         Literate.ParseScriptString(
             """
 let hello = 1
@@ -1371,7 +1371,7 @@ let goodbye = 2
                  ||| MarkdownParseOptions.ParseNonCodeAsOther)
         )
 
-    let pynb = Literate.ToPynb(md)
+    let pynb = Literate.ToPynb(doc)
     printfn "----"
     printfn "%s" pynb
     printfn "----"
@@ -1433,6 +1433,192 @@ let goodbye = 2
 
     pynb2 |> shouldEqual expected2
 
+[<Test>]
+let ``pynb outputs passed to script correctly`` () =
+
+    let input =
+        """{
+ "cells": [
+  {
+   "cell_type": "markdown",
+   "metadata": {
+    "dotnet_repl_cellExecutionStartTime": "2023-11-22T09:25:48.0570832+00:00",
+    "dotnet_repl_cellExecutionEndTime": "2023-11-22T09:25:48.0798154+00:00"
+   },
+   "source": [
+    "words"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {
+    "dotnet_repl_cellExecutionStartTime": "2023-11-22T09:25:48.081018+00:00",
+    "dotnet_repl_cellExecutionEndTime": "2023-11-22T09:25:50.1467326+00:00",
+    "dotnet_interactive": {
+     "language": "fsharp"
+    },
+    "polyglot_notebook": {
+     "kernelName": "fsharp"
+    }
+   },
+   "outputs": [
+    {
+     "data": {
+      "text/html": [
+       "<details open=\"open\" class=\"dni-treeview\"><summary><span class=\"dni-code-hint\"><code>{ Name = &quot;Alf&quot;\\n  Phone = &quot;(555) 555-5555&quot;\\n  ZipCode = &quot;90210&quot; }</code></span></summary><div><table><thead><tr></tr></thead><tbody><tr><td>Name</td><td><div class=\"dni-plaintext\"><pre>&quot;Alf&quot;\r\n",
+       "</pre></div></td></tr><tr><td>Phone</td><td><div class=\"dni-plaintext\"><pre>&quot;(555) 555-5555&quot;\r\n",
+       "</pre></div></td></tr><tr><td>ZipCode</td><td><div class=\"dni-plaintext\"><pre>&quot;90210&quot;\r\n",
+       "</pre></div></td></tr></tbody></table></div></details><style>\r\n",
+       ".dni-code-hint {\r\n",
+       "    font-style: italic;\r\n",
+       "    overflow: hidden;\r\n",
+       "    white-space: nowrap;\r\n",
+       "}\r\n",
+       ".dni-treeview {\r\n",
+       "    white-space: nowrap;\r\n",
+       "}\r\n",
+       ".dni-treeview td {\r\n",
+       "    vertical-align: top;\r\n",
+       "    text-align: start;\r\n",
+       "}\r\n",
+       "details.dni-treeview {\r\n",
+       "    padding-left: 1em;\r\n",
+       "}\r\n",
+       "table td {\r\n",
+       "    text-align: start;\r\n",
+       "}\r\n",
+       "table tr { \r\n",
+       "    vertical-align: top; \r\n",
+       "    margin: 0em 0px;\r\n",
+       "}\r\n",
+       "table tr td pre \r\n",
+       "{ \r\n",
+       "    vertical-align: top !important; \r\n",
+       "    margin: 0em 0px !important;\r\n",
+       "} \r\n",
+       "table th {\r\n",
+       "    text-align: start;\r\n",
+       "}\r\n",
+       "</style>"
+      ]
+     },
+     "metadata": {},
+     "output_type": "display_data"
+    }
+   ],
+   "source": [
+    "type ContactCard =\n",
+    "    { Name: string\n",
+    "      Phone: string\n",
+    "      ZipCode: string }\n",
+    "\n",
+    "// Create a new record\n",
+    "{ Name = \"Alf\"; Phone = \"(555) 555-5555\"; ZipCode = \"90210\" }"
+   ]
+  }
+ ],
+ "metadata": {
+  "kernelspec": {
+   "display_name": ".NET (F#)",
+   "language": "F#",
+   "name": ".net-fsharp"
+  },
+  "language_info": {
+   "file_extension": ".fs",
+   "mimetype": "text/x-fsharp",
+   "name": "F#",
+   "pygments_lexer": "fsharp",
+   "version": "6.0"
+  },
+  "polyglot_notebook": {
+   "defaultKernelName": "fsharp",
+   "items": [
+    {
+     "name": "fsharp"
+    }
+   ]
+  },
+  "dotnet_interactive": {
+   "defaultKernelName": "fsharp",
+   "items": [
+    {
+     "name": "fsharp"
+    }
+   ]
+  }
+ },
+ "nbformat": 4,
+ "nbformat_minor": 5
+}"""
+
+    let doc = Literate.ParsePynbString(input, parseOptions = (MarkdownParseOptions.ParseCodeAsOther))
+
+    let fsx = Literate.ToFsx(doc)
+    printfn "----"
+    printfn "%s" fsx
+    printfn "----"
+
+    let fsx2 =
+        fsx
+            .Replace("\r\n", "\n")
+            .Replace(" \n", "\n")
+            .Replace("\n\n*)", "\n*)")
+            .Replace("\n", "!")
+
+    let expected =
+        """(**
+words
+*)
+type ContactCard =
+    { Name: string
+      Phone: string
+      ZipCode: string }
+
+// Create a new record
+{ Name = "Alf"; Phone = "(555) 555-5555"; ZipCode = "90210" }
+(**
+<p><details open="open" class="dni-treeview"><summary><span class="dni-code-hint"><code>{ Name = &quot;Alf&quot;\n  Phone = &quot;(555) 555-5555&quot;\n  ZipCode = &quot;90210&quot; }</code></span></summary><div><table><thead><tr></tr></thead><tbody><tr><td>Name</td><td><div class="dni-plaintext"><pre>&quot;Alf&quot;
+</pre></div></td></tr><tr><td>Phone</td><td><div class="dni-plaintext"><pre>&quot;(555) 555-5555&quot;
+</pre></div></td></tr><tr><td>ZipCode</td><td><div class="dni-plaintext"><pre>&quot;90210&quot;
+</pre></div></td></tr></tbody></table></div></details><style>
+.dni-code-hint {
+    font-style: italic;
+    overflow: hidden;
+    white-space: nowrap;
+}
+.dni-treeview {
+    white-space: nowrap;
+}
+.dni-treeview td {
+    vertical-align: top;
+    text-align: start;
+}
+details.dni-treeview {
+    padding-left: 1em;
+}
+table td {
+    text-align: start;
+}
+table tr {
+    vertical-align: top;
+    margin: 0em 0px;
+}
+table tr td pre
+{
+    vertical-align: top !important;
+    margin: 0em 0px !important;
+}
+table th {
+    text-align: start;
+}
+</style>
+</p>
+*)"""
+
+    let expected2 = expected.Replace("\r\n", "\n").Replace("\n", "!")
+    fsx2 |> shouldEqual expected2
+
 [<Test>]
 let ``md --> pynb --> md comes back the same`` () =
     let mdIn =
@@ -1471,7 +1657,7 @@ let add a b = a + b
 let ``Notebook is converted to script exactly right`` () =
     let doc =
         Literate.ParsePynbString(
-                    """
+            """
 {
  "cells": [
   {
@@ -1533,7 +1719,7 @@ let ``Notebook is converted to script exactly right`` () =
     let fsx2 = fsx.Replace("\r\n", "\n").Replace("\n", "!")
 
     let expected =
-            """let hello = 1
+        """let hello = 1
 
 let goodbye = 2"""