code changes to deal with updates

baronfel · baronfel · commit b7b32b12d133 · 2020-07-19T12:02:10.000-05:00
diff --git a/generators/apiref.fsx b/generators/apiref.fsx
@@ -1,5 +1,6 @@
 #r "../_lib/Fornax.Core.dll"
 #r "../packages/Newtonsoft.Json/lib/netstandard2.0/Newtonsoft.Json.dll"
+#r "../packages/FSharp.Compiler.Service/lib/netstandard2.0/FSharp.Compiler.Service.dll"
 #r "../packages/FSharp.Formatting/lib/netstandard2.0/FSharp.Formatting.ApiDocs.dll"
 
 #if !FORNAX
@@ -21,10 +22,10 @@ let stripMicrosoft (str: string) =
     else
         str
 
-let getComment (c: DocComment) =
+let getComment (c: ApiDocComment) =
     sprintf """<div class="comment">%s</div>""" c.FullText
 
-let formatMember (m: Member) =
+let formatMember (m: ApiDocMember) =
     let hasCustomOp =
       m.Attributes
       |> List.exists (fun a -> a.FullName = "Microsoft.FSharp.Core.CustomOperationAttribute")
@@ -53,12 +54,12 @@ let formatMember (m: Member) =
               br []
             br []
             b [] [!! "Signature: "]
-            !!m.Details.Signature
+            !! m.SignatureTooltip
         ]
         td [] [!! (getComment m.Comment)]
     ]
 
-let generateType ctx (page: ApiPageInfo<Type>) =
+let generateType ctx (page: ApiPageInfo<ApiDocType>) =
     let t = page.Info
     let body =
         div [Class "api-page"] [
@@ -105,9 +106,9 @@ let generateType ctx (page: ApiPageInfo<Type>) =
                 yield! t.UnionCases |> List.map formatMember
             ]
         ]
-    t.UrlName, Layout.layout ctx [body] t.Name
+    t.UrlBaseName, Layout.layout ctx [body] t.Name
 
-let generateModule ctx (page: ApiPageInfo<Module>) =
+let generateModule ctx (page: ApiPageInfo<ApiDocModule>) =
     let m = page.Info
     let body =
         div [Class "api-page"] [
@@ -133,7 +134,7 @@ let generateModule ctx (page: ApiPageInfo<Module>) =
                     ]
                     for t in m.NestedTypes do
                         tr [] [
-                            td [] [a [Href (sprintf "%s.html" (stripMicrosoft t.UrlName))] [!! t.Name ]]
+                            td [] [a [Href (sprintf "%s.html" (stripMicrosoft t.UrlBaseName))] [!! t.Name ]]
                             td [] [!! (getComment t.Comment)]
                         ]
                 ]
@@ -148,7 +149,7 @@ let generateModule ctx (page: ApiPageInfo<Module>) =
                     ]
                     for t in m.NestedModules do
                         tr [] [
-                            td [] [a [Href (sprintf "%s.html" (stripMicrosoft t.UrlName))] [!! t.Name ]]
+                            td [] [a [Href (sprintf "%s.html" (stripMicrosoft t.UrlBaseName))] [!! t.Name ]]
                             td [] [!! (getComment t.Comment)]
                         ]
                 ]
@@ -175,9 +176,9 @@ let generateModule ctx (page: ApiPageInfo<Module>) =
                     yield! m.TypeExtensions |> List.map formatMember
                 ]
         ]
-    m.UrlName, Layout.layout ctx [body] m.Name
+    m.UrlBaseName, Layout.layout ctx [body] m.Name
 
-let generateNamespace ctx (n: Namespace)  =
+let generateNamespace ctx (n: ApiDocNamespace)  =
     let body =
         div [Class "api-page"] [
             h2 [] [!! (stripMicrosoft n.Name)]
@@ -192,7 +193,7 @@ let generateNamespace ctx (n: Namespace)  =
                     ]
                     for t in n.Types do
                         tr [] [
-                            td [] [a [Href (sprintf "%s.html" (stripMicrosoft t.UrlName))] [!! t.Name ]]
+                            td [] [a [Href (sprintf "%s.html" (stripMicrosoft t.UrlBaseName))] [!! t.Name ]]
                             td [] [!!(getComment t.Comment)]
                         ]
                 ]
@@ -208,7 +209,7 @@ let generateNamespace ctx (n: Namespace)  =
                     ]
                     for t in n.Modules do
                         tr [] [
-                            td [] [a [Href (sprintf "%s.html" (stripMicrosoft t.UrlName))] [!! t.Name ]]
+                            td [] [a [Href (sprintf "%s.html" (stripMicrosoft t.UrlBaseName))] [!! t.Name ]]
                             td [] [!! (getComment t.Comment)]
                         ]
                 ]
diff --git a/generators/lunr.fsx b/generators/lunr.fsx
@@ -58,7 +58,7 @@ let generate (ctx : SiteContents) (projectRoot: string) (page: string) =
                           (m.TypeExtensions |> List.map (fun m -> m.Name + " " + m.Comment.FullText ) |> String.concat " ")
 
 
-                  {uri = rootUrl + sprintf "/reference/%s/%s.html" n.Label (stripMicrosoft m.UrlName) ; title = m.Name; content = cnt }
+                  {uri = rootUrl + sprintf "/reference/%s/%s.html" n.Label (stripMicrosoft m.UrlBaseName) ; title = m.Name; content = cnt }
               )
 
           let tsGen =
@@ -72,7 +72,7 @@ let generate (ctx : SiteContents) (projectRoot: string) (page: string) =
                           (m.AllMembers |> List.map (fun m -> m.Name + " " + m.Comment.FullText ) |> String.concat " ")
 
 
-                  {uri = rootUrl + sprintf "/reference/%s/%s.html" n.Label m.UrlName ; title = m.Name; content = cnt }
+                  {uri = rootUrl + sprintf "/reference/%s/%s.html" n.Label m.UrlBaseName ; title = m.Name; content = cnt }
               )
           [gen; yield! mdlsGen; yield! tsGen]
         )
diff --git a/loaders/apirefloader.fsx b/loaders/apirefloader.fsx
@@ -15,8 +15,8 @@ type ApiPageInfo<'a> = {
 
 type AssemblyEntities = {
   Label: string
-  Modules: ApiPageInfo<Module> list
-  Types: ApiPageInfo<Type> list
+  Modules: ApiPageInfo<ApiDocModule> list
+  Types: ApiPageInfo<ApiDocType> list
   GeneratorOutput: ApiDocsModel
 }
 
@@ -28,10 +28,10 @@ let stripMicrosoft (str: string) =
     else
         str
 
-let rec collectModules pn pu nn nu (m: Module) =
+let rec collectModules pn pu nn nu (m: ApiDocModule) =
     [
         yield { ParentName = stripMicrosoft pn; ParentUrlName = stripMicrosoft pu; NamespaceName = stripMicrosoft nn; NamespaceUrlName = stripMicrosoft nu; Info = m}
-        yield! m.NestedModules |> List.collect (collectModules m.Name m.UrlName nn nu )
+        yield! m.NestedModules |> List.collect (collectModules m.Name m.UrlBaseName nn nu )
     ]
 
 let loader (projectRoot: string) (siteContent: SiteContents) =
@@ -67,7 +67,7 @@ let loader (projectRoot: string) (siteContent: SiteContents) =
                         n.Info.NestedTypes
                         |> List.map (fun t ->
                             { ParentName = stripMicrosoft n.Info.Name
-                              ParentUrlName = stripMicrosoft n.Info.UrlName
+                              ParentUrlName = stripMicrosoft n.Info.UrlBaseName
                               NamespaceName = stripMicrosoft n.NamespaceName
                               NamespaceUrlName = stripMicrosoft n.NamespaceUrlName
                               Info = t }))

Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,6 @@`
`1`	`1`	`#r "../_lib/Fornax.Core.dll"`
`2`	`2`	`#r "../packages/Newtonsoft.Json/lib/netstandard2.0/Newtonsoft.Json.dll"`
	`3`	`+#r "../packages/FSharp.Compiler.Service/lib/netstandard2.0/FSharp.Compiler.Service.dll"`
`3`	`4`	`#r "../packages/FSharp.Formatting/lib/netstandard2.0/FSharp.Formatting.ApiDocs.dll"`
`4`	`5`
`5`	`6`	`#if !FORNAX`
`@@ -21,10 +22,10 @@ let stripMicrosoft (str: string) =`
`21`	`22`	`else`
`22`	`23`	`str`
`23`	`24`
`24`		`-let getComment (c: DocComment) =`
	`25`	`+let getComment (c: ApiDocComment) =`
`25`	`26`	`sprintf """<div class="comment">%s</div>""" c.FullText`
`26`	`27`
`27`		`-let formatMember (m: Member) =`
	`28`	`+let formatMember (m: ApiDocMember) =`
`28`	`29`	`let hasCustomOp =`
`29`	`30`	`m.Attributes`
`30`	`31`	`\|> List.exists (fun a -> a.FullName = "Microsoft.FSharp.Core.CustomOperationAttribute")`
`@@ -53,12 +54,12 @@ let formatMember (m: Member) =`
`53`	`54`	`br []`
`54`	`55`	`br []`
`55`	`56`	`b [] [!! "Signature: "]`
`56`		`- !!m.Details.Signature`
	`57`	`+ !! m.SignatureTooltip`
`57`	`58`	`]`
`58`	`59`	`td [] [!! (getComment m.Comment)]`
`59`	`60`	`]`
`60`	`61`
`61`		`-let generateType ctx (page: ApiPageInfo<Type>) =`
	`62`	`+let generateType ctx (page: ApiPageInfo<ApiDocType>) =`
`62`	`63`	`let t = page.Info`
`63`	`64`	`let body =`
`64`	`65`	`div [Class "api-page"] [`
`@@ -105,9 +106,9 @@ let generateType ctx (page: ApiPageInfo<Type>) =`
`105`	`106`	`yield! t.UnionCases \|> List.map formatMember`
`106`	`107`	`]`
`107`	`108`	`]`
`108`		`- t.UrlName, Layout.layout ctx [body] t.Name`
	`109`	`+ t.UrlBaseName, Layout.layout ctx [body] t.Name`
`109`	`110`
`110`		`-let generateModule ctx (page: ApiPageInfo<Module>) =`
	`111`	`+let generateModule ctx (page: ApiPageInfo<ApiDocModule>) =`
`111`	`112`	`let m = page.Info`
`112`	`113`	`let body =`
`113`	`114`	`div [Class "api-page"] [`
`@@ -133,7 +134,7 @@ let generateModule ctx (page: ApiPageInfo<Module>) =`
`133`	`134`	`]`
`134`	`135`	`for t in m.NestedTypes do`
`135`	`136`	`tr [] [`
`136`		`- td [] [a [Href (sprintf "%s.html" (stripMicrosoft t.UrlName))] [!! t.Name ]]`
	`137`	`+ td [] [a [Href (sprintf "%s.html" (stripMicrosoft t.UrlBaseName))] [!! t.Name ]]`
`137`	`138`	`td [] [!! (getComment t.Comment)]`
`138`	`139`	`]`
`139`	`140`	`]`
`@@ -148,7 +149,7 @@ let generateModule ctx (page: ApiPageInfo<Module>) =`
`148`	`149`	`]`
`149`	`150`	`for t in m.NestedModules do`
`150`	`151`	`tr [] [`
`151`		`- td [] [a [Href (sprintf "%s.html" (stripMicrosoft t.UrlName))] [!! t.Name ]]`
	`152`	`+ td [] [a [Href (sprintf "%s.html" (stripMicrosoft t.UrlBaseName))] [!! t.Name ]]`
`152`	`153`	`td [] [!! (getComment t.Comment)]`
`153`	`154`	`]`
`154`	`155`	`]`
`@@ -175,9 +176,9 @@ let generateModule ctx (page: ApiPageInfo<Module>) =`
`175`	`176`	`yield! m.TypeExtensions \|> List.map formatMember`
`176`	`177`	`]`
`177`	`178`	`]`
`178`		`- m.UrlName, Layout.layout ctx [body] m.Name`
	`179`	`+ m.UrlBaseName, Layout.layout ctx [body] m.Name`
`179`	`180`
`180`		`-let generateNamespace ctx (n: Namespace) =`
	`181`	`+let generateNamespace ctx (n: ApiDocNamespace) =`
`181`	`182`	`let body =`
`182`	`183`	`div [Class "api-page"] [`
`183`	`184`	`h2 [] [!! (stripMicrosoft n.Name)]`
`@@ -192,7 +193,7 @@ let generateNamespace ctx (n: Namespace) =`
`192`	`193`	`]`
`193`	`194`	`for t in n.Types do`
`194`	`195`	`tr [] [`
`195`		`- td [] [a [Href (sprintf "%s.html" (stripMicrosoft t.UrlName))] [!! t.Name ]]`
	`196`	`+ td [] [a [Href (sprintf "%s.html" (stripMicrosoft t.UrlBaseName))] [!! t.Name ]]`
`196`	`197`	`td [] [!!(getComment t.Comment)]`
`197`	`198`	`]`
`198`	`199`	`]`
`@@ -208,7 +209,7 @@ let generateNamespace ctx (n: Namespace) =`
`208`	`209`	`]`
`209`	`210`	`for t in n.Modules do`
`210`	`211`	`tr [] [`
`211`		`- td [] [a [Href (sprintf "%s.html" (stripMicrosoft t.UrlName))] [!! t.Name ]]`
	`212`	`+ td [] [a [Href (sprintf "%s.html" (stripMicrosoft t.UrlBaseName))] [!! t.Name ]]`
`212`	`213`	`td [] [!! (getComment t.Comment)]`
`213`	`214`	`]`
`214`	`215`	`]`
Original file line number	Diff line number	Diff line change
`@@ -58,7 +58,7 @@ let generate (ctx : SiteContents) (projectRoot: string) (page: string) =`
`58`	`58`	`(m.TypeExtensions \|> List.map (fun m -> m.Name + " " + m.Comment.FullText ) \|> String.concat " ")`
`59`	`59`
`60`	`60`
`61`		`- {uri = rootUrl + sprintf "/reference/%s/%s.html" n.Label (stripMicrosoft m.UrlName) ; title = m.Name; content = cnt }`
	`61`	`+ {uri = rootUrl + sprintf "/reference/%s/%s.html" n.Label (stripMicrosoft m.UrlBaseName) ; title = m.Name; content = cnt }`
`62`	`62`	`)`
`63`	`63`
`64`	`64`	`let tsGen =`
`@@ -72,7 +72,7 @@ let generate (ctx : SiteContents) (projectRoot: string) (page: string) =`
`72`	`72`	`(m.AllMembers \|> List.map (fun m -> m.Name + " " + m.Comment.FullText ) \|> String.concat " ")`
`73`	`73`
`74`	`74`
`75`		`- {uri = rootUrl + sprintf "/reference/%s/%s.html" n.Label m.UrlName ; title = m.Name; content = cnt }`
	`75`	`+ {uri = rootUrl + sprintf "/reference/%s/%s.html" n.Label m.UrlBaseName ; title = m.Name; content = cnt }`
`76`	`76`	`)`
`77`	`77`	`[gen; yield! mdlsGen; yield! tsGen]`
`78`	`78`	`)`