Morris.AutoLocalize.Fody 1.0.0

AutoLocalize

AutoLocalize is a Fody weaver that fills in ErrorMessageResourceType and ErrorMessageResourceName for your ValidationAttribute-based annotations so you only declare your resource type once per assembly.

Getting started

1. Install Fody (if you do not already use it) and AutoLocalize:

   <ItemGroup>
     <PackageReference Include="Fody" Version="6.*" PrivateAssets="All" />
     <PackageReference Include="Morris.AutoLocalize.Fody" Version="1.*" />
   </ItemGroup>
   

2. Build once. Fody will create a FodyWeavers.xml file in your project if it does not exist.
3. Add AutoLocalize to FodyWeavers.xml, then build again so weaving runs.

   <Weavers xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="FodyWeavers.xsd">
     <Morris.AutoLocalize />
   </Weavers>
   

4. Specify the assembly-level attribute that tells the weaver which resource class to use. The default ErrorMessageResourceNamePrefix is "AutoLocalize_" if you do not set it.

   using Morris.AutoLocalize;
   using System.ComponentModel.DataAnnotations;
   
   [assembly: AutoLocalizeValidationAttributes(
       typeof(Resources.ValidationMessages),
       ErrorMessageResourceNamePrefix = "AutoLocalize_")]
   
   public class Person
   {
       [Required]
       [StringLength(50, MinimumLength = 2)]
       public string Name { get; set; } = string.Empty;
   }
   

Note: In case you don't know, to get a class for your resx file you need to set its Custom Tool property to PublicResXFileCodeGenerator.

What the weaver does

• Finds every field/property decorated with an attribute descended from ValidationAttribute.
• Ensures the ErrorMessageResourceType and ErrorMessageResourceName properties are set on each attribute.
• Removes the [assembly:AutoLocalizeValidationAttributes] attribute from your build output.
• Removes the assembly reference to Morris.AutoLocalize from your build output, so your runtime assembly has no extra dependencies.

ValidationAttribute update rules

• ErrorMessageResourceResourceType is set to the value specified in the [assembly:LocalizeValidationAttributes({value here}})] attribute you added to your project.
• ErrorMessageResourceName is set to {Prefix}_{ShortAttributeName}
• If either the ErrorMessageResourceType or ErrorMessage properties are set on the attribute then it is assumed you want a specific error message, so AutoLocalize will leave the validation attribute untouched.

Resource automatic naming algorithm

• Prefix = AutoLocalize_ - this can be overridden when declaring your [assembly:LocalizeValidationAttributes(typeof(MyResource))] attribute by setting the ErrorMessageResourceNamePrefix property.
• ShortAttributeMame = The class name of the attribute that descends from ValidationAttribute without the word Attribute at the end.
  • RequiredAttribute ⇒ Required
  • SomeGenericValidationAttribute<int> ⇒ SomeGenericValidation

Examples

[assembly:AutoLocalizeValidationAttributes(typeof(DataAnnotationsMessages))]

[assembly:AutoLocalizeValidationAttributes(
   typeof(DataAnnotationsMessages),
   ErrorMessageResourceNamePrefix = "ValidationError_"
   )]

Manifest of resource keys

During weaving a CSV file named after your project (e.g. MyProject.Morris.AutoLocalize.csv) is written next to the project file. It contains all resource keys the weaver added or discovered:

ErrorMessageResourceName
AutoLocalize_Required
AutoLocalize_StringLength

Use this manifest to ensure your resource file contains entries for each key.