Add AccessModifier support to ReactiveCommand (#342)

ChrisPulman · web-flow · commit 1f97e4ad4bc9 · 2025-12-09T08:03:00.000Z
* Add AccessModifier support to ReactiveCommand

Introduces the AccessModifier property to the ReactiveCommand attribute, allowing generated command properties to specify their access level. Updates documentation, attribute definitions, generator logic, and test usage to support internal, protected, private, and other modifiers.

* Add PropertyAccessModifier enum and expose in ReactiveCommandAttribute

Introduces the PropertyAccessModifier enum to specify property access levels and adds an AccessModifier property to the ReactiveCommandAttribute. This enhances control over generated property access in source generator tests.

* Add test for ReactiveCommand with access modifier

Introduces a new unit test to verify that the ReactiveCommand source generator correctly handles the AccessModifier property. Also updates generated test assets and clarifies a comment in the generator implementation.

* Remove redundant received files for ReactiveCommandAttribute

Deleted .received.cs files for DotNet8_0, DotNet9_0, and DotNet10_0 test targets as their content is now covered by the verified file. This streamlines the test assets and reduces duplication.

* Add GetNamedArgument extension and refactor usage

Introduced a generic GetNamedArgument&lt;T&gt; extension method for AttributeData to simplify retrieval of named arguments. Refactored ReactiveCommandGenerator.Execute.cs to use the new method for accessing the AccessModifier argument.
diff --git a/README.md b/README.md
@@ -37,12 +37,16 @@ ReactiveUI Source Generators automatically generate ReactiveUI objects to stream
 - `[ReactiveCommand(OutputScheduler = "RxApp.MainThreadScheduler")]` using a ReactiveUI Scheduler
 - `[ReactiveCommand(OutputScheduler = nameof(_isheduler))]` using a Scheduler defined in the class
 - `[ReactiveCommand][property: AttributeToAddToCommand]` with Attribute passthrough
+- `[ReactiveCommand(AccessModifier = PropertyAccessModifier.Internal)]` sets the access modifier of the generated command property
 - `[IViewFor(nameof(ViewModelName))]`
 - `[IViewFor<YourViewModelType>]`
 - `[IViewFor("YourNameSpace.YourGenericViewModel<int>")]` Generic
 - `[IViewFor<YourViewModelType>(RegistrationType = SplatRegistrationType.PerRequest)]` with Splat Registration Type for IViewFor registration.
 - `[IViewFor<YourViewModelType>(RegistrationType = SplatRegistrationType.LazySingleton)]` Generic with Splat Registration Type for IViewFor registration.
 - `[IViewFor<YourViewModelType>(RegistrationType = SplatRegistrationType.Constant)]` Generic with Splat Registration Type for IViewFor registration.
+- `[IViewFor<YourViewModelType>(ViewModelRegistrationType = SplatRegistrationType.PerRequest)]` Generic with Splat Registration Type for ViewModel registration.
+- `[IViewFor<YourViewModelType>(ViewModelRegistrationType = SplatRegistrationType.LazySingleton)]` Generic with Splat Registration Type for ViewModel registration.
+- `[IViewFor<YourViewModelType>(ViewModelRegistrationType = SplatRegistrationType.Constant)]` Generic with Splat Registration Type for ViewModel registration.
 - `[RoutedControlHost("YourNameSpace.CustomControl")]`
 - `[ViewModelControlHost("YourNameSpace.CustomControl")]`
 - `[BindableDerivedList]` Generates a derived list from a ReadOnlyObservableCollection backing field
@@ -544,6 +548,17 @@ public partial class MyReactiveClass
 }
 ```
 
+### Usage ReactiveCommand with AccessModifier
+```csharp
+using ReactiveUI.SourceGenerators;
+
+public partial class MyReactiveClass
+{
+    [ReactiveCommand(AccessModifier = PropertyAccessModifier.Internal)]
+    private void Execute() { }
+}
+```
+
 ## Usage IViewFor `[IViewFor(nameof(ViewModelName))]`
 
 ### IViewFor usage
diff --git a/src/ReactiveUI.SourceGenerator.Tests/REACTIVE/ReactiveGeneratorTests.FromReactivePartialProperties#ReactiveUI.SourceGenerators.AccessModifier.g.verified.cs b/src/ReactiveUI.SourceGenerator.Tests/REACTIVE/ReactiveGeneratorTests.FromReactivePartialProperties#ReactiveUI.SourceGenerators.AccessModifier.g.verified.cs
@@ -23,6 +23,19 @@ internal enum AccessModifier
     Init,
 }
 
+/// <summary>
+/// Property Access Modifier.
+/// </summary>
+internal enum PropertyAccessModifier
+{
+    Public,
+    Protected,
+    Internal,
+    Private,
+    InternalProtected,
+    PrivateProtected,
+}
+
 /// <summary>
 /// InheritanceModifier.
 /// </summary>
diff --git a/src/ReactiveUI.SourceGenerator.Tests/REACTIVE/ReactiveGeneratorTests.FromReactiveProperiesWithAttributes#ReactiveUI.SourceGenerators.AccessModifier.g.verified.cs b/src/ReactiveUI.SourceGenerator.Tests/REACTIVE/ReactiveGeneratorTests.FromReactiveProperiesWithAttributes#ReactiveUI.SourceGenerators.AccessModifier.g.verified.cs
@@ -23,6 +23,19 @@ internal enum AccessModifier
     Init,
 }
 
+/// <summary>
+/// Property Access Modifier.
+/// </summary>
+internal enum PropertyAccessModifier
+{
+    Public,
+    Protected,
+    Internal,
+    Private,
+    InternalProtected,
+    PrivateProtected,
+}
+
 /// <summary>
 /// InheritanceModifier.
 /// </summary>
diff --git a/src/ReactiveUI.SourceGenerator.Tests/REACTIVE/ReactiveGeneratorTests.FromReactiveProperties#ReactiveUI.SourceGenerators.AccessModifier.g.verified.cs b/src/ReactiveUI.SourceGenerator.Tests/REACTIVE/ReactiveGeneratorTests.FromReactiveProperties#ReactiveUI.SourceGenerators.AccessModifier.g.verified.cs
@@ -23,6 +23,19 @@ internal enum AccessModifier
     Init,
 }
 
+/// <summary>
+/// Property Access Modifier.
+/// </summary>
+internal enum PropertyAccessModifier
+{
+    Public,
+    Protected,
+    Internal,
+    Private,
+    InternalProtected,
+    PrivateProtected,
+}
+
 /// <summary>
 /// InheritanceModifier.
 /// </summary>
diff --git a/src/ReactiveUI.SourceGenerator.Tests/REACTIVE/ReactiveGeneratorTests.FromReactivePropertiesCalledValue#ReactiveUI.SourceGenerators.AccessModifier.g.verified.cs b/src/ReactiveUI.SourceGenerator.Tests/REACTIVE/ReactiveGeneratorTests.FromReactivePropertiesCalledValue#ReactiveUI.SourceGenerators.AccessModifier.g.verified.cs
@@ -23,6 +23,19 @@ internal enum AccessModifier
     Init,
 }
 
+/// <summary>
+/// Property Access Modifier.
+/// </summary>
+internal enum PropertyAccessModifier
+{
+    Public,
+    Protected,
+    Internal,
+    Private,
+    InternalProtected,
+    PrivateProtected,
+}
+
 /// <summary>
 /// InheritanceModifier.
 /// </summary>
diff --git a/src/ReactiveUI.SourceGenerator.Tests/REACTIVE/ReactiveGeneratorTests.FromReactivePropertiesWithAccess#ReactiveUI.SourceGenerators.AccessModifier.g.verified.cs b/src/ReactiveUI.SourceGenerator.Tests/REACTIVE/ReactiveGeneratorTests.FromReactivePropertiesWithAccess#ReactiveUI.SourceGenerators.AccessModifier.g.verified.cs
@@ -23,6 +23,19 @@ internal enum AccessModifier
     Init,
 }
 
+/// <summary>
+/// Property Access Modifier.
+/// </summary>
+internal enum PropertyAccessModifier
+{
+    Public,
+    Protected,
+    Internal,
+    Private,
+    InternalProtected,
+    PrivateProtected,
+}
+
 /// <summary>
 /// InheritanceModifier.
 /// </summary>
diff --git a/src/ReactiveUI.SourceGenerator.Tests/REACTIVE/ReactiveGeneratorTests.FromReactivePropertiesWithAttributesAccessAndInheritance#ReactiveUI.SourceGenerators.AccessModifier.g.verified.cs b/src/ReactiveUI.SourceGenerator.Tests/REACTIVE/ReactiveGeneratorTests.FromReactivePropertiesWithAttributesAccessAndInheritance#ReactiveUI.SourceGenerators.AccessModifier.g.verified.cs
@@ -23,6 +23,19 @@ internal enum AccessModifier
     Init,
 }
 
+/// <summary>
+/// Property Access Modifier.
+/// </summary>
+internal enum PropertyAccessModifier
+{
+    Public,
+    Protected,
+    Internal,
+    Private,
+    InternalProtected,
+    PrivateProtected,
+}
+
 /// <summary>
 /// InheritanceModifier.
 /// </summary>
diff --git a/src/ReactiveUI.SourceGenerator.Tests/REACTIVE/ReactiveGeneratorTests.FromReactivePropertiesWithIdenticalClass#ReactiveUI.SourceGenerators.AccessModifier.g.verified.cs b/src/ReactiveUI.SourceGenerator.Tests/REACTIVE/ReactiveGeneratorTests.FromReactivePropertiesWithIdenticalClass#ReactiveUI.SourceGenerators.AccessModifier.g.verified.cs
@@ -23,6 +23,19 @@ internal enum AccessModifier
     Init,
 }
 
+/// <summary>
+/// Property Access Modifier.
+/// </summary>
+internal enum PropertyAccessModifier
+{
+    Public,
+    Protected,
+    Internal,
+    Private,
+    InternalProtected,
+    PrivateProtected,
+}
+
 /// <summary>
 /// InheritanceModifier.
 /// </summary>
diff --git a/src/ReactiveUI.SourceGenerator.Tests/REACTIVE/ReactiveGeneratorTests.FromReactivePropertiesWithInit#ReactiveUI.SourceGenerators.AccessModifier.g.verified.cs b/src/ReactiveUI.SourceGenerator.Tests/REACTIVE/ReactiveGeneratorTests.FromReactivePropertiesWithInit#ReactiveUI.SourceGenerators.AccessModifier.g.verified.cs
@@ -23,6 +23,19 @@ internal enum AccessModifier
     Init,
 }
 
+/// <summary>
+/// Property Access Modifier.
+/// </summary>
+internal enum PropertyAccessModifier
+{
+    Public,
+    Protected,
+    Internal,
+    Private,
+    InternalProtected,
+    PrivateProtected,
+}
+
 /// <summary>
 /// InheritanceModifier.
 /// </summary>
diff --git a/src/ReactiveUI.SourceGenerator.Tests/REACTIVE/ReactiveGeneratorTests.FromReactivePropertiesWithNestedClass#ReactiveUI.SourceGenerators.AccessModifier.g.verified.cs b/src/ReactiveUI.SourceGenerator.Tests/REACTIVE/ReactiveGeneratorTests.FromReactivePropertiesWithNestedClass#ReactiveUI.SourceGenerators.AccessModifier.g.verified.cs
@@ -23,6 +23,19 @@ internal enum AccessModifier
     Init,
 }
 
+/// <summary>
+/// Property Access Modifier.
+/// </summary>
+internal enum PropertyAccessModifier
+{
+    Public,
+    Protected,
+    Internal,
+    Private,
+    InternalProtected,
+    PrivateProtected,
+}
+
 /// <summary>
 /// InheritanceModifier.
 /// </summary>
diff --git a/src/ReactiveUI.SourceGenerator.Tests/REACTIVECMD/ReactiveCMDGeneratorTests.FromReactiveAsyncCommand#ReactiveUI.SourceGenerators.ReactiveCommandAttribute.g.verified.cs b/src/ReactiveUI.SourceGenerator.Tests/REACTIVECMD/ReactiveCMDGeneratorTests.FromReactiveAsyncCommand#ReactiveUI.SourceGenerators.ReactiveCommandAttribute.g.verified.cs
@@ -31,6 +31,14 @@ internal sealed class ReactiveCommandAttribute : global::System.Attribute
     /// The output scheduler.
     /// </value>
     public string? OutputScheduler { get; init; }
+
+    /// <summary>
+    /// Gets the AccessModifier of the ReactiveCommand property.
+    /// </summary>
+    /// <value>
+    /// The AccessModifier of the property.
+    /// </value>
+    public PropertyAccessModifier AccessModifier { get; init; }
 }
 #nullable restore
 #pragma warning restore
diff --git a/src/ReactiveUI.SourceGenerator.Tests/REACTIVECMD/ReactiveCMDGeneratorTests.FromReactiveAsyncCommandWithParameter#ReactiveUI.SourceGenerators.ReactiveCommandAttribute.g.verified.cs b/src/ReactiveUI.SourceGenerator.Tests/REACTIVECMD/ReactiveCMDGeneratorTests.FromReactiveAsyncCommandWithParameter#ReactiveUI.SourceGenerators.ReactiveCommandAttribute.g.verified.cs
@@ -31,6 +31,14 @@ internal sealed class ReactiveCommandAttribute : global::System.Attribute
     /// The output scheduler.
     /// </value>
     public string? OutputScheduler { get; init; }
+
+    /// <summary>
+    /// Gets the AccessModifier of the ReactiveCommand property.
+    /// </summary>
+    /// <value>
+    /// The AccessModifier of the property.
+    /// </value>
+    public PropertyAccessModifier AccessModifier { get; init; }
 }
 #nullable restore
 #pragma warning restore
diff --git a/src/ReactiveUI.SourceGenerator.Tests/REACTIVECMD/ReactiveCMDGeneratorTests.FromReactiveCommand#ReactiveUI.SourceGenerators.ReactiveCommandAttribute.g.verified.cs b/src/ReactiveUI.SourceGenerator.Tests/REACTIVECMD/ReactiveCMDGeneratorTests.FromReactiveCommand#ReactiveUI.SourceGenerators.ReactiveCommandAttribute.g.verified.cs
@@ -31,6 +31,14 @@ internal sealed class ReactiveCommandAttribute : global::System.Attribute
     /// The output scheduler.
     /// </value>
     public string? OutputScheduler { get; init; }
+
+    /// <summary>
+    /// Gets the AccessModifier of the ReactiveCommand property.
+    /// </summary>
+    /// <value>
+    /// The AccessModifier of the property.
+    /// </value>
+    public PropertyAccessModifier AccessModifier { get; init; }
 }
 #nullable restore
 #pragma warning restore
diff --git a/src/ReactiveUI.SourceGenerator.Tests/REACTIVECMD/ReactiveCMDGeneratorTests.FromReactiveCommandWithAccessModifier#ReactiveUI.SourceGenerators.ReactiveCommandAttribute.g.verified.cs b/src/ReactiveUI.SourceGenerator.Tests/REACTIVECMD/ReactiveCMDGeneratorTests.FromReactiveCommandWithAccessModifier#ReactiveUI.SourceGenerators.ReactiveCommandAttribute.g.verified.cs
@@ -0,0 +1,44 @@
+﻿//HintName: ReactiveUI.SourceGenerators.ReactiveCommandAttribute.g.cs
+// Copyright (c) 2025 .NET Foundation and Contributors. All rights reserved.
+// Licensed to the .NET Foundation under one or more agreements.
+// The .NET Foundation licenses this file to you under the MIT license.
+// See the LICENSE file in the project root for full license information.
+
+// <auto-generated/>
+#pragma warning disable
+#nullable enable
+namespace ReactiveUI.SourceGenerators;
+
+/// <summary>
+/// ReativeCommandAttribute.
+/// </summary>
+/// <seealso cref="Attribute" />
+[global::System.AttributeUsage(global::System.AttributeTargets.Method, AllowMultiple = false, Inherited = false)]
+internal sealed class ReactiveCommandAttribute : global::System.Attribute
+{
+    /// <summary>
+    /// Gets the can execute method or property.
+    /// </summary>
+    /// <value>
+    /// The name of the CanExecute Observable of bool.
+    /// </value>
+    public string? CanExecute { get; init; }
+    
+    /// <summary>
+    /// Gets the output scheduler.
+    /// </summary>
+    /// <value>
+    /// The output scheduler.
+    /// </value>
+    public string? OutputScheduler { get; init; }
+
+    /// <summary>
+    /// Gets the AccessModifier of the ReactiveCommand property.
+    /// </summary>
+    /// <value>
+    /// The AccessModifier of the property.
+    /// </value>
+    public PropertyAccessModifier AccessModifier { get; init; }
+}
+#nullable restore
+#pragma warning restore
diff --git a/src/ReactiveUI.SourceGenerator.Tests/REACTIVECMD/ReactiveCMDGeneratorTests.FromReactiveCommandWithNestedClasses#ReactiveUI.SourceGenerators.ReactiveCommandAttribute.g.verified.cs b/src/ReactiveUI.SourceGenerator.Tests/REACTIVECMD/ReactiveCMDGeneratorTests.FromReactiveCommandWithNestedClasses#ReactiveUI.SourceGenerators.ReactiveCommandAttribute.g.verified.cs
@@ -31,6 +31,14 @@ internal sealed class ReactiveCommandAttribute : global::System.Attribute
     /// The output scheduler.
     /// </value>
     public string? OutputScheduler { get; init; }
+
+    /// <summary>
+    /// Gets the AccessModifier of the ReactiveCommand property.
+    /// </summary>
+    /// <value>
+    /// The AccessModifier of the property.
+    /// </value>
+    public PropertyAccessModifier AccessModifier { get; init; }
 }
 #nullable restore
 #pragma warning restore
diff --git a/src/ReactiveUI.SourceGenerator.Tests/REACTIVECMD/ReactiveCMDGeneratorTests.FromReactiveCommandWithOutputScheduler#ReactiveUI.SourceGenerators.ReactiveCommandAttribute.g.verified.cs b/src/ReactiveUI.SourceGenerator.Tests/REACTIVECMD/ReactiveCMDGeneratorTests.FromReactiveCommandWithOutputScheduler#ReactiveUI.SourceGenerators.ReactiveCommandAttribute.g.verified.cs
@@ -31,6 +31,14 @@ internal sealed class ReactiveCommandAttribute : global::System.Attribute
     /// The output scheduler.
     /// </value>
     public string? OutputScheduler { get; init; }
+
+    /// <summary>
+    /// Gets the AccessModifier of the ReactiveCommand property.
+    /// </summary>
+    /// <value>
+    /// The AccessModifier of the property.
+    /// </value>
+    public PropertyAccessModifier AccessModifier { get; init; }
 }
 #nullable restore
 #pragma warning restore
diff --git a/src/ReactiveUI.SourceGenerator.Tests/REACTIVECMD/ReactiveCMDGeneratorTests.FromReactiveCommandWithParameter#ReactiveUI.SourceGenerators.ReactiveCommandAttribute.g.verified.cs b/src/ReactiveUI.SourceGenerator.Tests/REACTIVECMD/ReactiveCMDGeneratorTests.FromReactiveCommandWithParameter#ReactiveUI.SourceGenerators.ReactiveCommandAttribute.g.verified.cs
@@ -31,6 +31,14 @@ internal sealed class ReactiveCommandAttribute : global::System.Attribute
     /// The output scheduler.
     /// </value>
     public string? OutputScheduler { get; init; }
+
+    /// <summary>
+    /// Gets the AccessModifier of the ReactiveCommand property.
+    /// </summary>
+    /// <value>
+    /// The AccessModifier of the property.
+    /// </value>
+    public PropertyAccessModifier AccessModifier { get; init; }
 }
 #nullable restore
 #pragma warning restore
diff --git a/src/ReactiveUI.SourceGenerator.Tests/UnitTests/ReactiveCMDGeneratorTests.cs b/src/ReactiveUI.SourceGenerator.Tests/UnitTests/ReactiveCMDGeneratorTests.cs
@@ -217,4 +217,25 @@ public partial class TestInnerClass3 : ReactiveObject
         // Act: Initialize the helper and run the generator. Assert: Verify the generated code.
         return TestHelper.TestPass(sourceCode);
     }
+
+    /// <summary>
+    /// Froms the reactive command with access modifier.
+    /// </summary>
+    /// <returns>A task to monitor the async.</returns>
+    [Test]
+    public Task FromReactiveCommandWithAccessModifier()
+    {
+        const string sourceCode = """
+            using System;
+            using ReactiveUI;
+            using ReactiveUI.SourceGenerators;
+            namespace TestNs;
+            public partial class TestVM : ReactiveObject
+            {
+                [ReactiveCommand(AccessModifier = PropertyAccessModifier.Internal)]
+                private int Test1() => 10;
+            }
+        """;
+        return TestHelper.TestPass(sourceCode);
+    }
 }
diff --git a/src/ReactiveUI.SourceGenerators.Execute/TestViewModel.cs b/src/ReactiveUI.SourceGenerators.Execute/TestViewModel.cs
@@ -437,7 +437,7 @@ protected virtual void Dispose(bool disposing)
     /// </summary>
     /// <param name="i">The i.</param>
     /// <returns>An Observable of int.</returns>
-    [ReactiveCommand]
+    [ReactiveCommand(AccessModifier = PropertyAccessModifier.Internal)]
     private IObservable<double?> Test8Observable(int i) => Observable.Return<double?>(i + 10.0);
 
     [ReactiveCommand]
diff --git a/src/ReactiveUI.SourceGenerators.Roslyn/AttributeDefinitions.cs b/src/ReactiveUI.SourceGenerators.Roslyn/AttributeDefinitions.cs
diff --git a/src/ReactiveUI.SourceGenerators.Roslyn/Core/Extensions/AttributeDataExtensions.cs b/src/ReactiveUI.SourceGenerators.Roslyn/Core/Extensions/AttributeDataExtensions.cs
diff --git a/src/ReactiveUI.SourceGenerators.Roslyn/ReactiveCommand/Models/CommandInfo.cs b/src/ReactiveUI.SourceGenerators.Roslyn/ReactiveCommand/Models/CommandInfo.cs
diff --git a/src/ReactiveUI.SourceGenerators.Roslyn/ReactiveCommand/ReactiveCommandGenerator.Execute.cs b/src/ReactiveUI.SourceGenerators.Roslyn/ReactiveCommand/ReactiveCommandGenerator.Execute.cs
