Adds support for Description attribute.

Author: pekspro

README-NuGet.md

@@ -2,8 +2,8 @@
 
 A C# source generator that automatically extracts values from data annotation
 attributes and exposes them as strongly-typed constants. Access your
-`StringLength`, `Range`, `Required` and `Display` attribute values as constants
-in your classes.
+`StringLength`, `Range`, `Required`, `Display` and `Description` attribute
+values as constants in your classes.
 
 ## Why Use This?
 
@@ -51,15 +51,17 @@ Apply `[DataAnnotationValues]` directly to each class you want to generate
 constants for:
 
 ```csharp
-[DataAnnotationValues(StringLength = true, Range = true, Required = true, Display = true)]
+[DataAnnotationValues(StringLength = true, Range = true, Required = true, Display = true, Description = true)]
 public partial class Product
 {
     [Display(Name = "Product name")]
+    [Description("Name of the product")]
     [Required]
     [StringLength(100)]
     public string? Name { get; set; }
 
     [Display(Name = "Product price")]
+    [Description("Price of the product")]
     [Required]
     [Range(0.01, 999999.99)]
     public decimal Price { get; set; }
@@ -77,7 +79,7 @@ each class you want to generate constants for. You can use the
 ```csharp
 using Pekspro.DataAnnotationValuesExtractor;
 
-[DataAnnotationValuesConfiguration(StringLength = true, Range = true, Required = true, Display = true)]
+[DataAnnotationValuesConfiguration(StringLength = true, Range = true, Required = true, Display = true, Description = true)]
 [DataAnnotationValuesToGenerate(typeof(Customer))]
 [DataAnnotationValuesToGenerate(typeof(Order))]
 [DataAnnotationValuesToGenerate(typeof(Product))]
@@ -89,7 +91,16 @@ partial class ValidationConstants
 Your model classes remain unchanged.
 
 This approach is especially useful when working with auto-generated models, such
-as those created by Entity Framework scaffolding.
+as those created by Entity Framework scaffolding. If you do, and you have all
+your models in a folder, you can use this PowerShell script to generate the
+attributes for all models in that folder:
+
+```powershell
+Get-ChildItem -Filter '*.cs' |
+    Where-Object { -not ($_.BaseName -match '(?i)context') } |
+    ForEach-Object { "[DataAnnotationValuesToGenerate(typeof($($_.BaseName)))]" } |
+    Set-Clipboard
+```
 
 ### Use the generated constants
 
@@ -102,12 +113,14 @@ int maxNameLength = Product.Annotations.Name.MaximumLength; // 100
 int minNameLength = Product.Annotations.Name.MinimumLength; // 0
 bool nameRequired = Product.Annotations.Name.IsRequired; // true
 string? nameDisplayName = Product.Annotations.Name.Display.Name; // Product name
+string? nameDescription = Product.Annotations.Name.Description.Text; // Name description
 
 // Price
 double minPrice = Product.Annotations.Price.Minimum; // 0.01
 double maxPrice = Product.Annotations.Price.Maximum; // 999999.99
 bool priceRequired = Product.Annotations.Price.IsRequired;
 string? priceDisplayName = Product.Annotations.Price.Display.Name; // Price name
+string? priceDescription = Product.Annotations.Price.Description.Text; // Price description
 
 // Sku
 bool skuRequired = Product.Annotations.Sku.IsRequired; // false

README.md

@@ -6,8 +6,8 @@ status](https://github.com/pekspro/DataAnnotationValuesExtractor/actions/workflo
 
 A C# source generator that automatically extracts values from data annotation
 attributes and exposes them as strongly-typed constants. Access your
-`StringLength`, `Range`, `Required` and `Display` attribute values as constants
-in your classes.
+`StringLength`, `Range`, `Required`, `Display` and `Description` attribute
+values as constants in your classes.
 
 ## Why Use This?
 
@@ -55,15 +55,17 @@ Apply `[DataAnnotationValues]` directly to each class you want to generate
 constants for:
 
 ```csharp
-[DataAnnotationValues(StringLength = true, Range = true, Required = true, Display = true)]
+[DataAnnotationValues(StringLength = true, Range = true, Required = true, Display = true, Description = true)]
 public partial class Product
 {
     [Display(Name = "Product name")]
+    [Description("Name of the product")]
     [Required]
     [StringLength(100)]
     public string? Name { get; set; }
 
     [Display(Name = "Product price")]
+    [Description("Price of the product")]
     [Required]
     [Range(0.01, 999999.99)]
     public decimal Price { get; set; }
@@ -81,7 +83,7 @@ each class you want to generate constants for. You can use the
 ```csharp
 using Pekspro.DataAnnotationValuesExtractor;
 
-[DataAnnotationValuesConfiguration(StringLength = true, Range = true, Required = true, Display = true)]
+[DataAnnotationValuesConfiguration(StringLength = true, Range = true, Required = true, Display = true, Description = true)]
 [DataAnnotationValuesToGenerate(typeof(Customer))]
 [DataAnnotationValuesToGenerate(typeof(Order))]
 [DataAnnotationValuesToGenerate(typeof(Product))]
@@ -115,12 +117,14 @@ int maxNameLength = Product.Annotations.Name.MaximumLength; // 100
 int minNameLength = Product.Annotations.Name.MinimumLength; // 0
 bool nameRequired = Product.Annotations.Name.IsRequired; // true
 string? nameDisplayName = Product.Annotations.Name.Display.Name; // Product name
+string? nameDescription = Product.Annotations.Name.Description.Text; // Name description
 
 // Price
 double minPrice = Product.Annotations.Price.Minimum; // 0.01
 double maxPrice = Product.Annotations.Price.Maximum; // 999999.99
 bool priceRequired = Product.Annotations.Price.IsRequired;
 string? priceDisplayName = Product.Annotations.Price.Display.Name; // Price name
+string? priceDescription = Product.Annotations.Price.Description.Text; // Price description
 
 // Sku
 bool skuRequired = Product.Annotations.Sku.IsRequired; // false
@@ -161,7 +165,8 @@ the following properties to control which constants are generated:
 | `StringLength` | `true`  | `MaximumLength`, `MinimumLength`                                 | Extract values from `[StringLength]` attribute. |
 | `Range`        | `true`  | `Minimum`, `Maximum`, `MinimumIsExclusive`, `MaximumIsExclusive` | Extract values from `[Range]` attribute.        |
 | `Required`     | `false` | `IsRequired`                                                     | Detect presence of `[Required]` attribute.      |
-| `Display`     | `false` | `Name`, `Description`, `ShortName`                                | Extract values from `[Display]` attribute.      |
+| `Display`      | `false` | `Name`, `Description`, `ShortName`                               | Extract values from `[Display]` attribute.       |
+| `Description`  | `false` | `Text`                                                           | Extract value from `[Description]` attribute.    |
 
 Do you miss some annotations? Create an issue and let me know.
 
@@ -193,10 +198,11 @@ directory.
 Given this input:
 
 ```csharp
-[DataAnnotationValues(StringLength = true, Range = true, Required = true, Display = true)]
+[DataAnnotationValues(StringLength = true, Range = true, Required = true, Display = true, Description = true)]
 public partial class Player
 {
     [Display(Name = "Player name", ShortName ="Name", Description = "Name of player")]
+    [Description("The player's name")]
     [Required]
     [StringLength(50)]
     public string? Name { get; set; }
@@ -259,6 +265,17 @@ public partial class Player
                 /// </summary>
                 public const string? Description = "Name of player";
             }
+
+            /// <summary>
+            /// Description attribute values for Name.
+            /// </summary>
+            public static class Description
+            {
+                /// <summary>
+                /// Description text for Name.
+                /// </summary>
+                public const string? Text = "The player's name";
+            }
         }
 
         /// <summary>

Source/Library/Pekspro.DataAnnotationValuesExtractor.Attributes/DataAnnotationValuesAttribute.cs

@@ -30,6 +30,12 @@ public class DataAnnotationValuesAttribute : System.Attribute
         /// Is set to false by default.
         /// </summary>
         public bool Display { get; set; }
+
+        /// <summary>
+        /// Whether Description attribute values should be included.
+        /// Is set to false by default.
+        /// </summary>
+        public bool Description { get; set; }
     }
 }
 

Source/Library/Pekspro.DataAnnotationValuesExtractor.Attributes/DataAnnotationValuesOptionsAttribute.cs

@@ -32,6 +32,12 @@ public class DataAnnotationValuesOptionsAttribute : System.Attribute
         /// Is set to false by default.
         /// </summary>
         public bool Display { get; set; }
+
+        /// <summary>
+        /// Whether Description attribute values should be included.
+        /// Is set to false by default.
+        /// </summary>
+        public bool Description { get; set; }
     }
 }
 

Source/Library/Pekspro.DataAnnotationValuesExtractor/DataAnnotationValuesDetailedOptions.cs

@@ -15,7 +15,8 @@ namespace Pekspro.DataAnnotationValuesExtractor;
     public readonly bool AddRange;
     public readonly bool AddRequired;
     public readonly bool AddDisplay;
-    
+    public readonly bool AddDescription;
+
     public DataAnnotationValuesDetailedOptions(
         string name,
         string? ns,
@@ -24,14 +25,15 @@ public DataAnnotationValuesDetailedOptions(
         bool addStringLength,
         bool addRange,
         bool addRequired,
-        bool addDisplay = false
+        bool addDisplay = false,
+        bool addDescription = false
         )
     {
         Name = name;
         Namespace = ns;
         FullFileName = fullFileName;
         Types = types;
-        
+
         if (fullFileName != string.Empty)
         {
             FilePath = Path.GetDirectoryName(fullFileName);
@@ -45,6 +47,7 @@ public DataAnnotationValuesDetailedOptions(
         AddRange = addRange;
         AddRequired = addRequired;
         AddDisplay = addDisplay;
+        AddDescription = addDescription;
     }
 
     public bool Equals(DataAnnotationValuesDetailedOptions other)
@@ -57,6 +60,7 @@ public bool Equals(DataAnnotationValuesDetailedOptions other)
             && AddRange == other.AddRange
             && AddRequired == other.AddRequired
             && AddDisplay == other.AddDisplay
+            && AddDescription == other.AddDescription
             && TypesEqual(Types, other.Types);
     }
 
@@ -106,6 +110,7 @@ public override int GetHashCode()
             hash = hash * 23 + AddRange.GetHashCode();
             hash = hash * 23 + AddRequired.GetHashCode();
             hash = hash * 23 + AddDisplay.GetHashCode();
+            hash = hash * 23 + AddDescription.GetHashCode();
 
             if (!Types.IsDefault)
             {

Source/Library/Pekspro.DataAnnotationValuesExtractor/DataAnnotationValuesExtractor.cs

@@ -78,6 +78,7 @@ static void Execute(in DataAnnotationValuesDetailedOptions toGenerate, SourcePro
         bool addRange = true;
         bool addRequired = false;
         bool addDisplay = false;
+        bool addDescription = false;
         var typesBuilder = ImmutableArray.CreateBuilder<ITypeSymbol>();
 
         foreach (AttributeData attributeData in symbol.GetAttributes())
@@ -110,6 +111,12 @@ static void Execute(in DataAnnotationValuesDetailedOptions toGenerate, SourcePro
                     {
                         addDisplay = display;
                     }
+
+                    if (namedArgument.Key == nameof(DataAnnotationValuesOptionsAttribute.Description)
+                        && namedArgument.Value.Value is bool description)
+                    {
+                        addDescription = description;
+                    }
                 }
             }
             else if (attributeData.AttributeClass?.Name == "DataAnnotationValuesToGenerateAttribute" &&
@@ -134,11 +141,12 @@ static void Execute(in DataAnnotationValuesDetailedOptions toGenerate, SourcePro
                 name,
                 nameSpace,
                 filePath,
-                ExtractTypeInformation(typesBuilder.ToImmutable(), addStringLength, addRange, addRequired, addDisplay),
+                ExtractTypeInformation(typesBuilder.ToImmutable(), addStringLength, addRange, addRequired, addDisplay, addDescription),
                 addStringLength,
                 addRange,
                 addRequired,
-                addDisplay
+                addDisplay,
+                addDescription
             );
     }
 
@@ -167,6 +175,7 @@ static void Execute(in DataAnnotationValuesDetailedOptions toGenerate, SourcePro
         bool addRange = true;
         bool addRequired = false;
         bool addDisplay = false;
+        bool addDescription = false;
 
         // Get configuration from the DataAnnotationValuesAttribute
         foreach (AttributeData attributeData in symbol.GetAttributes())
@@ -199,6 +208,12 @@ static void Execute(in DataAnnotationValuesDetailedOptions toGenerate, SourcePro
                     {
                         addDisplay = display;
                     }
+
+                    if (namedArgument.Key == nameof(DataAnnotationValuesAttribute.Description)
+                        && namedArgument.Value.Value is bool description)
+                    {
+                        addDescription = description;
+                    }
                 }
             }
         }
@@ -211,11 +226,12 @@ static void Execute(in DataAnnotationValuesDetailedOptions toGenerate, SourcePro
                 name,
                 nameSpace,
                 filePath,
-                ExtractTypeInformation(types, addStringLength, addRange, addRequired, addDisplay),
+                ExtractTypeInformation(types, addStringLength, addRange, addRequired, addDisplay, addDescription),
                 addStringLength,
                 addRange,
                 addRequired,
-                addDisplay
+                addDisplay,
+                addDescription
             );
     }
 
@@ -224,7 +240,8 @@ static ImmutableArray<TypeInformation> ExtractTypeInformation(
         bool includeStringLength,
         bool includeRange,
         bool includeRequired,
-        bool includeDisplay)
+        bool includeDisplay,
+        bool includeDescription)
     {
         var builder = ImmutableArray.CreateBuilder<TypeInformation>();
 
@@ -239,6 +256,7 @@ static ImmutableArray<TypeInformation> ExtractTypeInformation(
                 RangeInfo? range = null;
                 bool isRequired = false;
                 DisplayInfo? display = null;
+                DescriptionInfo? description = null;
 
                 // Check for StringLength attribute
                 if (includeStringLength)
@@ -318,7 +336,7 @@ static ImmutableArray<TypeInformation> ExtractTypeInformation(
                     {
                         string? name = null;
                         string? shortName = null;
-                        string? description = null;
+                        string? displayDescription = null;
 
                         // Extract named arguments
                         foreach (var namedArg in displayAttr.NamedArguments)
@@ -333,27 +351,46 @@ static ImmutableArray<TypeInformation> ExtractTypeInformation(
                             }
                             else if (namedArg.Key == "Description" && namedArg.Value.Value is string descriptionValue)
                             {
-                                description = descriptionValue;
+                                displayDescription = descriptionValue;
                             }
                         }
 
                         // Only create DisplayInfo if at least one value is present
-                        if (name != null || shortName != null || description != null)
+                        if (name != null || shortName != null || displayDescription != null)
+                        {
+                            display = new DisplayInfo(name, shortName, displayDescription);
+                        }
+                    }
+                }
+
+                // Check for Description attribute
+                if (includeDescription)
+                {
+                    var descriptionAttr = property.GetAttributes()
+                        .FirstOrDefault(a => a.AttributeClass?.Name == "DescriptionAttribute" &&
+                                           a.AttributeClass?.ContainingNamespace?.ToDisplayString() == "System.ComponentModel");
+
+                    if (descriptionAttr != null && descriptionAttr.ConstructorArguments.Length > 0)
+                    {
+                        string? text = descriptionAttr.ConstructorArguments[0].Value as string;
+
+                        if (text != null)
                         {
-                            display = new DisplayInfo(name, shortName, description);
+                            description = new DescriptionInfo(text);
                         }
                     }
                 }
 
                 // Only add property if it has any attributes we're tracking
-                if (stringLength.HasValue || range.HasValue || includeRequired || display.HasValue)
+                if (stringLength.HasValue || range.HasValue || includeRequired || display.HasValue || description.HasValue)
                 {
                     propertyInfos.Add(new PropertyInformation(
                         property.Name,
                         stringLength,
                         range,
                         isRequired,
-                        display));
+                        display,
+                        description));
                 }
             }