Enhance JSON Schema support in documentation and examples

Author: EverybodyKurts

.config/dotnet-tools.json

@@ -2,29 +2,33 @@
   "version": 1,
   "isRoot": true,
   "tools": {
-    "fsdocs-tool": {
-      "version": "20.0.0",
+    "paket": {
+      "version": "9.0.2",
       "commands": [
-        "fsdocs"
-      ]
+        "paket"
+      ],
+      "rollForward": false
     },
     "fake-cli": {
       "version": "6.1.3",
       "commands": [
         "fake"
-      ]
+      ],
+      "rollForward": false
     },
-    "paket": {
-      "version": "8.0.3",
+    "fsdocs-tool": {
+      "version": "20.0.1",
       "commands": [
-        "paket"
-      ]
+        "fsdocs"
+      ],
+      "rollForward": false
     },
     "fantomas": {
-      "version": "5.0.0-alpha-008",
+      "version": "7.0.1",
       "commands": [
         "fantomas"
-      ]
+      ],
+      "rollForward": false
     }
   }
 }

.github/workflows/pull-requests.yml

@@ -48,6 +48,8 @@ jobs:
       run: dotnet tool restore
     - name: Restore packages
       run: dotnet paket restore
+    - name: Format code
+      run: dotnet fake build -t Format
     - name: Build and test
       run: dotnet fake build -t RunTests
     - name: Build (Debug)

.paket/Paket.Restore.targets

@@ -235,14 +235,15 @@
 				<Splits>$([System.String]::Copy('%(PaketReferencesFileLines.Identity)').Split(',').Length)</Splits>
 				<PackageName>$([System.String]::Copy('%(PaketReferencesFileLines.Identity)').Split(',')[0])</PackageName>
 				<PackageVersion>$([System.String]::Copy('%(PaketReferencesFileLines.Identity)').Split(',')[1])</PackageVersion>
+				<Reference>$([System.String]::Copy('%(PaketReferencesFileLines.Identity)').Split(',')[2])</Reference>
 				<AllPrivateAssets>$([System.String]::Copy('%(PaketReferencesFileLines.Identity)').Split(',')[4])</AllPrivateAssets>
 				<CopyLocal Condition="%(PaketReferencesFileLinesInfo.Splits) &gt;= 6">$([System.String]::Copy('%(PaketReferencesFileLines.Identity)').Split(',')[5])</CopyLocal>
 				<OmitContent Condition="%(PaketReferencesFileLinesInfo.Splits) &gt;= 7">$([System.String]::Copy('%(PaketReferencesFileLines.Identity)').Split(',')[6])</OmitContent>
 				<ImportTargets Condition="%(PaketReferencesFileLinesInfo.Splits) &gt;= 8">$([System.String]::Copy('%(PaketReferencesFileLines.Identity)').Split(',')[7])</ImportTargets>
 				<Aliases Condition="%(PaketReferencesFileLinesInfo.Splits) &gt;= 9">$([System.String]::Copy('%(PaketReferencesFileLines.Identity)').Split(',')[8])</Aliases>
 			</PaketReferencesFileLinesInfo>
-			<PackageReference Include="%(PaketReferencesFileLinesInfo.PackageName)">
-				<Version>%(PaketReferencesFileLinesInfo.PackageVersion)</Version>
+			<PackageReference Condition=" '$(ManagePackageVersionsCentrally)' != 'true' Or '%(PaketReferencesFileLinesInfo.Reference)' == 'Direct' " Include="%(PaketReferencesFileLinesInfo.PackageName)">
+				<Version Condition=" '$(ManagePackageVersionsCentrally)' != 'true' ">%(PaketReferencesFileLinesInfo.PackageVersion)</Version>
 				<PrivateAssets Condition=" ('%(PaketReferencesFileLinesInfo.AllPrivateAssets)' == 'true') Or ('$(PackAsTool)' == 'true') ">All</PrivateAssets>
 				<ExcludeAssets Condition=" %(PaketReferencesFileLinesInfo.CopyLocal) == 'false' or %(PaketReferencesFileLinesInfo.AllPrivateAssets) == 'exclude'">runtime</ExcludeAssets>
 				<ExcludeAssets Condition=" %(PaketReferencesFileLinesInfo.OmitContent) == 'true'">$(ExcludeAssets);contentFiles</ExcludeAssets>
@@ -252,6 +253,10 @@
 				<AllowExplicitVersion>true</AllowExplicitVersion>
 
 			</PackageReference>
+
+			<PackageVersion Include="%(PaketReferencesFileLinesInfo.PackageName)">
+				<Version>%(PaketReferencesFileLinesInfo.PackageVersion)</Version>
+			</PackageVersion>
 		</ItemGroup>
 
 		<PropertyGroup>

README.md

@@ -2,11 +2,14 @@
 
 The FSharp.Data package (`FSharp.Data.dll`) implements everything you need to access data in your F# applications and scripts. It implements F# type providers for working with structured file formats (CSV, HTML, JSON and XML) and for accessing the WorldBank data. It also includes helpers for parsing CSV, HTML and JSON files and for sending HTTP requests.
 
+The library supports both sample-based and schema-based type inference. The XML Type Provider supports XSD schemas, and the JSON Type Provider now supports JSON Schema for defining structured, strongly-typed access to JSON documents.
+
 We're open to contributions from anyone. If you want to help out but don't know where to start, you can take one of the [Up-For-Grabs](https://github.com/fsharp/FSharp.Data/labels/up-for-grabs) issues, or help to improve the [documentation][3].
 
 You can see the version history [here](RELEASE_NOTES.md).
 
 [![NuGet Badge](http://img.shields.io/nuget/v/FSharp.Data.svg?style=flat)](https://www.nuget.org/packages/FSharp.Data)
+[![CI](https://github.com/fsprojects/FSharp.Data/actions/workflows/ci.yml/badge.svg)](https://github.com/fsprojects/FSharp.Data/actions/workflows/ci.yml)
 
 ## Building
 

RELEASE_NOTES.md

@@ -1,3 +1,8 @@
+## 6.5.0 - Unreleased
+- Add JSON Schema support to the JSON Type Provider
+- Add JSON validation against JSON Schema
+- Add documentation for working with JSON Schema
+
 ## 6.4.1 - Oct 2 2024
 - WorldBank URL fixed to https @pkese
 - Updated Fake and Paket @Thorium

build.fsx

@@ -67,12 +67,11 @@ let isCI = Environment.GetEnvironmentVariable("CI") <> null
 // Generate assembly info files with the right version & up-to-date information
 
 Target.create "AssemblyInfo" (fun _ ->
-    for file in !! "src/AssemblyInfo*.fs" do
+    for file in !!"src/AssemblyInfo*.fs" do
         let replace (oldValue: string) newValue (str: string) = str.Replace(oldValue, newValue)
 
         let title =
-            Path.GetFileNameWithoutExtension file
-            |> replace "AssemblyInfo" "FSharp.Data"
+            Path.GetFileNameWithoutExtension file |> replace "AssemblyInfo" "FSharp.Data"
 
         let versionSuffix = ".0"
         let version = release.AssemblyVersion + versionSuffix
@@ -90,8 +89,8 @@ Target.create "AssemblyInfo" (fun _ ->
 
 Target.create "Clean" (fun _ ->
     seq {
-        yield! !! "**/bin"
-        yield! !! "**/obj"
+        yield! !!"**/bin"
+        yield! !!"**/obj"
     }
     |> Shell.cleanDirs)
 
@@ -114,18 +113,18 @@ Target.create "Build" (fun _ ->
     |> DotNet.build (fun o ->
         { o with
             Configuration = DotNet.BuildConfiguration.Release
-            MSBuildParams = { o.MSBuildParams with DisableInternalBinLog = true } }))
+            MSBuildParams =
+                { o.MSBuildParams with
+                    DisableInternalBinLog = true } }))
 
 Target.create "RunTests" (fun _ ->
     let setParams (o: DotNet.TestOptions) =
         { o with
             Configuration = DotNet.BuildConfiguration.Release
-            MSBuildParams = { o.MSBuildParams with DisableInternalBinLog = true }
-            Logger =
-                if isCI then
-                    Some "GitHubActions"
-                else
-                    None }
+            MSBuildParams =
+                { o.MSBuildParams with
+                    DisableInternalBinLog = true }
+            Logger = if isCI then Some "GitHubActions" else None }
 
     "FSharp.Data.sln" |> DotNet.test setParams)
 
@@ -196,7 +195,7 @@ Target.create "Help" (fun _ ->
     printfn "")
 
 let sourceFiles =
-    !! "src/**/*.fs" ++ "src/**/*.fsi" ++ "build.fsx"
+    !!"src/**/*.fs" ++ "src/**/*.fsi" ++ "build.fsx"
     -- "src/**/obj/**/*.fs"
     -- "src/AssemblyInfo*.fs"
 
@@ -228,15 +227,9 @@ Target.create "CheckFormat" (fun _ ->
 
 Target.create "All" ignore
 
-"Clean"
-==> "AssemblyInfo"
-==> "CheckFormat"
-==> "Build"
+"Clean" ==> "AssemblyInfo" ==> "CheckFormat" ==> "Build"
 
-"Build"
-==> "CleanDocs"
-==> "GenerateDocs"
-==> "All"
+"Build" ==> "CleanDocs" ==> "GenerateDocs" ==> "All"
 
 "Build" ==> "Pack" ==> "All"
 "Build" ==> "All"