Upgrade to Corvus.JsonSchema 4 (#1081)

- Upgraded dependencies to their latest version - Upgraded to Corvus.Json 4 - Switched to using a source generator for the schema parser/validator
dalyIsaac · Nov 19, 2024 · 580e1d0 · 580e1d0
1 parent a9adcf4
commit 580e1d0
Show file tree

Hide file tree

Showing 18 changed files with 267 additions and 207 deletions.
diff --git a/.config/dotnet-tools.json b/.config/dotnet-tools.json
@@ -13,12 +13,12 @@
       "rollForward": false
     },
     "docfx": {
-      "version": "2.77.0",
+      "version": "2.78.0",
       "commands": ["docfx"],
       "rollForward": false
     },
     "corvus.json.jsonschema.typegeneratortool": {
-      "version": "3.1.1",
+      "version": "4.0.9",
       "commands": ["generatejsonschematypes"],
       "rollForward": false
     }

diff --git a/.github/workflows/commit.yml b/.github/workflows/commit.yml
@@ -92,10 +92,6 @@ jobs:
       - name: Add msbuild to PATH
         uses: microsoft/[email protected]
 
-      - name: Build schema
-        run: |
-          .\scripts\Generate-SourceFromSchema.ps1
-
       - name: Build
         run: |
           msbuild Whim.sln `

diff --git a/.github/workflows/docs_commit.yml b/.github/workflows/docs_commit.yml
@@ -57,9 +57,19 @@ jobs:
         run: |
           dotnet tool restore
 
-      - name: Build schema
+      - name: Add msbuild to PATH
+        uses: microsoft/[email protected]
+
+      - name: Build
         run: |
-          .\scripts\Generate-SourceFromSchema.ps1
+          msbuild Whim.sln `
+            -p:Configuration=$env:Configuration `
+            -p:Platform=$env:Platform `
+            -p:BuildInParallel=true `
+            -maxCpuCount
+
+      - name: Run docfx metadata
+        run: dotnet docfx metadata .\docs\docfx.json
 
       - name: Run docfx
         run: dotnet docfx .\docs\docfx.json
diff --git a/.github/workflows/docs_deploy.yml b/.github/workflows/docs_deploy.yml
@@ -55,10 +55,6 @@ jobs:
         run: |
           dotnet tool restore
 
-      - name: Build schema
-        run: |
-          .\scripts\Generate-SourceFromSchema.ps1
-
       - run: dotnet tool update -g docfx
       - run: docfx docs/docfx.json
 

diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml
@@ -100,10 +100,6 @@ jobs:
       - name: Add msbuild to PATH
         uses: microsoft/[email protected]
 
-      - name: Build schema
-        run: |
-          .\scripts\Generate-SourceFromSchema.ps1
-
       - name: Build
         run: |
           msbuild Whim.sln `

diff --git a/.gitignore b/.gitignore
@@ -361,6 +361,3 @@ bin/whim-install.exe
 # docfx
 api
 _site
-
-# Whim.Yaml generated files
-src/Whim.Yaml/Generated/
diff --git a/Directory.Packages.props b/Directory.Packages.props
@@ -3,21 +3,22 @@
     <ManagePackageVersionsCentrally>true</ManagePackageVersionsCentrally>
   </PropertyGroup>
   <ItemGroup>
-    <PackageVersion Include="Corvus.Json.ExtendedTypes" Version="3.1.1" />
-    <PackageVersion Include="DotNext" Version="5.11.0" />
-    <PackageVersion Include="Microsoft.CodeAnalysis.Scripting" Version="4.10.0" />
-    <PackageVersion Include="Microsoft.Win32.SystemEvents" Version="8.0.0" />
+    <PackageVersion Include="Corvus.Json.ExtendedTypes" Version="4.0.9" />
+    <PackageVersion Include="Corvus.Json.SourceGenerator" Version="4.0.9" />
+    <PackageVersion Include="DotNext" Version="5.14.0" />
+    <PackageVersion Include="Microsoft.CodeAnalysis.Scripting" Version="4.11.0" />
+    <PackageVersion Include="Microsoft.Win32.SystemEvents" Version="9.0.0" />
     <PackageVersion Include="Microsoft.Windows.CsWin32" Version="0.3.106" />
-    <PackageVersion Include="Microsoft.WindowsAppSDK" Version="1.5.240627000" />
-    <PackageVersion Include="Microsoft.Windows.SDK.BuildTools" Version="10.0.26100.1" />
+    <PackageVersion Include="Microsoft.WindowsAppSDK" Version="1.6.240923002" />
+    <PackageVersion Include="Microsoft.Windows.SDK.BuildTools" Version="10.0.26100.1742" />
     <PackageVersion Include="Octokit" Version="13.0.1" />
-    <PackageVersion Include="Serilog" Version="4.0.1" />
-    <PackageVersion Include="Serilog.Sinks.Async" Version="2.0.0" />
+    <PackageVersion Include="Serilog" Version="4.1.0" />
+    <PackageVersion Include="Serilog.Sinks.Async" Version="2.1.0" />
     <PackageVersion Include="Serilog.Sinks.Debug" Version="3.0.0" />
     <PackageVersion Include="Serilog.Sinks.File" Version="6.0.0" />
-    <PackageVersion Include="System.Drawing.Common" Version="8.0.7" />
+    <PackageVersion Include="System.Drawing.Common" Version="9.0.0" />
     <PackageVersion Include="Yaml2JsonNode" Version="2.1.1" />
-    <PackageVersion Include="YamlDotNet" Version="16.1.3" />
+    <PackageVersion Include="YamlDotNet" Version="16.2.0" />
   </ItemGroup>
   <!-- Test dependencies -->
   <ItemGroup>

diff --git a/scripts/Generate-SourceFromSchema.ps1 b/scripts/Generate-SourceFromSchema.ps1
diff --git a/src/Whim.Yaml.Tests/Plugins/YamlLoader_LoadFloatingWindowPluginTests.cs b/src/Whim.Yaml.Tests/Plugins/YamlLoader_LoadFloatingWindowPluginTests.cs
@@ -95,6 +95,28 @@ public void LoadFloatingWindowPlugin(string config, bool isYaml, IContext ctx)
 					""",
 				false
 			},
+			// YAML, invalid
+			{
+				"""
+					plugins:
+					  floating_window:
+					    bob: true
+					""",
+				true
+			},
+			// JSON, invalid
+			{
+				"""
+					{
+						"plugins": {
+							"floating_window": {
+								"bob": true
+							}
+						}
+					}
+					""",
+				false
+			},
 		};
 
 	[Theory, MemberAutoSubstituteData<YamlLoaderCustomization>(nameof(DisabledFloatingWindowConfig))]

diff --git a/src/Whim.Yaml.Tests/Plugins/YamlLoader_LoadFocusIndicatorPluginTests.cs b/src/Whim.Yaml.Tests/Plugins/YamlLoader_LoadFocusIndicatorPluginTests.cs
@@ -212,6 +212,28 @@ IContext ctx
 					""",
 				false
 			},
+			// YAML, invalid
+			{
+				"""
+					plugins:
+					  focus_indicator:
+					    bob: true
+					""",
+				true
+			},
+			// JSON, invalid
+			{
+				"""
+					{
+						"plugins": {
+							"focus_indicator": {
+								"bob": true
+							}
+						}
+					}
+					""",
+				false
+			},
 		};
 
 	[Theory, MemberAutoSubstituteData<YamlLoaderCustomization>(nameof(DisabledFocusIndicatorConfig))]

diff --git a/src/Whim.Yaml.Tests/Plugins/YamlLoader_LoadLayoutPreviewPluginTests.cs b/src/Whim.Yaml.Tests/Plugins/YamlLoader_LoadLayoutPreviewPluginTests.cs
@@ -96,6 +96,28 @@ public void LoadLayoutPreviewPlugin(string yaml, bool isYaml, bool isEnabled, IC
 					""",
 				false
 			},
+			// YAML, invalid
+			{
+				"""
+					plugins:
+					  layout_preview:
+					    bob: true
+					""",
+				true
+			},
+			// JSON, invalid
+			{
+				"""
+					{
+						"plugins": {
+							"layout_preview": {
+								"bob": true
+							}
+						}
+					}
+					""",
+				false
+			},
 		};
 
 	[Theory, MemberAutoSubstituteData<YamlLoaderCustomization>(nameof(DisabledLayoutPreviewConfig))]

diff --git a/src/Whim.Yaml/Schema.cs b/src/Whim.Yaml/Schema.cs
@@ -0,0 +1,6 @@
+using Corvus.Json;
+
+namespace Whim.Yaml;
+
+[JsonSchemaTypeGenerator("./schema.json")]
+public readonly partial struct Schema { }
diff --git a/src/Whim.Yaml/Whim.Yaml.csproj b/src/Whim.Yaml/Whim.Yaml.csproj
@@ -50,10 +50,17 @@
 
 	<ItemGroup>
 		<PackageReference Include="Corvus.Json.ExtendedTypes" />
+		<PackageReference Include="Corvus.Json.SourceGenerator">
+			<PrivateAssets>all</PrivateAssets>
+		</PackageReference>
 		<PackageReference Include="Yaml2JsonNode" />
 		<PackageReference Include="YamlDotNet" />
 	</ItemGroup>
 
+	<ItemGroup>
+		<AdditionalFiles Include="schema.json" />
+	</ItemGroup>
+
 	<ItemGroup>
 		<None Remove="ErrorWindow.xaml" />
 	</ItemGroup>
@@ -63,10 +70,4 @@
 			<Generator>MSBuild:Compile</Generator>
 		</Page>
 	</ItemGroup>
-
-	<Target Name="GenerateSchema" BeforeTargets="BeforeCompile">
-		<Exec Command="powershell.exe -NonInteractive -ExecutionPolicy Unrestricted .\scripts\Generate-SourceFromSchema.ps1" WorkingDirectory="..\..\" ConsoleToMsBuild="true">
-			<Output TaskParameter="ConsoleOutput" PropertyName="OutputOfExec" />
-		</Exec>
-	</Target>
 </Project>
-Original file line number
+Diff line change
@@ Expand Up / @@ -361,6 +361,3 @@ bin/whim-install.exe @@
     # docfx
     api
     _site
-    # Whim.Yaml generated files
-    src/Whim.Yaml/Generated/