Add ViewModelRegistrationType to IViewFor attribute

Introduces ViewModelRegistrationType to the IViewFor attribute and updates generator logic to support separate Splat registration for view models. Documentation, tests, and source generator code are updated to reflect the new option and ensure correct registration behavior.

Author: ChrisPulman

README.md

@@ -560,7 +560,7 @@ The class must inherit from a UI Control from any of the following platforms and
 
 ### IViewFor with Splat Registration Type
 
-Choose from the following Splat Registration Types:
+Choose from the following Splat Registration Types, option for IViewFor Registration and / or ViewModel Registration:
 - `SplatRegistrationType.PerRequest`
 - `SplatRegistrationType.LazySingleton`
 - `SplatRegistrationType.Constant`
@@ -569,7 +569,7 @@ Choose from the following Splat Registration Types:
 ```csharp
 using ReactiveUI.SourceGenerators;
 using Splat;
-[IViewFor<MyReactiveClass>(RegistrationType = SplatRegistrationType.PerRequest)]
+[IViewFor<MyReactiveClass>(RegistrationType = SplatRegistrationType.PerRequest, ViewModelRegistrationType = SplatRegistrationType.LazySingleton)]
 public partial class MyReactiveControl : UserControl
 {
     public MyReactiveControl()

src/ReactiveUI.SourceGenerator.Tests/IVIEWFOR/IViewForGeneratorTests.FromIViewFor#ReactiveUI.SourceGenerators.IViewForAttribute.g.verified.cs

@@ -21,10 +21,16 @@ namespace ReactiveUI.SourceGenerators;
 internal sealed class IViewForAttribute<T> : global::System.Attribute
 {
     /// <summary>
-    /// Gets the Splat registration type for Splat registration.
+    /// Gets the Splat registration type for Splat IViewFor registration.
     /// Registers IViewFor<T> in the Splat service locator.
     /// </summary>
     public SplatRegistrationType RegistrationType { get; init; } = SplatRegistrationType.None;
+
+    /// <summary>
+    /// Gets the Splat registration type for Splat View Model registration.
+    /// Registers IViewFor<T> in the Splat service locator.
+    /// </summary>
+    public SplatRegistrationType ViewModelRegistrationType { get; init; } = SplatRegistrationType.None;
 }
 
 /// <summary>
@@ -39,10 +45,16 @@ internal sealed class IViewForAttribute<T> : global::System.Attribute
 internal sealed class IViewForAttribute(string? viewModelType) : global::System.Attribute
 {
     /// <summary>
-    /// Gets the Splat registration type for Splat registration.
+    /// Gets the Splat registration type for Splat IViewFor registration.
     /// Registers IViewFor<T> in the Splat service locator.
     /// </summary>
     public SplatRegistrationType RegistrationType { get; init; } = SplatRegistrationType.None;
+
+    /// <summary>
+    /// Gets the Splat registration type for Splat View Model registration.
+    /// Registers IViewFor<T> in the Splat service locator.
+    /// </summary>
+    public SplatRegistrationType ViewModelRegistrationType { get; init; } = SplatRegistrationType.None;
 }
 #nullable restore
 #pragma warning restore

src/ReactiveUI.SourceGenerator.Tests/TestHelper.cs

@@ -30,19 +30,17 @@ namespace ReactiveUI.SourceGenerator.Tests;
 public sealed class TestHelper<T> : IDisposable
         where T : IIncrementalGenerator, new()
 {
-#pragma warning disable CS0618 // Type or member is obsolete
     /// <summary>
     /// Represents the NuGet library dependency for the Splat library.
     /// </summary>
     private static readonly LibraryRange SplatLibrary =
-        new("Splat", VersionRange.AllStableFloating, LibraryDependencyTarget.Package);
+        new("Splat", VersionRange.AllStable, LibraryDependencyTarget.Package);
 
     /// <summary>
     /// Represents the NuGet library dependency for the ReactiveUI library.
     /// </summary>
     private static readonly LibraryRange ReactiveuiLibrary =
-        new("ReactiveUI", VersionRange.AllStableFloating, LibraryDependencyTarget.Package);
-#pragma warning restore CS0618 // Type or member is obsolete
+        new("ReactiveUI", VersionRange.AllStable, LibraryDependencyTarget.Package);
 
     private static readonly string mscorlibPath = Path.Combine(
             System.Runtime.InteropServices.RuntimeEnvironment.GetRuntimeDirectory(),

src/ReactiveUI.SourceGenerators.Execute/TestViewWpf.cs

@@ -13,7 +13,7 @@ namespace SGReactiveUI.SourceGenerators.Test;
 /// <summary>
 /// TestView.
 /// </summary>
-[IViewFor<TestViewModel>(RegistrationType = SplatRegistrationType.PerRequest)]
+[IViewFor<TestViewModel>(RegistrationType = SplatRegistrationType.PerRequest, ViewModelRegistrationType = SplatRegistrationType.Constant)]
 public partial class TestViewWpf : Window
 {
     /// <summary>

src/ReactiveUI.SourceGenerators.Roslyn/AttributeDefinitions.cs

@@ -79,7 +79,7 @@ namespace ReactiveUI.SourceGenerators;
 /// ReactiveObjectAttribute.
 /// </summary>
 /// <seealso cref="System.Attribute" />
-[global::System.CodeDom.Compiler.GeneratedCode("ReactiveUI.SourceGenerators.ReactiveObjectGenerator", "1.1.0.0")]
+[global::System.CodeDom.Compiler.GeneratedCode("ReactiveUI.SourceGenerators.ReactiveObjectGenerator", "{{ReactiveGenerator.GeneratorVersion}}")]
 [global::System.AttributeUsage(global::System.AttributeTargets.Class, AllowMultiple = false, Inherited = false)]
 internal sealed class ReactiveObjectAttribute : global::System.Attribute;
 #nullable restore
@@ -109,7 +109,7 @@ namespace ReactiveUI.SourceGenerators;
 /// ReativeCommandAttribute.
 /// </summary>
 /// <seealso cref="Attribute" />
-[global::System.CodeDom.Compiler.GeneratedCode("ReactiveUI.SourceGenerators.ReactiveCommandGenerator", "1.1.0.0")]
+[global::System.CodeDom.Compiler.GeneratedCode("ReactiveUI.SourceGenerators.ReactiveCommandGenerator", "{{ReactiveGenerator.GeneratorVersion}}")]
 [global::System.AttributeUsage(global::System.AttributeTargets.Method, AllowMultiple = false, Inherited = false)]
 internal sealed class ReactiveCommandAttribute : global::System.Attribute
 {
@@ -242,7 +242,7 @@ namespace ReactiveUI.SourceGenerators;
 /// ObservableAsPropertyAttribute.
 /// </summary>
 /// <seealso cref="Attribute" />
-[global::System.CodeDom.Compiler.GeneratedCode("ReactiveUI.SourceGenerators.ObservableAsPropertyGenerator", "1.1.0.0")]
+[global::System.CodeDom.Compiler.GeneratedCode("ReactiveUI.SourceGenerators.ObservableAsPropertyGenerator", "{{ReactiveGenerator.GeneratorVersion}}")]
 [global::System.AttributeUsage(global::System.AttributeTargets.Field | global::System.AttributeTargets.Property | global::System.AttributeTargets.Method, AllowMultiple = false, Inherited = false)]
 internal sealed class ObservableAsPropertyAttribute : global::System.Attribute
 {
@@ -297,7 +297,7 @@ namespace ReactiveUI.SourceGenerators;
 /// ObservableAsPropertyAttribute.
 /// </summary>
 /// <seealso cref="Attribute" />
-[global::System.CodeDom.Compiler.GeneratedCode("ReactiveUI.SourceGenerators.ObservableAsPropertyGenerator", "1.1.0.0")]
+[global::System.CodeDom.Compiler.GeneratedCode("ReactiveUI.SourceGenerators.ObservableAsPropertyGenerator", "{{ReactiveGenerator.GeneratorVersion}}")]
 [global::System.AttributeUsage(global::System.AttributeTargets.Field | global::System.AttributeTargets.Property | global::System.AttributeTargets.Method, AllowMultiple = false, Inherited = false)]
 internal sealed class ObservableAsPropertyAttribute : global::System.Attribute
 {
@@ -350,15 +350,21 @@ namespace ReactiveUI.SourceGenerators;
 /// Initializes a new instance of the <see cref="IViewForAttribute"/> class.
 /// </remarks>
 /// <param name="viewModelType">Type of the view model.</param>
-[global::System.CodeDom.Compiler.GeneratedCode("ReactiveUI.SourceGenerators.IViewForGenerator", "1.1.0.0")]
+[global::System.CodeDom.Compiler.GeneratedCode("ReactiveUI.SourceGenerators.IViewForGenerator", "{{ReactiveGenerator.GeneratorVersion}}")]
 [global::System.AttributeUsage(global::System.AttributeTargets.Class, AllowMultiple = false, Inherited = false)]
 internal sealed class IViewForAttribute<T> : global::System.Attribute
 {
     /// <summary>
-    /// Gets the Splat registration type for Splat registration.
+    /// Gets the Splat registration type for Splat IViewFor registration.
     /// Registers IViewFor<T> in the Splat service locator.
     /// </summary>
     public SplatRegistrationType RegistrationType { get; init; } = SplatRegistrationType.None;
+
+    /// <summary>
+    /// Gets the Splat registration type for Splat View Model registration.
+    /// Registers IViewFor<T> in the Splat service locator.
+    /// </summary>
+    public SplatRegistrationType ViewModelRegistrationType { get; init; } = SplatRegistrationType.None;
 }
 
 /// <summary>
@@ -369,15 +375,21 @@ internal sealed class IViewForAttribute<T> : global::System.Attribute
 /// Initializes a new instance of the <see cref="IViewForAttribute"/> class.
 /// </remarks>
 /// <param name="viewModelType">Type of the view model, ensure to use the full type name including namespace.</param>
-[global::System.CodeDom.Compiler.GeneratedCode("ReactiveUI.SourceGenerators.IViewForGenerator", "1.1.0.0")]
+[global::System.CodeDom.Compiler.GeneratedCode("ReactiveUI.SourceGenerators.IViewForGenerator", "{{ReactiveGenerator.GeneratorVersion}}")]
 [global::System.AttributeUsage(global::System.AttributeTargets.Class, AllowMultiple = false, Inherited = false)]
 internal sealed class IViewForAttribute(string? viewModelType) : global::System.Attribute
 {
     /// <summary>
-    /// Gets the Splat registration type for Splat registration.
+    /// Gets the Splat registration type for Splat IViewFor registration.
     /// Registers IViewFor<T> in the Splat service locator.
     /// </summary>
     public SplatRegistrationType RegistrationType { get; init; } = SplatRegistrationType.None;
+
+    /// <summary>
+    /// Gets the Splat registration type for Splat View Model registration.
+    /// Registers IViewFor<T> in the Splat service locator.
+    /// </summary>
+    public SplatRegistrationType ViewModelRegistrationType { get; init; } = SplatRegistrationType.None;
 }
 #nullable restore
 #pragma warning restore
@@ -404,7 +416,7 @@ namespace ReactiveUI.SourceGenerators.WinForms;
 /// Initializes a new instance of the <see cref="ViewModelControlHostAttribute"/> class.
 /// </remarks>
 /// <param name="viewModelType">Type of the view model.</param>
-[global::System.CodeDom.Compiler.GeneratedCode("ReactiveUI.SourceGenerators.ViewModelControlHostGenerator", "1.1.0.0")]
+[global::System.CodeDom.Compiler.GeneratedCode("ReactiveUI.SourceGenerators.ViewModelControlHostGenerator", "{{ReactiveGenerator.GeneratorVersion}}")]
 [global::System.AttributeUsage(global::System.AttributeTargets.Class, AllowMultiple = false, Inherited = false)]
 internal sealed class ViewModelControlHostAttribute(string? baseType) : global::System.Attribute;
 #nullable restore
@@ -432,7 +444,7 @@ namespace ReactiveUI.SourceGenerators.WinForms;
 /// Initializes a new instance of the <see cref="RoutedControlHostAttribute"/> class.
 /// </remarks>
 /// <param name="viewModelType">Type of the view model.</param>
-[global::System.CodeDom.Compiler.GeneratedCode("ReactiveUI.SourceGenerators.RoutedControlHostGenerator", "1.1.0.0")]
+[global::System.CodeDom.Compiler.GeneratedCode("ReactiveUI.SourceGenerators.RoutedControlHostGenerator", "{{ReactiveGenerator.GeneratorVersion}}")]
 [global::System.AttributeUsage(global::System.AttributeTargets.Class, AllowMultiple = false, Inherited = false)]
 internal sealed class RoutedControlHostAttribute(string? baseType) : global::System.Attribute;
 #nullable restore

src/ReactiveUI.SourceGenerators.Roslyn/IViewFor/IViewForGenerator.Execute.cs

@@ -103,11 +103,24 @@ public partial class IViewForGenerator
             _ => string.Empty,
         };
 
+        token.ThrowIfCancellationRequested();
+
+        // Get RegistrationType enum value from the attribute
+        attributeData.TryGetNamedArgument("ViewModelRegistrationType", out int splatViewModelRegistrationType);
+        var viewModelRegistrationType = splatViewModelRegistrationType switch
+        {
+            1 => "RegisterLazySingleton",
+            2 => "RegisterConstant",
+            3 => "Register",
+            _ => string.Empty,
+        };
+
         return new(
             targetInfo,
             viewModelTypeName!,
             viewForBaseType,
-            registrationType);
+            registrationType,
+            viewModelRegistrationType);
     }
 
     private static string GenerateSource(string containingTypeName, string containingNamespace, string containingClassVisibility, string containingType, IViewForInfo iviewForInfo)
@@ -322,6 +335,12 @@ private static string GenerateRegistrationExtensions(in ImmutableArray<IViewForI
             .Select(static g => g.First())
             .ToImmutableArray();
 
+        var viewModelRegistrations = iviewForInfo
+            .Where(static x => !string.IsNullOrWhiteSpace(x.SplatViewModelRegistrationType))
+            .GroupBy(static x => (x.TargetInfo.TargetNamespaceWithNamespace, x.ViewModelTypeName, x.SplatRegistrationType))
+            .Select(static g => g.First())
+            .ToImmutableArray();
+
         var sb = new StringBuilder();
         sb.AppendLine("if (resolver is null) throw new global::System.ArgumentNullException(nameof(resolver));");
         foreach (var item in registrations)
@@ -350,6 +369,29 @@ private static string GenerateRegistrationExtensions(in ImmutableArray<IViewForI
             }
         }
 
+        foreach (var item in viewModelRegistrations)
+        {
+            var vmType = item.ViewModelTypeName;
+            if (!string.IsNullOrEmpty(vmType) && !vmType.StartsWith("global::", System.StringComparison.Ordinal))
+            {
+                vmType = "global::" + vmType;
+            }
+
+            // resolver.Register*/<VM, VM>();
+            switch (item.SplatViewModelRegistrationType)
+            {
+                case "RegisterLazySingleton":
+                    sb.AppendLine($"            resolver.{item.SplatViewModelRegistrationType}<{vmType}>(() => new {vmType}());");
+                    break;
+                case "Register":
+                    sb.AppendLine($"            resolver.{item.SplatViewModelRegistrationType}<{vmType}, {vmType}>();");
+                    break;
+                case "RegisterConstant":
+                    sb.AppendLine($"            resolver.{item.SplatViewModelRegistrationType}<{vmType}>(new {vmType}());");
+                    break;
+            }
+        }
+
         var registrationsBody = sb.ToString().TrimEnd();
         return
         $$"""

src/ReactiveUI.SourceGenerators.Roslyn/IViewFor/Models/IViewForInfo.cs

@@ -3,7 +3,6 @@
 // The ReactiveUI and contributors licenses this file to you under the MIT license.
 // See the LICENSE file in the project root for full license information.
 
-using ReactiveUI.SourceGenerators.Helpers;
 using ReactiveUI.SourceGenerators.Models;
 
 namespace ReactiveUI.SourceGenerators.Input.Models;
@@ -15,4 +14,5 @@ internal sealed record IViewForInfo(
     TargetInfo TargetInfo,
     string ViewModelTypeName,
     IViewForBaseType BaseType,
-    string SplatRegistrationType);
+    string SplatRegistrationType,
+    string SplatViewModelRegistrationType);