v2.0.6 (#15)

- Adds XML documentation (#13)
- Adds `HxSync` module and attribute helper
- Updates script version to 2.0.6
- Drops .NET 6 support (#14 )

Reviewed-on: #15

src/Common/Common.fs

@@ -1,28 +1,53 @@
-/// Common definitions shared between attribute values and response headers
+/// <summary>Common definitions shared between attribute values and response headers</summary>
 [<AutoOpen>]
 module Giraffe.Htmx.Common
 
-/// Valid values for the `hx-swap` attribute / `HX-Reswap` header (may be combined with swap/settle/scroll/show config)
+/// <summary>Serialize a list of key/value pairs to JSON (very rudimentary)</summary>
+/// <param name="pairs">The key/value pairs to be serialized to JSON</param>
+/// <returns>A string with the key/value pairs serialized to JSON</returns>
+let internal toJson (pairs: (string * string) list) =
+    pairs
+    |> List.map (fun pair -> sprintf "\"%s\": \"%s\"" (fst pair) ((snd pair).Replace ("\"", "\\\"")))
+    |> String.concat ", "
+    |> sprintf "{ %s }"
+
+/// <summary>Convert a boolean to lowercase "true" or "false"</summary>
+/// <param name="boolValue">The boolean value to convert</param>
+/// <returns>"true" for <c>true</c>, "false" for <c>false</c></returns>
+let internal toLowerBool (boolValue: bool) =
+    (string boolValue).ToLowerInvariant()
+
+
+/// <summary>Valid values for the <c>hx-swap</c> attribute / <c>HX-Reswap</c> header</summary>
+/// <remarks>May be combined with <c>swap</c> / <c>settle</c> / <c>scroll</c> / <c>show</c> config)</remarks>
+/// <seealso href="https://htmx.org/attributes/hx-swap/">Documentation</seealso>
 [<RequireQualifiedAccess>]
 module HxSwap =
     
-    /// The default, replace the inner html of the target element
+    /// <summary>The default, replace the inner HTML of the target element</summary>
+    [<Literal>]
     let InnerHtml = "innerHTML"
     
-    /// Replace the entire target element with the response
+    /// <summary>Replace the entire target element with the response</summary>
+    [<Literal>]
     let OuterHtml = "outerHTML"
     
-    /// Insert the response before the target element
+    /// <summary>Insert the response before the target element</summary>
+    [<Literal>]
     let BeforeBegin = "beforebegin"
     
-    /// Insert the response before the first child of the target element
+    /// <summary>Insert the response before the first child of the target element</summary>
+    [<Literal>]
     let AfterBegin = "afterbegin"
     
-    /// Insert the response after the last child of the target element
+    /// <summary>Insert the response after the last child of the target element</summary>
+    [<Literal>]
     let BeforeEnd = "beforeend"
     
-    /// Insert the response after the target element
+    /// <summary>Insert the response after the target element</summary>
+    [<Literal>]
     let AfterEnd = "afterend"
     
-    /// Does not append content from response (out of band items will still be processed).
+    /// <summary>Does not append content from response (out of band items will still be processed).</summary>
+    [<Literal>]
     let None = "none"

src/Common/Giraffe.Htmx.Common.fsproj

@@ -4,6 +4,7 @@
     <GenerateDocumentationFile>true</GenerateDocumentationFile>
     <Description>Common definitions for Giraffe.Htmx</Description>
     <PackageReadmeFile>README.md</PackageReadmeFile>
+    <DocumentationFile>bin\$(Configuration)\$(TargetFramework)\$(AssemblyName).xml</DocumentationFile>
   </PropertyGroup>
 
   <ItemGroup>
@@ -15,5 +16,9 @@
   <ItemGroup>
     <PackageReference Update="FSharp.Core" Version="6.0.0" />
   </ItemGroup>
-
+  
+  <ItemGroup>
+    <InternalsVisibleTo Include="Giraffe.Htmx" />
+    <InternalsVisibleTo Include="Giraffe.ViewEngine.Htmx" />
+  </ItemGroup>
 </Project>

src/Common/README.md

@@ -2,4 +2,4 @@
 
 This package contains common code shared between [`Giraffe.Htmx`](https://www.nuget.org/packages/Giraffe.Htmx) and [`Giraffe.ViewEngine.Htmx`](https://www.nuget.org/packages/Giraffe.ViewEngine.Htmx), and will be automatically installed when you install either one.
 
-**htmx version: 2.0.4**
+**htmx version: 2.0.6**