|
| 1 | +#I @"../../packages/build/FAKE/tools" |
| 2 | +#r @"FakeLib.dll" |
| 3 | +#r "System.Xml.Linq.dll" |
| 4 | + |
| 5 | +#load @"Paths.fsx" |
| 6 | + |
| 7 | +namespace XmlDocPatcher |
| 8 | + |
| 9 | +open System.Linq |
| 10 | +open System.Text.RegularExpressions |
| 11 | +open System.Xml |
| 12 | +open System.Xml.Linq |
| 13 | +open System.Xml.XPath |
| 14 | + |
| 15 | +open Paths |
| 16 | +open Projects |
| 17 | +open Fake |
| 18 | + |
| 19 | + |
| 20 | +module InheritDoc = |
| 21 | + |
| 22 | + let private apiName n = Regex.Replace(n, @"^\w\:(.+?)(?:\(.+$|$)", "$1") |
| 23 | + let private relatedInterface n = Regex.Replace(n, @"\.([^.]+\.[^.]+)$", ".I$1") |
| 24 | + let private relatedInterfaceAsync n = (relatedInterface n).Replace("Async", "") |
| 25 | + let private relatedInterfaceDescriptor n = Regex.Replace(n, @"\.([^.]+)Descriptor\.([^.]+)$", ".I$1.$2") |
| 26 | + let private relatedInterfaceDescriptorRequest n = Regex.Replace(n, @"\.([^.]+)Descriptor\.([^.]+)$", ".I$1Request.$2") |
| 27 | + let private relatedInterfaceDescriptorGeneric n = Regex.Replace(n, @"\.([^.]+)Descriptor[^.]+.([^.]+)$", ".I$1.$2") |
| 28 | + let private manualMapping (n : string) = |
| 29 | + //this sucks but untill roslyn gets coderewriting API's this is the best we got without making it |
| 30 | + //a bigger thing than it already is |
| 31 | + match n with |
| 32 | + | n when n.Contains("PutMapping") -> n.Replace("PutMapping", "TypeMapping") |
| 33 | + | _ -> n |
| 34 | + let private relatedApiLookups = [ |
| 35 | + relatedInterface; |
| 36 | + relatedInterfaceAsync; |
| 37 | + relatedInterfaceDescriptor; |
| 38 | + relatedInterfaceDescriptorRequest; |
| 39 | + relatedInterfaceDescriptorGeneric; |
| 40 | + manualMapping |
| 41 | + ]; |
| 42 | + |
| 43 | + let private documentedApis = fun (file : string) -> |
| 44 | + use reader = XmlReader.Create file |
| 45 | + seq { |
| 46 | + while reader.ReadToFollowing("member") do |
| 47 | + let name = apiName(reader.GetAttribute("name")) |
| 48 | + let innerXml = reader.ReadInnerXml().Trim(); |
| 49 | + if (isNotNullOrEmpty innerXml && not (innerXml.Contains("<inheritdoc"))) then |
| 50 | + let xdoc = XDocument.Parse("<x>" + innerXml + "</x>") |
| 51 | + yield (name, xdoc) |
| 52 | + } |> Map.ofSeq |
| 53 | + |
| 54 | + let private patchInheritDoc = fun file -> |
| 55 | + traceFAKE "Rewriting xmldoc: %s" file |
| 56 | + |
| 57 | + let mapOfDocumentedApis = documentedApis file |
| 58 | + |
| 59 | + let findDocumentation (apiElement:string) = |
| 60 | + relatedApiLookups |
| 61 | + |> Seq.map (fun f -> f apiElement) |
| 62 | + |> (Seq.map <| mapOfDocumentedApis.TryFind) |
| 63 | + |> Seq.choose id |
| 64 | + |> Seq.tryHead |
| 65 | + |
| 66 | + let xml = XDocument.Load file |
| 67 | + |
| 68 | + xml.XPathSelectElements("//inheritdoc") |
| 69 | + |> Seq.iter (fun inheritDocElement -> |
| 70 | + let parent =inheritDocElement.Parent |
| 71 | + let name = apiName (parent.Attribute(XName.Get "name").Value) |
| 72 | + let documentation = findDocumentation name |
| 73 | + |
| 74 | + match documentation with |
| 75 | + | Some d -> |
| 76 | + let elements = d.Element(XName.Get("x")).Elements().ToList(); |
| 77 | + inheritDocElement.AddBeforeSelf(elements) |
| 78 | + | _ -> |
| 79 | + //unignore the following to find undocumented/badly inherited methods |
| 80 | + //tracefn "not inherited: %s" apiElement |
| 81 | + ignore() |
| 82 | + ) |
| 83 | + |
| 84 | + use writer = new XmlTextWriter(file,null) |
| 85 | + writer.Formatting <- Formatting.Indented; |
| 86 | + xml.Save(writer); |
| 87 | + |
| 88 | + let patchInheritDocs = fun () -> |
| 89 | + AllPublishableProjectsWithSupportedFrameworks |
| 90 | + |> Seq.map (fun p -> |
| 91 | + let folder = Paths.ProjectOutputFolder p.project p.framework |
| 92 | + folder @@ p.project.Name + ".xml" |
| 93 | + ) |
| 94 | + |> Seq.filter fileExists |
| 95 | + |> Seq.iter patchInheritDoc |
0 commit comments