Layout engine YAML config

.config/dotnet-tools.json

@@ -4,31 +4,23 @@
   "tools": {
     "xamlstyler.console": {
       "version": "3.2404.2",
-      "commands": [
-        "xstyler"
-      ],
+      "commands": ["xstyler"],
       "rollForward": false
     },
     "csharpier": {
       "version": "0.29.2",
-      "commands": [
-        "dotnet-csharpier"
-      ],
+      "commands": ["dotnet-csharpier"],
       "rollForward": false
     },
     "docfx": {
       "version": "2.77.0",
-      "commands": [
-        "docfx"
-      ],
+      "commands": ["docfx"],
       "rollForward": false
     },
     "corvus.json.jsonschema.typegeneratortool": {
       "version": "3.1.1",
-      "commands": [
-        "generatejsonschematypes"
-      ],
+      "commands": ["generatejsonschematypes"],
       "rollForward": false
     }
   }
-}
+}

docs/docs/customize/yaml.md

@@ -1,6 +1,6 @@
 # YAML Configuration (WIP)
 
-Whim is in the process of adding YAML configuration support - this is being tracked in [#1009](https://github.com/dalyIsaac/Whim/issues/1009). This has been implemented in the `Whim.Yaml` plugin.
+Whim is in the process of adding YAML configuration support - this is being tracked in [#1009](https://github.com/dalyIsaac/Whim/issues/1009). This has been implemented in the `Whim.Yaml` plugin, and may have breaking changes in the future.
 
 ## Setup
 
@@ -46,6 +46,51 @@ To use the schema in your JSON file, add the following line at the top of your f
 }
 ```
 
+## Layout Engines
+
+The layout engines configuration has a list of layout engines that you can use to customize the layout of your windows. These apply to all workspaces, unless overridden by workspace-specific configuration.
+
+### Layout Engines Example
+
+```yaml
+layout_engines:
+  entries:
+    - type: TreeLayoutEngine
+      initial_direction: right
+
+    - type: SliceLayoutEngine
+      variant:
+        type: row
+
+    - type: SliceLayoutEngine
+      variant:
+        type: column
+
+    - type: SliceLayoutEngine
+      variant:
+        type: primary_stack
+
+    - type: SliceLayoutEngine
+      variant:
+        type: secondary_primary_stack
+
+    - type: SliceLayoutEngine
+      variant:
+        type: multi_column_stack
+        columns: [2, 1, 0]
+
+    - type: SliceLayoutEngine
+      variant:
+        type: secondary_primary_stack
+        primary_capacity: 1
+        secondary_capacity: 2
+
+    - type: FocusLayoutEngine
+      maximize: false
+```
+
+TODO: Add layout engine descriptions
+
 ## Keybinds
 
 The keybinds configuration has a list of bindings that you can use to bind commands to key combinations.
@@ -129,7 +174,7 @@ For example, to filter out Chromium windows with the class `Chrome_WidgetWin_1`,
 ```yaml
 filters:
   entries:
-    - filter_type: window_class
+    - type: window_class
       value: Chrome_WidgetWin_1
 ```
 
@@ -140,7 +185,7 @@ For example, to filter out windows with the process file name `explorer.exe`, ad
 ```yaml
 filters:
   entries:
-    - filter_type: process_file_name
+    - type: process_file_name
       value: explorer.exe
 ```
 
@@ -151,7 +196,7 @@ For example, to filter out windows with the title `Untitled - Notepad`, add the
 ```yaml
 filters:
   entries:
-    - filter_type: title
+    - type: title
       value: Untitled - Notepad
 ```
 
@@ -162,7 +207,7 @@ For example, to filter out windows with the title that matches the regex `^Untit
 ```yaml
 filters:
   entries:
-    - filter_type: title_regex
+    - type: title_regex
       value: ^Untitled - Notepad$
 ```
 
@@ -182,7 +227,7 @@ The available routing behaviors are:
 
 ### Custom Routing Behavior
 
-You can also define custom routing behavior by specifying a list of routing entries. Each routing entry has a `router_type`, `value`, and `workspace_name`.
+You can also define custom routing behavior by specifying a list of routing entries. Each routing entry has a `type`, `value`, and `workspace_name`.
 
 The available router types are:
 
@@ -198,7 +243,7 @@ For example, to route Chromium windows with the class `Chrome_WidgetWin_1` to th
 ```yaml
 routers:
   entries:
-    - router_type: window_class
+    - type: window_class
       value: Chrome_WidgetWin_1
       workspace_name: web
 ```
@@ -210,7 +255,7 @@ For example, to route windows with the process file name `explorer.exe` to the w
 ```yaml
 routers:
   entries:
-    - router_type: process_file_name
+    - type: process_file_name
       value: explorer.exe
       workspace_name: file_explorer
 ```
@@ -222,7 +267,7 @@ For example, to route windows with the title `Untitled - Notepad` to the workspa
 ```yaml
 routers:
   entries:
-    - router_type: title
+    - type: title
       value: Untitled - Notepad
       workspace_name: notepad
 ```
@@ -234,7 +279,7 @@ For example, to route windows with the title that matches the regex `^Untitled -
 ```yaml
 routers:
   entries:
-    - router_type: title_regex
+    - type: title_regex
       value: ^Untitled - Notepad$
       workspace_name: notepad
 ```

scripts/Generate-SourceFromSchema.ps1

@@ -58,7 +58,7 @@ dotnet tool run generatejsonschematypes `
     --outputPath $outputPath
 
 # If not in CI, write metadata file
-if ($null -eq $env:CI) {
+if ($LASTEXITCODE -eq 0 -and $null -eq $env:CI) {
     Write-Host "Writing metadata file..."
     @{ gitRef = $gitSha; lastWriteTime = $now } | ConvertTo-Json | Set-Content $metadataPath
 }

src/Whim.SliceLayout.Tests/SliceLayoutEngine/SliceLayoutEngineTests.cs

@@ -1,3 +1,4 @@
+using System.Diagnostics.CodeAnalysis;
 using FluentAssertions;
 using NSubstitute;
 using Whim.TestUtils;
@@ -65,6 +66,7 @@ public void Count(int windowCount, int minimizedWindowCount, IContext ctx, Slice
 	}
 
 	[Theory, AutoSubstituteData]
+	[SuppressMessage("Maintainability", "CA1508:Avoid dead conditional code")]
 	public void Equals_Null(IContext ctx, SliceLayoutPlugin plugin)
 	{
 		// Given

src/Whim.SliceLayout.Tests/SliceLayoutsTests.cs

@@ -4,6 +4,8 @@
 
 namespace Whim.SliceLayout.Tests;
 
+// NOTE: We deliberately use FluentAssertions to deeply compare the objects, instead of comparing
+// the properties one by one, or comparing by reference.
 public class SliceLayoutsTests
 {
 	[Theory, AutoSubstituteData]

src/Whim.Yaml.Tests/Layouts/YamlLayoutEngineLoaderTests.cs

@@ -0,0 +1,154 @@
+using FluentAssertions;
+using NSubstitute;
+using Whim.TestUtils;
+using Xunit;
+
+namespace Whim.Yaml.Tests;
+
+public class YamlLayoutEngineLoaderTests
+{
+	public static TheoryData<string, bool, bool> FocusLayoutEngineConfig =>
+		new()
+		{
+			{
+				"""
+					layout_engines:
+					  entries:
+					    - type: FocusLayoutEngine
+					""",
+				false,
+				true
+			},
+			{
+				"""
+					{
+						"layout_engines": {
+							"entries": [
+								{
+									"type": "FocusLayoutEngine"
+								}
+							]
+						}
+					}
+					""",
+				false,
+				false
+			},
+			{
+				"""
+					layout_engines:
+					  entries:
+					    - type: FocusLayoutEngine
+					      maximize: true
+					""",
+				true,
+				true
+			},
+			{
+				"""
+					{
+						"layout_engines": {
+							"entries": [
+								{
+									"type": "FocusLayoutEngine",
+									"maximize": true
+								}
+							]
+						}
+					}
+					""",
+				true,
+				false
+			},
+			{
+				"""
+					layout_engines:
+					  entries:
+					    - type: FocusLayoutEngine
+					      maximize: false
+					""",
+				false,
+				true
+			},
+			{
+				"""
+					{
+						"layout_engines": {
+							"entries": [
+								{
+									"type": "FocusLayoutEngine",
+									"maximize": false
+								}
+							]
+						}
+					}
+					""",
+				false,
+				false
+			},
+		};
+
+	[Theory, MemberAutoSubstituteData<YamlLoaderCustomization>(nameof(FocusLayoutEngineConfig))]
+	public void Load_FocusLayoutEngine(string config, bool maximize, bool isYaml, IContext ctx)
+	{
+		// Given a valid config with FocusLayoutEngine set
+		ctx.PluginManager.LoadedPlugins.Returns([]);
+		YamlLoaderTestUtils.SetupFileConfig(ctx, config, isYaml);
+
+		// When loading the layout engine
+		bool result = YamlLoader.Load(ctx);
+
+		// Then the layout engine is loaded
+		Assert.True(result);
+
+		ILayoutEngine[] engines = YamlLoaderTestUtils.GetLayoutEngines(ctx);
+		Assert.Single(engines);
+		engines[0].Should().BeEquivalentTo(new FocusLayoutEngine(engines[0].Identity, maximize));
+	}
+
+	public static TheoryData<string, bool> InvalidFocusLayoutEngineConfig =>
+		new()
+		{
+			{
+				"""
+					layout_engines:
+					  entries:
+					    - type: FocusLayoutEngine
+					      maximize: "bob"
+					""",
+				true
+			},
+			{
+				"""
+					{
+						"layout_engines": {
+							"entries": [
+								{
+									"type": "FocusLayoutEngine",
+									"maximize": "bob"
+								}
+							]
+						}
+					}
+					""",
+				false
+			},
+		};
+
+	[Theory, MemberAutoSubstituteData<YamlLoaderCustomization>(nameof(InvalidFocusLayoutEngineConfig))]
+	public void Load_InvalidFocusLayoutEngine(string config, bool isYaml, IContext ctx)
+	{
+		// Given an invalid config with FocusLayoutEngine set
+		ctx.PluginManager.LoadedPlugins.Returns([]);
+		YamlLoaderTestUtils.SetupFileConfig(ctx, config, isYaml);
+
+		// When loading the layout engine
+		bool result = YamlLoader.Load(ctx);
+
+		// Then the layout engine is not loaded
+		Assert.True(result);
+
+		ILayoutEngine[] engines = YamlLoaderTestUtils.GetLayoutEngines(ctx);
+		Assert.Empty(engines);
+	}
+}