" + ctx.Newline) - | IndirectLink(body, _, LookupKey ctx.Links (link, title), _) - | DirectLink(body, link, title, _) -> + | IndirectLink(body, _, LookupKey ctx.Links (link, title), _) + | DirectLink(body, link, title, _) -> ctx.Writer.Write(" ctx.Writer.Write("\" title=\"") ctx.Writer.Write(htmlEncodeQuotes title) @@ -101,13 +101,13 @@ let rec internal formatSpan (ctx:FormattingContext) span = ctx.Writer.Write("]") ctx.Writer.Write(original) - | IndirectImage(body, _, LookupKey ctx.Links (link, title), _) - | DirectImage(body, link, title, _) -> + | IndirectImage(body, _, LookupKey ctx.Links (link, title), _) + | DirectImage(body, link, title, _) -> ctx.Writer.Write("
")
ctx.Writer.Write(htmlEncode body)
ctx.Writer.Write("")
- | Emphasis(body, _) ->
+ | Emphasis(body, _) ->
ctx.Writer.Write("")
formatSpans ctx body
ctx.Writer.Write("")
@@ -142,7 +142,7 @@ let internal formatAnchor (ctx:FormattingContext) (spans:MarkdownSpans) =
|> Seq.cast\\[" + (htmlEncode body) + "\\]
") | EmbedParagraphs(cmd, _) -> formatParagraphs ctx (cmd.Render()) - | Heading(n, spans, _) -> + | Heading(n, spans, _) -> ctx.Writer.Write("") - for span in spans do + for span in spans do formatSpan ctx span ctx.Writer.Write("
") | HorizontalRule(_, _) -> @@ -266,7 +266,7 @@ let rec internal formatParagraph (ctx:FormattingContext) paragraph = formatParagraphs { ctx with ParagraphIndent = fun () -> ctx.ParagraphIndent() (*; ctx.Writer.Write(" ")*) } body ctx.ParagraphIndent() ctx.Writer.Write("") - | Span(spans, _) -> + | Span(spans, _) -> formatSpans ctx spans | InlineHtmlBlock(code, _, _) -> ctx.Writer.Write(code) @@ -276,24 +276,24 @@ let rec internal formatParagraph (ctx:FormattingContext) paragraph = for (code, _) in lines do ctx.Writer.Write(htmlEncode code) ctx.Writer.Write("") - | YamlFrontmatter (lines, _) -> () + | YamlFrontmatter (_lines, _) -> () ctx.LineBreak() /// Write a list of MarkdownParagraph values to a TextWriter -and internal formatParagraphs ctx paragraphs = +and internal formatParagraphs ctx paragraphs = let length = List.length paragraphs let smallCtx = { ctx with LineBreak = smallBreak ctx } let bigCtx = { ctx with LineBreak = bigBreak ctx } for last, paragraph in paragraphs |> Seq.mapi (fun i v -> (i = length - 1), v) do formatParagraph (if last then smallCtx else bigCtx) paragraph -/// Format Markdown document and write the result to +/// Format Markdown document and write the result to /// a specified TextWriter. Parameters specify newline character /// and a dictionary with link keys defined in the document. -let formatMarkdown writer generateAnchors wrap links substitutions newline crefResolver paragraphs = +let formatMarkdown writer generateAnchors wrap links substitutions newline crefResolver paragraphs = let ctx = { Links = links; Substitutions=substitutions; Newline=newline; ResolveApiDocReference=crefResolver; DefineSymbol="HTML" } let paragraphs = applySubstitutionsInMarkdown ctx paragraphs - formatParagraphs + formatParagraphs { Writer = writer Links = links Newline = newline diff --git a/src/FSharp.Formatting.Markdown/LatexFormatting.fs b/src/FSharp.Formatting.Markdown/LatexFormatting.fs index 433476728..3d1a77e2f 100644 --- a/src/FSharp.Formatting.Markdown/LatexFormatting.fs +++ b/src/FSharp.Formatting.Markdown/LatexFormatting.fs @@ -29,18 +29,18 @@ let specialChars = @"<\textbackslash>", @"{\textbackslash}"; "~",@"{\textasciitilde}"; "^", @"{\textasciicircum}" |] - + let latexEncode s = specialChars |> Array.fold (fun (acc:string) (k, v) -> acc.Replace(k, v)) (System.Net.WebUtility.HtmlDecode s) /// Lookup a specified key in a dictionary, possibly /// ignoring newlines or spaces in the key. -let (|LookupKey|_|) (dict:IDictionary<_, _>) (key:string) = - [ key; key.Replace("\r\n", ""); key.Replace("\r\n", " "); +let (|LookupKey|_|) (dict:IDictionary<_, _>) (key:string) = + [ key; key.Replace("\r\n", ""); key.Replace("\r\n", " "); key.Replace("\n", ""); key.Replace("\n", " ") ] |> Seq.tryPick (fun key -> match dict.TryGetValue(key) with - | true, v -> Some v + | true, v -> Some v | _ -> None) /// Context passed around while formatting the LaTEX @@ -55,7 +55,7 @@ let smallBreak (ctx:FormattingContext) () = let noBreak (_ctx:FormattingContext) () = () /// Write MarkdownSpan value to a TextWriter -let rec formatSpan (ctx:FormattingContext) = function +let rec formatSpan (ctx:FormattingContext) = function | LatexInlineMath(body, _) -> ctx.Writer.Write(sprintf "$%s$" body) | LatexDisplayMath(body, _) -> ctx.Writer.Write(sprintf "$$%s$$" body) | EmbedSpans(cmd, _) -> formatSpans ctx (cmd.Render()) @@ -63,7 +63,7 @@ let rec formatSpan (ctx:FormattingContext) = function | HardLineBreak(_) -> ctx.LineBreak(); ctx.LineBreak() | AnchorLink _ -> () - | IndirectLink(body, _, LookupKey ctx.Links (link, _), _) + | IndirectLink(body, _, LookupKey ctx.Links (link, _), _) | DirectLink(body, link, _, _) | IndirectLink(body, link, _, _) -> ctx.Writer.Write(@"\href{") @@ -72,8 +72,8 @@ let rec formatSpan (ctx:FormattingContext) = function formatSpans ctx body ctx.Writer.Write("}") - | IndirectImage(body, _, LookupKey ctx.Links (link, _), _) - | DirectImage(body, link, _, _) + | IndirectImage(body, _, LookupKey ctx.Links (link, _), _) + | DirectImage(body, link, _, _) | IndirectImage(body, link, _, _) -> // Use the technique introduced at // http://stackoverflow.com/q/14014827 @@ -82,7 +82,7 @@ let rec formatSpan (ctx:FormattingContext) = function ctx.LineBreak() ctx.Writer.Write(@"\includegraphics[width=1.0\textwidth]{") ctx.Writer.Write(latexEncode link) - ctx.Writer.Write("}") + ctx.Writer.Write("}") ctx.LineBreak() if not (System.String.IsNullOrWhiteSpace(body)) then ctx.Writer.Write(@"\caption{") @@ -92,15 +92,15 @@ let rec formatSpan (ctx:FormattingContext) = function ctx.Writer.Write(@"\end{figure}") ctx.LineBreak() - | Strong(body, _) -> + | Strong(body, _) -> ctx.Writer.Write(@"\textbf{") formatSpans ctx body ctx.Writer.Write("}") - | InlineCode(body, _) -> + | InlineCode(body, _) -> ctx.Writer.Write(@"\texttt{") ctx.Writer.Write(latexEncode body) ctx.Writer.Write("}") - | Emphasis(body, _) -> + | Emphasis(body, _) -> ctx.Writer.Write(@"\emph{") formatSpans ctx body ctx.Writer.Write("}") @@ -121,8 +121,8 @@ let rec formatParagraph (ctx:FormattingContext) paragraph = ctx.LineBreak(); ctx.LineBreak() | EmbedParagraphs(cmd, _) -> formatParagraphs ctx (cmd.Render()) - | Heading(n, spans, _) -> - let level = + | Heading(n, spans, _) -> + let level = match n with | 1 -> @"\section*" | 2 -> @"\subsection*" @@ -136,7 +136,7 @@ let rec formatParagraph (ctx:FormattingContext) paragraph = ctx.LineBreak() | Paragraph(spans, _) -> ctx.LineBreak(); ctx.LineBreak() - for span in spans do + for span in spans do formatSpan ctx span | HorizontalRule(_) -> @@ -169,11 +169,11 @@ let rec formatParagraph (ctx:FormattingContext) paragraph = ctx.LineBreak() let bodyCtx = { ctx with LineBreak = noBreak ctx } - let formatRow (prefix:string) (postfix:string) row = + let formatRow (prefix:string) (postfix:string) row = row |> Seq.iteri (fun i cell -> if i <> 0 then ctx.Writer.Write(" & ") ctx.Writer.Write(prefix) - cell |> List.iter (formatParagraph bodyCtx) + cell |> List.iter (formatParagraph bodyCtx) ctx.Writer.Write(postfix) ) for header in Option.toList headers do @@ -205,7 +205,7 @@ let rec formatParagraph (ctx:FormattingContext) paragraph = ctx.Writer.Write(@"\end{quote}") ctx.LineBreak() - | Span(spans, _) -> + | Span(spans, _) -> formatSpans ctx spans | InlineHtmlBlock(code, _executionCount, _) -> ctx.Writer.Write(code) @@ -217,23 +217,23 @@ let rec formatParagraph (ctx:FormattingContext) paragraph = ctx.LineBreak() ctx.Writer.Write(@"\end{lstlisting}") ctx.LineBreak() - | YamlFrontmatter (lines, _) -> () + | YamlFrontmatter (_lines, _) -> () ctx.LineBreak() /// Write a list of MarkdownParagraph values to a TextWriter -and formatParagraphs ctx paragraphs = +and formatParagraphs ctx paragraphs = let length = List.length paragraphs let ctx = { ctx with LineBreak = smallBreak ctx } for _last, paragraph in paragraphs |> Seq.mapi (fun i v -> (i = length - 1), v) do formatParagraph ctx paragraph -/// Format Markdown document and write the result to +/// Format Markdown document and write the result to /// a specified TextWriter. Parameters specify newline character /// and a dictionary with link keys defined in the document. -let formatMarkdown writer links replacements newline crefResolver paragraphs = +let formatMarkdown writer links replacements newline crefResolver paragraphs = let ctx = { Links = links; Substitutions=replacements; Newline=newline; ResolveApiDocReference=crefResolver; DefineSymbol="LATEX" } let paragraphs = applySubstitutionsInMarkdown ctx paragraphs - formatParagraphs + formatParagraphs { Writer = writer Links = links Newline = newline diff --git a/tests/FSharp.ApiDocs.Tests/AttributeTests.fs b/tests/FSharp.ApiDocs.Tests/AttributeTests.fs index f299ab05d..eac3f9326 100644 --- a/tests/FSharp.ApiDocs.Tests/AttributeTests.fs +++ b/tests/FSharp.ApiDocs.Tests/AttributeTests.fs @@ -7,7 +7,6 @@ open NUnit.Framework open FSharp.Formatting.ApiDocs open FSharp.Formatting.Templating open FsUnitTyped -open FSharp.Compiler.SourceCodeServices open NUnit.Framework.Internal open System @@ -28,27 +27,22 @@ let configuration = "Release" #endif -let tfm = -#if NETCOREAPP - "netstandard2.1" -#else - "net472" -#endif +let tfm = "netstandard2.1" // NOTE - For these tests to run properly they require the output of all the metadata // test project to be directed to the directory below let testBin = __SOURCE_DIRECTORY__ "files/bin" configuration tfm |> fullpath -#if INTERACTIVE +#if INTERACTIVE ;; printfn "\n-- Root - %s" root;; printfn "\n-- TestBin - %s" testBin;; -#endif +#endif do FSharp.Formatting.TestHelpers.enableLogging() let library = testBin "AttributesTestLib.dll" -let inputs = ApiDocInput.FromFile(library) +let inputs = ApiDocInput.FromFile(library) let findModule name (moduleInfos: ApiDocEntityInfo list)= moduleInfos @@ -104,12 +98,12 @@ let ``ApiDocs extracts Attribute with named arguments``() = attribute.Name |> shouldEqual "TestAttribute" attribute.FullName |> shouldEqual "AttributeTestNamespace.TestAttribute" attribute.ConstructorArguments |> shouldBeEmpty - + attribute.NamedConstructorArguments |> shouldContain ("Int", box 1) attribute.NamedConstructorArguments |> shouldContain ("String", box "test") let _,arrayArgument = attribute.NamedConstructorArguments |> Seq.find (fun (n,_)-> n="Array") arrayArgument |> shouldEqual (box [| box "1"; box "2"|]) - () + () [