Merge pull request #15 from MangelMaxime/main

Exposed an equivalent to `allReleaseNotesFor` from the Ionide.KeepAChangelog package

Author: baronfel

src/Ionide.KeepAChangelog.Tasks/Library.fs

@@ -17,23 +17,6 @@ module Util =
         item.ItemSpec <- "Unreleased"
         item
 
-    let allReleaseNotesFor (data: ChangelogData) =
-        let section name items =
-            match items with
-            | [] -> []
-            | items -> $"### {name}" :: items @ [ "" ]
-
-        String.concat
-            System.Environment.NewLine
-            ([ yield! section "Added" data.Added
-               yield! section "Changed" data.Changed
-               yield! section "Deprecated" data.Deprecated
-               yield! section "Removed" data.Removed
-               yield! section "Fixed" data.Fixed
-               yield! section "Security" data.Security
-               for KeyValue(heading, lines) in data.Custom do
-                 yield! section heading lines ])
-
     let stitch items =
         String.concat System.Environment.NewLine items
 
@@ -104,7 +87,7 @@ type ParseChangelogs() =
                 |> Option.iter (fun (version, date, data) ->
                     data
                     |> Option.iter (fun data ->
-                        this.LatestReleaseNotes <- Util.allReleaseNotesFor data)
+                        this.LatestReleaseNotes <- data.ToMarkdown())
                     )
 
                 true

src/Ionide.KeepAChangelog/Library.fs

@@ -3,7 +3,7 @@
 module Domain =
     open SemVersion
     open System
-    
+
     // TODO: a changelog entry may have a description?
     type ChangelogData =
         { Added: string list
@@ -22,6 +22,39 @@ module Domain =
               Security = []
               Custom = Map.empty }
 
+        member this.ToMarkdown () =
+
+            let renderItems (items : string list) =
+                items
+                |> List.map (fun item ->
+                    "* " + item
+                )
+                |> String.concat Environment.NewLine
+
+            let section name items =
+                match items with
+                | [] -> []
+                | items ->
+                    $"### {name}"
+                    + Environment.NewLine
+                    + Environment.NewLine
+                    + (renderItems items)
+                    + Environment.NewLine
+                    |> List.singleton
+
+            String.concat
+                Environment.NewLine
+                [
+                    yield! section "Added" this.Added
+                    yield! section "Changed" this.Changed
+                    yield! section "Deprecated" this.Deprecated
+                    yield! section "Removed" this.Removed
+                    yield! section "Fixed" this.Fixed
+                    yield! section "Security" this.Security
+                    for KeyValue(heading, lines) in this.Custom do
+                        yield! section heading lines
+                ]
+
     type Changelogs =
         { Unreleased: ChangelogData option
           Releases: (SemanticVersion * DateTime * ChangelogData option) list }
@@ -89,9 +122,9 @@ module Parser =
 
             let rest = opt (many1 (attempt followingLine))
 
-            pipe2 firstLine rest (fun f rest -> 
+            pipe2 firstLine rest (fun f rest ->
                 match rest with
-                | None -> f 
+                | None -> f
                 | Some parts -> String.concat " " (f :: parts))
             <?> "line item"
 
@@ -183,25 +216,25 @@ module Parser =
             |> attempt
 
 
-        let pMonth = 
+        let pMonth =
             pint32
             |> attempt
 
-        let pDay = 
+        let pDay =
             pint32
             |> attempt
 
-        let ymdDashes = 
+        let ymdDashes =
             let dash = pchar '-'
             pipe5 pYear dash pMonth dash pDay (fun y _ m _ d -> System.DateTime(y, m, d))
 
 
-        let dmyDots = 
+        let dmyDots =
             let dot = pchar '.'
             pipe5 pDay dot pMonth dot pYear (fun d _ m _ y -> System.DateTime(y, m, d))
 
         attempt dmyDots <|> ymdDashes
-            
+
 
     let pVersion = mdUrl pSemver <|> pSemver
 
@@ -219,7 +252,7 @@ module Parser =
                      match unreleased with
                      | None -> None
                      | Some u when u = ChangelogData.Default -> None
-                     | Some unreleased -> Some unreleased 
+                     | Some unreleased -> Some unreleased
         pipe3
             pHeader
             (attempt (opt unreleased))

test/Ionide.KeepAChangelog.Test/Program.fs

@@ -18,8 +18,8 @@ let singleRelease =
 
 """
 
-let singleReleaseExpected = 
-    (SemanticVersion.Parse "1.0.0", DateTime(2017, 06, 20), Some { 
+let singleReleaseExpected =
+    (SemanticVersion.Parse "1.0.0", DateTime(2017, 06, 20), Some {
             ChangelogData.Default with
                 Added = ["- A"]
                 Changed = ["- B"]
@@ -53,7 +53,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 """
 
-let keepAChangelogExpected: Changelogs = 
+let keepAChangelogExpected: Changelogs =
     {
         Unreleased = None
         Releases = [
@@ -89,7 +89,7 @@ let sample1Release = """## [0.3.1] - 8.1.2022
 
 """
 
-let sample1ReleaseExpected = 
+let sample1ReleaseExpected =
     SemanticVersion.Parse "0.3.1", DateTime(2022, 1, 8), Some { ChangelogData.Default with Added = ["- Add XmlDocs to the generated package"] }
 
 let sample = """# Changelog
@@ -141,20 +141,19 @@ let runSuccess label p text expected =
     test $"parsing {label}" {
 
         match FParsec.CharParsers.run p text with
-        | FParsec.CharParsers.Success (r, _, _) -> 
+        | FParsec.CharParsers.Success (r, _, _) ->
             Expect.equal r expected "Should have produced expected value"
-        | FParsec.CharParsers.Failure (m, _, _) -> 
+        | FParsec.CharParsers.Failure (m, _, _) ->
             failwithf "%A" m
     }
 
-[<Tests>]
-let tests = testList "parsing examples" [
+let parsingExamples = testList "parsing examples" [
     runSuccess "line entry" Parser.pEntry "- A" "- A"
     runSuccess "header" Parser.pHeader header ()
     runSuccess "unreleased" Parser.pUnreleased emptyUnreleased None
     runSuccess "header and unreleased" (Parser.pHeader >>. Parser.pUnreleased) headerAndUnreleased None
-    runSuccess "release" Parser.pRelease singleRelease singleReleaseExpected 
-    runSuccess "sample 1 release" Parser.pRelease sample1Release sample1ReleaseExpected 
+    runSuccess "release" Parser.pRelease singleRelease singleReleaseExpected
+    runSuccess "sample 1 release" Parser.pRelease sample1Release sample1ReleaseExpected
     runSuccess
         "header and unreleased and released"
         (Parser.pHeader >>. Parser.pUnreleased
@@ -167,6 +166,77 @@ let tests = testList "parsing examples" [
     runSuccess "lsp changelog" Parser.pChangeLogs sample sampleExpected
 ]
 
+let changelogDataTest =
+    test "Transform ChangelogData to Markdown" {
+        let changelogData =
+            {
+                Added = [ "Added line 1"; "Added line 2" ]
+                Changed = [ "Changed line 1"; "Changed line 2" ]
+                Deprecated = [ "Deprecated line 1"; "Deprecated line 2" ]
+                Removed = [ "Removed line 1"; "Removed line 2" ]
+                Fixed = [ "Fixed line 1"; "Fixed line 2" ]
+                Security = [ "Security line 1"; "Security line 2" ]
+                Custom =
+                    [
+                        "CustomHeaderA", [ "Custom line 1"; "Custom line 2" ]
+                        "CustomHeaderB", [ "Custom line 3"; "Custom line 4" ]
+                    ]
+                    |> Map.ofList
+            }
+
+        printfn "%A" (changelogData.ToMarkdown())
+
+        let expected =
+            """### Added
+
+* Added line 1
+* Added line 2
+
+### Changed
+
+* Changed line 1
+* Changed line 2
+
+### Deprecated
+
+* Deprecated line 1
+* Deprecated line 2
+
+### Removed
+
+* Removed line 1
+* Removed line 2
+
+### Fixed
+
+* Fixed line 1
+* Fixed line 2
+
+### Security
+
+* Security line 1
+* Security line 2
+
+### CustomHeaderA
+
+* Custom line 1
+* Custom line 2
+
+### CustomHeaderB
+
+* Custom line 3
+* Custom line 4
+"""
+
+        Expect.equal (changelogData.ToMarkdown()) expected "Should have produced expected value"
+}
+
+[<Tests>]
+let tests = testList "All" [
+    parsingExamples
+    changelogDataTest
+]
+
 [<EntryPoint>]
-let main argv = 
-    runTestsWithCLIArgs Seq.empty argv tests
+let main argv =
+    runTestsWithCLIArgs Seq.empty argv tests