Rename [NotifyDataErrorInfo] attribute

Author: Sergio0694

CommunityToolkit.Mvvm.SourceGenerators/ComponentModel/Models/PropertyInfo.cs

@@ -21,7 +21,7 @@ namespace CommunityToolkit.Mvvm.SourceGenerators.ComponentModel.Models;
 /// <param name="PropertyChangedNames">The sequence of property changed properties to notify.</param>
 /// <param name="NotifiedCommandNames">The sequence of commands to notify.</param>
 /// <param name="AlsoBroadcastChange">Whether or not the generated property also broadcasts changes.</param>
-/// <param name="AlsoValidateProperty">Whether or not the generated property also validates its value.</param>
+/// <param name="NotifyDataErrorInfo">Whether or not the generated property also validates its value.</param>
 /// <param name="ForwardedAttributes">The sequence of forwarded attributes for the generated property.</param>
 internal sealed record PropertyInfo(
     string TypeNameWithNullabilityAnnotations,
@@ -31,7 +31,7 @@ internal sealed record PropertyInfo(
     ImmutableArray<string> PropertyChangedNames,
     ImmutableArray<string> NotifiedCommandNames,
     bool AlsoBroadcastChange,
-    bool AlsoValidateProperty,
+    bool NotifyDataErrorInfo,
     ImmutableArray<AttributeInfo> ForwardedAttributes)
 {
     /// <summary>
@@ -49,7 +49,7 @@ protected override void AddToHashCode(ref HashCode hashCode, PropertyInfo obj)
             hashCode.AddRange(obj.PropertyChangedNames);
             hashCode.AddRange(obj.NotifiedCommandNames);
             hashCode.Add(obj.AlsoBroadcastChange);
-            hashCode.Add(obj.AlsoValidateProperty);
+            hashCode.Add(obj.NotifyDataErrorInfo);
             hashCode.AddRange(obj.ForwardedAttributes, AttributeInfo.Comparer.Default);
         }
 
@@ -64,7 +64,7 @@ protected override bool AreEqual(PropertyInfo x, PropertyInfo y)
                 x.PropertyChangedNames.SequenceEqual(y.PropertyChangedNames) &&
                 x.NotifiedCommandNames.SequenceEqual(y.NotifiedCommandNames) &&
                 x.AlsoBroadcastChange == y.AlsoBroadcastChange &&
-                x.AlsoValidateProperty == y.AlsoValidateProperty &&
+                x.NotifyDataErrorInfo == y.NotifyDataErrorInfo &&
                 x.ForwardedAttributes.SequenceEqual(y.ForwardedAttributes, AttributeInfo.Comparer.Default);
         }
     }

CommunityToolkit.Mvvm.SourceGenerators/ComponentModel/ObservablePropertyGenerator.Execute.cs

@@ -168,7 +168,7 @@ internal static class Execute
             if (alsoValidateProperty && !hasAnyValidationAttributes)
             {
                 builder.Add(
-                    MissingValidationAttributesForAlsoValidatePropertyError,
+                    MissingValidationAttributesForNotifyDataErrorInfoError,
                     fieldSymbol,
                     fieldSymbol.ContainingType,
                     fieldSymbol.Name);
@@ -452,14 +452,14 @@ private static bool TryGetIsBroadcastingChanges(
         /// <param name="attributeData">The <see cref="AttributeData"/> instance for <paramref name="fieldSymbol"/>.</param>
         /// <param name="diagnostics">The current collection of gathered diagnostics.</param>
         /// <param name="isValidationTargetValid">Whether or not the the property is in a valid target that can validate values.</param>
-        /// <returns>Whether or not the generated property for <paramref name="fieldSymbol"/> used <c>[AlsoValidateProperty]</c>.</returns>
+        /// <returns>Whether or not the generated property for <paramref name="fieldSymbol"/> used <c>[NotifyDataErrorInfo]</c>.</returns>
         private static bool TryGetIsValidatingProperty(
             IFieldSymbol fieldSymbol,
             AttributeData attributeData,
             ImmutableArray<Diagnostic>.Builder diagnostics,
             out bool isValidationTargetValid)
         {
-            if (attributeData.AttributeClass?.HasFullyQualifiedName("global::CommunityToolkit.Mvvm.ComponentModel.AlsoValidatePropertyAttribute") == true)
+            if (attributeData.AttributeClass?.HasFullyQualifiedName("global::CommunityToolkit.Mvvm.ComponentModel.NotifyDataErrorInfoAttribute") == true)
             {
                 // If the containing type is valid, track it
                 if (fieldSymbol.ContainingType.InheritsFromFullyQualifiedName("global::CommunityToolkit.Mvvm.ComponentModel.ObservableValidator"))
@@ -471,7 +471,7 @@ private static bool TryGetIsValidatingProperty(
 
                 // Otherwise just emit the diagnostic and then ignore the attribute
                 diagnostics.Add(
-                    MissingObservableValidatorInheritanceForAlsoValidatePropertyError,
+                    MissingObservableValidatorInheritanceForNotifyDataErrorInfoError,
                     fieldSymbol,
                     fieldSymbol.ContainingType,
                     fieldSymbol.Name);
@@ -582,7 +582,7 @@ public static MemberDeclarationSyntax GetPropertySyntax(PropertyInfo propertyInf
             // If validation is requested, add a call to ValidateProperty:
             //
             // ValidateProperty(value, <PROPERTY_NAME>);
-            if (propertyInfo.AlsoValidateProperty)
+            if (propertyInfo.NotifyDataErrorInfo)
             {
                 setterStatements.Add(
                     ExpressionStatement(

CommunityToolkit.Mvvm.SourceGenerators/ComponentModel/ObservablePropertyGenerator.cs

@@ -38,14 +38,14 @@ public void Initialize(IncrementalGeneratorInitializationContext context)
             fieldSymbols
             .Where(static item => item.HasAttributeWithFullyQualifiedName("global::CommunityToolkit.Mvvm.ComponentModel.ObservablePropertyAttribute"));
 
-        // Get diagnostics for fields using [NotifyPropertyChangedFor], [NotifyCanExecuteChangedFor], [AlsoBroadcastChange] and [AlsoValidateProperty], but not [ObservableProperty]
+        // Get diagnostics for fields using [NotifyPropertyChangedFor], [NotifyCanExecuteChangedFor], [AlsoBroadcastChange] and [NotifyDataErrorInfo], but not [ObservableProperty]
         IncrementalValuesProvider<Diagnostic> fieldSymbolsWithOrphanedDependentAttributeWithErrors =
             fieldSymbols
             .Where(static item =>
                 (item.HasAttributeWithFullyQualifiedName("global::CommunityToolkit.Mvvm.ComponentModel.NotifyPropertyChangedForAttribute") ||
                  item.HasAttributeWithFullyQualifiedName("global::CommunityToolkit.Mvvm.ComponentModel.NotifyCanExecuteChangedForAttribute") ||
                  item.HasAttributeWithFullyQualifiedName("global::CommunityToolkit.Mvvm.ComponentModel.AlsoBroadcastChangeAttribute") ||
-                 item.HasAttributeWithFullyQualifiedName("global::CommunityToolkit.Mvvm.ComponentModel.AlsoValidatePropertyAttribute")) &&
+                 item.HasAttributeWithFullyQualifiedName("global::CommunityToolkit.Mvvm.ComponentModel.NotifyDataErrorInfoAttribute")) &&
                  !item.HasAttributeWithFullyQualifiedName("global::CommunityToolkit.Mvvm.ComponentModel.ObservablePropertyAttribute"))
             .Select(static (item, _) => Execute.GetDiagnosticForFieldWithOrphanedDependentAttributes(item));
 

CommunityToolkit.Mvvm.SourceGenerators/Diagnostics/DiagnosticDescriptors.cs

@@ -319,17 +319,17 @@ internal static class DiagnosticDescriptors
     /// <summary>
     /// Gets a <see cref="DiagnosticDescriptor"/> indicating when <c>[ObservableProperty]</c> is applied to a field in an invalid type.
     /// <para>
-    /// Format: <c>"The field {0}.{1} needs to be annotated with [ObservableProperty] in order to enable using [NotifyPropertyChangedFor], [NotifyCanExecuteChangedFor], [AlsoBroadcastChange] and [AlsoValidateProperty]"</c>.
+    /// Format: <c>"The field {0}.{1} needs to be annotated with [ObservableProperty] in order to enable using [NotifyPropertyChangedFor], [NotifyCanExecuteChangedFor], [AlsoBroadcastChange] and [NotifyDataErrorInfo]"</c>.
     /// </para>
     /// </summary>
     public static readonly DiagnosticDescriptor FieldWithOrphanedDependentObservablePropertyAttributesError = new DiagnosticDescriptor(
         id: "MVVMTK0020",
         title: "Invalid use of attributes dependent on [ObservableProperty]",
-        messageFormat: "The field {0}.{1} needs to be annotated with [ObservableProperty] in order to enable using [NotifyPropertyChangedFor], [NotifyCanExecuteChangedFor], [AlsoBroadcastChange] and [AlsoValidateProperty]",
+        messageFormat: "The field {0}.{1} needs to be annotated with [ObservableProperty] in order to enable using [NotifyPropertyChangedFor], [NotifyCanExecuteChangedFor], [AlsoBroadcastChange] and [NotifyDataErrorInfo]",
         category: typeof(ObservablePropertyGenerator).FullName,
         defaultSeverity: DiagnosticSeverity.Error,
         isEnabledByDefault: true,
-        description: "Fields not annotated with [ObservableProperty] cannot use [NotifyPropertyChangedFor], [NotifyCanExecuteChangedFor], [AlsoBroadcastChange] and [AlsoValidateProperty].",
+        description: "Fields not annotated with [ObservableProperty] cannot use [NotifyPropertyChangedFor], [NotifyCanExecuteChangedFor], [AlsoBroadcastChange] and [NotifyDataErrorInfo].",
         helpLinkUri: "https://aka.ms/mvvmtoolkit");
 
     /// <summary>
@@ -399,32 +399,32 @@ internal static class DiagnosticDescriptors
     /// <summary>
     /// Gets a <see cref="DiagnosticDescriptor"/> indicating when the target type doesn't inherit from the <c>ObservableValidator</c> class.
     /// <para>
-    /// Format: <c>"The field {0}.{1} cannot be annotated with [AlsoValidateProperty], as it is declared in a type that doesn't inherit from ObservableValidator"</c>.
+    /// Format: <c>"The field {0}.{1} cannot be annotated with [NotifyDataErrorInfo], as it is declared in a type that doesn't inherit from ObservableValidator"</c>.
     /// </para>
     /// </summary>
-    public static readonly DiagnosticDescriptor MissingObservableValidatorInheritanceForAlsoValidatePropertyError = new DiagnosticDescriptor(
+    public static readonly DiagnosticDescriptor MissingObservableValidatorInheritanceForNotifyDataErrorInfoError = new DiagnosticDescriptor(
         id: "MVVMTK0025",
         title: "Missing ObservableValidator inheritance",
-        messageFormat: "The field {0}.{1} cannot be annotated with [AlsoValidateProperty], as it is declared in a type that doesn't inherit from ObservableValidator",
+        messageFormat: "The field {0}.{1} cannot be annotated with [NotifyDataErrorInfo], as it is declared in a type that doesn't inherit from ObservableValidator",
         category: typeof(ObservablePropertyGenerator).FullName,
         defaultSeverity: DiagnosticSeverity.Error,
         isEnabledByDefault: true,
-        description: "Cannot apply [AlsoValidateProperty] to fields that are declared in a type that doesn't inherit from ObservableValidator.",
+        description: "Cannot apply [NotifyDataErrorInfo] to fields that are declared in a type that doesn't inherit from ObservableValidator.",
         helpLinkUri: "https://aka.ms/mvvmtoolkit");
 
     /// <summary>
-    /// Gets a <see cref="DiagnosticDescriptor"/> indicating when the target field uses [AlsoValidateProperty] but has no validation attributes.
+    /// Gets a <see cref="DiagnosticDescriptor"/> indicating when the target field uses [NotifyDataErrorInfo] but has no validation attributes.
     /// <para>
-    /// Format: <c>"The field {0}.{1} cannot be annotated with [AlsoValidateProperty], as it doesn't have any validation attributes to use during validation"</c>.
+    /// Format: <c>"The field {0}.{1} cannot be annotated with [NotifyDataErrorInfo], as it doesn't have any validation attributes to use during validation"</c>.
     /// </para>
     /// </summary>
-    public static readonly DiagnosticDescriptor MissingValidationAttributesForAlsoValidatePropertyError = new DiagnosticDescriptor(
+    public static readonly DiagnosticDescriptor MissingValidationAttributesForNotifyDataErrorInfoError = new DiagnosticDescriptor(
         id: "MVVMTK0026",
         title: "Missing validation attributes",
-        messageFormat: "The field {0}.{1} cannot be annotated with [AlsoValidateProperty], as it doesn't have any validation attributes to use during validation",
+        messageFormat: "The field {0}.{1} cannot be annotated with [NotifyDataErrorInfo], as it doesn't have any validation attributes to use during validation",
         category: typeof(ObservablePropertyGenerator).FullName,
         defaultSeverity: DiagnosticSeverity.Error,
         isEnabledByDefault: true,
-        description: "Cannot apply [AlsoValidateProperty] to fields that don't have any validation attributes to use during validation.",
+        description: "Cannot apply [NotifyDataErrorInfo] to fields that don't have any validation attributes to use during validation.",
         helpLinkUri: "https://aka.ms/mvvmtoolkit");
 }

CommunityToolkit.Mvvm/ComponentModel/Attributes/AlsoValidatePropertyAttribute.cs renamed to CommunityToolkit.Mvvm/ComponentModel/Attributes/NotifyDataErrorInfoAttribute.cs

@@ -17,7 +17,7 @@ namespace CommunityToolkit.Mvvm.ComponentModel;
 /// partial class MyViewModel : ObservableValidator
 /// {
 ///     [ObservableProperty]
-///     [AlsoValidateProperty]
+///     [NotifyDataErrorInfo]
 ///     [Required]
 ///     [MinLength(2)]
 ///     private string username;
@@ -39,6 +39,6 @@ namespace CommunityToolkit.Mvvm.ComponentModel;
 /// </code>
 /// </summary>
 [AttributeUsage(AttributeTargets.Field, AllowMultiple = false, Inherited = false)]
-public sealed class AlsoValidatePropertyAttribute : Attribute
+public sealed class NotifyDataErrorInfoAttribute : Attribute
 {
 }

tests/CommunityToolkit.Mvvm.SourceGenerators.UnitTests/Test_SourceGeneratorsDiagnostics.cs

@@ -1217,7 +1217,7 @@ public partial class MyViewModel : ObservableObject
     }
 
     [TestMethod]
-    public void MissingObservableValidatorInheritanceForAlsoValidatePropertyError()
+    public void MissingObservableValidatorInheritanceForNotifyDataErrorInfoError()
     {
         string source = @"
             using System.ComponentModel.DataAnnotations;
@@ -1230,7 +1230,7 @@ public partial class SampleViewModel
                 {
                     [ObservableProperty]
                     [Required]
-                    [AlsoValidateProperty]
+                    [NotifyDataErrorInfo]
                     private string name;
                 }
             }";
@@ -1239,7 +1239,7 @@ public partial class SampleViewModel
     }
 
     [TestMethod]
-    public void MissingValidationAttributesForAlsoValidatePropertyError()
+    public void MissingValidationAttributesForNotifyDataErrorInfoError()
     {
         string source = @"
             using System.ComponentModel.DataAnnotations;
@@ -1250,7 +1250,7 @@ namespace MyApp
                 public partial class SampleViewModel : ObservableValidator
                 {
                     [ObservableProperty]
-                    [AlsoValidateProperty]
+                    [NotifyDataErrorInfo]
                     private string name;
                 }
             }";

tests/CommunityToolkit.Mvvm.UnitTests/Test_ObservablePropertyAttribute.cs

@@ -232,7 +232,7 @@ public void Test_ObservablePropertyWithValueNamedField_WithValidationAttributes(
 
         Assert.AreEqual(model.Value, "Hello world");
 
-        // The [AlsoValidateProperty] attribute wasn't used, so the property shouldn't be validated
+        // The [NotifyDataErrorInfo] attribute wasn't used, so the property shouldn't be validated
         Assert.IsFalse(errorsChanged);
 
         CollectionAssert.AreEqual(new[] { nameof(model.Value) }, propertyNames);
@@ -965,7 +965,7 @@ public partial class ModelWithValuePropertyWithAutomaticValidation : ObservableV
         [ObservableProperty]
         [Required]
         [MinLength(5)]
-        [AlsoValidateProperty]
+        [NotifyDataErrorInfo]
         private string? value;
     }