Update asciidoc diff output

This commit updates the diff asciidoc output to make assembly diff changes more readable within the Elastic documentation.

- Type changes are output as labelled list items
- Member changes are emitted as source code blocks

Author: russcam

build/scripts/Commandline.fsx

@@ -28,7 +28,7 @@ Targets:
 * canary [apikey] [feed]
   - create a canary nuget package based on the current version if [feed] and [apikey] are provided
     also pushes to upstream (myget)
-* diff <github|nuget|dir|assembly> <version|path 1> <version|path 2> [format]
+* diff <github|nuget|directories|assemblies> <version|path 1> <version|path 2> [format]
 
 NOTE: both the `test` and `integrate` targets can be suffixed with `-all` to force the tests against all suported TFM's
 

build/scripts/Differ.fsx

@@ -7,20 +7,18 @@
 #load @"Tooling.fsx"
 #load @"Projects.fsx"
 
+open Microsoft.FSharp.Reflection
 open System
-open System.IO
-
-open Fake 
-open System
+open System.Collections.Generic
 open System.IO
 open System.Linq
 open System.Net
 open System.Text
 open System.Text.RegularExpressions
 open System.Xml
 open System.Xml.Linq
+open Fake 
 open Fake.Git.CommandHelper
-
 open Paths
 open Projects
 open Tooling
@@ -264,42 +262,64 @@ module Differ =
         | :? XmlException -> ignore()
 
     let private convertToAsciidoc path first second = 
+        let createDiffDescription description (writer:TextWriter) =
+            let m = Regex.Match(description, "(.*?) changed from (.*?) to (.*).")
+            if m.Success then
+                let memberType = m.Groups.[1].Value
+                let o = m.Groups.[2].Value
+                let n = m.Groups.[3].Value
+                writer.WriteLine("+")
+                writer.WriteLine(sprintf "%s change" memberType)
+                writer.WriteLine("+")
+                writer.WriteLine("[source,csharp]")
+                writer.WriteLine("----")
+                writer.WriteLine(sprintf "// before in %s" first)
+                writer.WriteLine(sprintf "%s" o)
+                writer.WriteLine(sprintf "// now in %s" second)
+                writer.WriteLine(sprintf "%s" n)
+                writer.WriteLine("----")
+            else
+                writer.WriteLine(sprintf "%s" description)
+                               
         let name = path |> Path.GetFileNameWithoutExtension
         try
             let doc = XDocument.Load path
             let output = Path.ChangeExtension(path, "asciidoc")
             DeleteFile output
+            
             use file = File.OpenWrite <| output
             use writer = new StreamWriter(file)                
-            writer.WriteLine(name |> replace "." "-" |> sprintf "[[%s-breaking-changes]]")
+            writer.WriteLine(name |> replace "." "-" |> toLower |> sprintf "[[%s-breaking-changes]]")
             writer.WriteLine(sprintf "== Breaking changes for %s between %s and %s" name first second)
             writer.WriteLine()
 
             for element in (doc |> descendents "Type") do
                 let typeName = element |> attributeValue "Name" |> replace (sprintf "%s." name) ""
                 let diffType  = element |> attributeValue "DiffType" |> convertDiffType
+                
                 match diffType with
-                | Deleted -> writer.WriteLine(sprintf "[float]%s=== `%s` is deleted" Environment.NewLine typeName)
-                | New -> writer.WriteLine(sprintf "[float]%s=== `%s` is added" Environment.NewLine typeName)
+                | Deleted -> writer.WriteLine(sprintf "`%s`:: deleted" typeName)
+                | New -> writer.WriteLine(sprintf "`%s`:: added" typeName)
                 | Modified -> 
                     let members = Seq.append (element |> elements "Method") (element |> elements "Property")        
                     if Seq.isEmpty members |> not then          
-                        writer.WriteLine(sprintf "[float]%s=== `%s`" Environment.NewLine typeName)
+                        writer.WriteLine(sprintf "`%s`::" typeName)
                         for m in members do
                             let memberName = m |> attributeValue "Name"
                             if isNotNullOrEmpty memberName then
                                 let diffType  = m |> attributeValue "DiffType"                         
                                 if isNotNullOrEmpty diffType then                    
                                     match convertDiffType diffType with
-                                            | Deleted -> writer.WriteLine(sprintf "[float]%s==== `%s` is deleted" Environment.NewLine memberName)
-                                            | New -> writer.WriteLine(sprintf "[float]%s==== `%s` is added" Environment.NewLine memberName)
+                                            | Deleted -> writer.WriteLine(sprintf "  * `%s` deleted" memberName)
+                                            | New -> writer.WriteLine(sprintf "  * `%s` added" memberName)
                                             | Modified -> 
                                                 match (m.Descendants(XName.op_Implicit "DiffItem") |> Seq.tryHead) with
                                                 | Some diffItem ->
-                                                    writer.WriteLine(sprintf "[float]%s==== `%s`" Environment.NewLine memberName)                                                                                      
+                                                    writer.WriteLine(sprintf "  * `%s`" memberName)                                                                                      
                                                     let diffDescription = diffItem.Value
-                                                    writer.WriteLine(Regex.Replace(diffDescription, "changed from (.*?) to (.*).", "changed from `$1` to `$2`."))                                         
+                                                    writer |> createDiffDescription diffDescription                                    
                                                 | None -> ()
+                writer.WriteLine()
         with
         | :? XmlException -> ignore()
 

build/scripts/Targets.fsx

@@ -53,7 +53,7 @@ Target "Profile" <| fun _ ->
     let url = getBuildParam "elasticsearch"
     Profiler.IndexResults url
 
-Target "Integrate" <| Tests.RunIntegrationTests
+Target "Integrate" Tests.RunIntegrationTests
 
 Target "Benchmark" <| fun _ ->
     let runInteractive = ((getBuildParam "nonInteractive") <> "1")