Skip to content
/ ResXFileCodeGenerator Public
forked from VocaDB/ResXFileCodeGenerator

Catglobe.ResXFileCodeGenerator is a C# source generator to generate strongly-typed resource classes for looking up localized strings.

License

MIT license
2 stars 12 forks Branches Tags Activity
Star
Notifications You must be signed in to change notification settings

Catglobe/ResXFileCodeGenerator

BranchesTags
 
 

Repository files navigation

ResXFileCodeGenerator

Converts Resx files into ultra fast runtime lookups using Source Generator.

Usage

Install the Catglobe.ResXFileCodeGenerator package:

dotnet add package Catglobe.ResXFileCodeGenerator

New in version 4

Welcome to ResXFileCodeGenerator v4 — a bold new chapter in resource generation! This release unleashes a suite of innovative features to revolutionize the way you manage your localized strings.

Yes, ChatGPT may have written this documentation, but the features are real!

Introducting ResxSettingsAttribute

Ever felt boxed in by conventional resource mapping? With the all-new ResxSettingsAttribute, you can finally break free from filename-based constraints. Whether you’re juggling nested types, generics, or unconventional code organization, this attribute puts you in full control.

For example, consider this elegantly nested class:

public partial class Z<T1> : IX
{
	internal partial class Y<T2>
	{
		[ResxSettings()]
		private partial class Z<T3>
		{

		}
	}
}

Now, behold the magic of the generated output:

public partial class Z<T1> {
    internal partial class Y<T2> {
        private partial class Z<T3> {

            /// <summary>
            /// Looks up a localized string similar to this is my long string.
            /// </summary>
            private string? Name1 => GetString_("this is my long string");
        }
    }
}

No more wrestling with naming conventions — the power is now in your hands!

Introducting ResxSettingsAttribute For Enums

Enums are no longer second-class citizens. With this new update, you can generate localized resources directly for your enums, making your code cleaner and more intuitive.

For instance:

[ResxSettings(ForEnum = typeof(XEnum), MembersVisibility = Visibility.Public)]
internal partial class XEnumResources<T3>
{

}

public enum XEnum
{
	Enum1 = 0,
	Enum2 = 1
}

and the generated output is:

using __ENUM = global::Catglobe.ResXFileCodeGenerator.Tests.IntegrationTests.XEnum;
...
internal partial class XEnumResources<T3> {

    /// <summary>
    /// Looks up a localized string similar to this is my long string.
    /// </summary>
    public static string? Enum1 => GetString_("this is my long string");
    /// <summary>
    /// Looks up a localized string for the given enum.
    /// </summary>
    public static string? ToString(__ENUM e) => e switch {
        __ENUM.Enum1 => Enum1,
        __ENUM.Enum2 => string.Empty,
        _ => string.Empty,
    };

}

And if your enum isn’t entirely covered by translations, the generator will kindly warn you with an Info-level message.

Notice

Remember: the ResxSettings attribute can only be applied once per basename. If you try to use it in, say, both Myfile.Razor.cs and Myfile.Razor, the generator won’t know which one to trust. This is a necessary technical constraint to keep everything consistent.

Optimizations

We’ve supercharged the evaluation chain to boost generator’s memoization engine! Now, it regenerates code far less often during your editing sessions—meaning a faster, more responsive experience every time you code.

Upgrade from older versions

You may need to change your package reference to have PrivateAssets="all" such as this, otherwise the compiler may not be able to find the new Attribute:

<PackageReference Include="Catglobe.ResXFileCodeGenerator" Version="4.0.1" PrivateAssets="all" />

New in version 3

  • The generator now utilizes the IIncrementalGenerator API to instantly update the generated code, thus giving you instant intellisense.

  • Added error handling for multiple members of same name, and members that have same name as class. These are clickable in visual studio to lead you to the source of the error, unlike before where they resulted in broken builds and you had to figure out why.

  • Namespace naming fixed for resx files in the top level folder.

  • Resx files can now be named with multiple extensions, e.g. myresources.cshtml.resx and will result in class being called myresources.

  • Added the ability to generate inner classes, partial outer classes and non-static members. Very useful if you want to ensure that only a particular class can use those resources instead of being spread around the codebase.

  • Use same 'Link' setting as msbuild uses to determine embedded file name.

  • Can set a class postfix name

New in version 3.1

  • The generator can now generate code to lookup translations instead of using the 20 year old System.Resources.ResourceManager

Options

PublicClass (per file or globally)

Use cases: #2.

Since version 2.0.0, Catglobe.ResXFileCodeGenerator generates internal classes by default. You can change this behavior by setting PublicClass to true.

<ItemGroup>
  <EmbeddedResource Update="Resources\ArtistCategoriesNames.resx">
    <PublicClass>true</PublicClass>
  </EmbeddedResource>
</ItemGroup>

or

<ItemGroup>
  <EmbeddedResource Update="Resources\ArtistCategoriesNames.resx" PublicClass="true" />
</ItemGroup>

If you want to apply this globally, use

<PropertyGroup>
  <ResXFileCodeGenerator_PublicClass>true</ResXFileCodeGenerator_PublicClass>
</PropertyGroup>

NullForgivingOperators (globally)

Use cases: #1.

<PropertyGroup>
  <ResXFileCodeGenerator_NullForgivingOperators>true</ResXFileCodeGenerator_NullForgivingOperators>
</PropertyGroup>

By setting ResXFileCodeGenerator_NullForgivingOperators to true, Catglobe.ResXFileCodeGenerator generates

public static string CreateDate => ResourceManager.GetString(nameof(CreateDate), CultureInfo)!;

instead of

public static string? CreateDate => ResourceManager.GetString(nameof(CreateDate), CultureInfo);

Non-static classes (per file or globally)

To use generated resources with Microsoft.Extensions.Localization IStringLocalizer<T> and resource manager, the resolved type cannot be a static class. You can disable default behaviour per file by setting the value to false.

<ItemGroup>
  <EmbeddedResource Update="Resources\ArtistCategoriesNames.resx">
    <StaticClass>false</StaticClass>
  </EmbeddedResource>
</ItemGroup>

or globally

<PropertyGroup>
  <ResXFileCodeGenerator_StaticClass>false</ResXFileCodeGenerator_StaticClass>
</PropertyGroup>

With global non-static class you can also reset StaticClass per file by setting the value to anything but false.

Partial classes (per file or globally)

To extend an existing class, you can make your classes partial.

<ItemGroup>
  <EmbeddedResource Update="Resources\ArtistCategoriesNames.resx">
    <PartialClass>true</PartialClass>
  </EmbeddedResource>
</ItemGroup>

or globally

<PropertyGroup>
  <ResXFileCodeGenerator_PartialClass>true</ResXFileCodeGenerator_PartialClass>
</PropertyGroup>

Static Members (per file or globally)

In some rare cases it might be useful for the members to be non-static.

<ItemGroup>
  <EmbeddedResource Update="Resources\ArtistCategoriesNames.resx">
    <StaticMembers>false</StaticMembers>
  </EmbeddedResource>
</ItemGroup>

or globally

<PropertyGroup>
  <ResXFileCodeGenerator_StaticMembers>false</ResXFileCodeGenerator_StaticMembers>
</PropertyGroup>

Postfix class name (per file or globally)

In some cases the it is useful if the name of the generated class doesn't follow the filename.

A clear example is Razor pages that always generates a class for the code-behind named "-Model". This example configuration allows you to use Resources.MyResource in your model, or @Model.Resources.MyResource in your cshtml file.

<ItemGroup>
  <EmbeddedResource Update="**/Pages/*.resx">
    <ClassNamePostfix>Model</ClassNamePostfix>
    <StaticMembers>false</StaticMembers>
    <StaticClass>false</StaticClass>
    <PartialClass>true</PartialClass>
    <PublicClass>true</PublicClass>
    <InnerClassVisibility>public</InnerClassVisibility>
    <PartialClass>false</PartialClass>
    <InnerClassInstanceName>Resources</InnerClassInstanceName>
    <InnerClassName>_Resources</InnerClassName>
  </EmbeddedResource>
</ItemGroup>

or just the postfix globally

<PropertyGroup>
  <ResXFileCodeGenerator_ClassNamePostfix>Model</ResXFileCodeGenerator_ClassNamePostfix>
</PropertyGroup>

Inner classes (per file or globally)

If your resx files are organized along with code files, it can be quite useful to ensure that the resources are not accessible outside the specific class the resx file belong to.

<ItemGroup>
    <EmbeddedResource Update="**/*.resx">
        <DependentUpon>$([System.String]::Copy('%(FileName).cs'))</DependentUpon>
        <InnerClassName>MyResources</InnerClassName>
        <InnerClassVisibility>private</InnerClassVisibility>
        <InnerClassInstanceName>EveryoneLikeMyNaming</InnerClassInstanceName>
        <StaticMembers>false</StaticMembers>
        <StaticClass>false</StaticClass>
        <PartialClass>true</PartialClass>
    </EmbeddedResource>
    <EmbeddedResource Update="**/*.??.resx;**/*.??-??.resx">
        <DependentUpon>$([System.IO.Path]::GetFileNameWithoutExtension('%(FileName)')).resx</DependentUpon>
    </EmbeddedResource>
</ItemGroup>

or globally

<PropertyGroup>
  <ResXFileCodeGenerator_InnerClassName>MyResources</ResXFileCodeGenerator_InnerClassName>
  <ResXFileCodeGenerator_InnerClassVisibility>private</ResXFileCodeGenerator_InnerClassVisibility>
  <ResXFileCodeGenerator_InnerClassInstanceName>EveryoneLikeMyNaming</InnerClassInstanceName>
  <ResXFileCodeGenerator_StaticMembers>false</ResXFileCodeGenerator_StaticMembers>
  <ResXFileCodeGenerator_StaticClass>false</ResXFileCodeGenerator_StaticClass>
  <ResXFileCodeGenerator_PartialClass>true</ResXFileCodeGenerator_PartialClass>
</PropertyGroup>

This example would generate files like this:

// ------------------------------------------------------------------------------
// <auto-generated>
//     This code was generated by a tool.
//
//     Changes to this file may cause incorrect behavior and will be lost if
//     the code is regenerated.
// </auto-generated>
// ------------------------------------------------------------------------------
#nullable enable
namespace Resources
{
    using System.Globalization;
    using System.Resources;

    public partial class ActivityEntryModel
    {
        public MyResources EveryoneLikeMyNaming { get; } = new();

        private class MyResources
        {
            private static ResourceManager? s_resourceManager;
            public static ResourceManager ResourceManager => s_resourceManager ??= new ResourceManager("Catglobe.Web.App_GlobalResources.ActivityEntryModel", typeof(ActivityEntryModel).Assembly);
            public CultureInfo? CultureInfo { get; set; }

            /// <summary>
            /// Looks up a localized string similar to Oldest.
            /// </summary>
            public string? CreateDate => ResourceManager.GetString(nameof(CreateDate), CultureInfo);

            /// <summary>
            /// Looks up a localized string similar to Newest.
            /// </summary>
            public string? CreateDateDescending => ResourceManager.GetString(nameof(CreateDateDescending), CultureInfo);
        }
    }
}

Inner Class Visibility (per file or globally)

By default inner classes are not generated, unless this setting is one of the following:

  • Public
  • Internal
  • Private
  • Protected
  • SameAsOuter

Case is ignored, so you could use "private".

It is also possible to use "NotGenerated" to override on a file if the global setting is to generate inner classes.

<ItemGroup>
    <EmbeddedResource Update="**/*.resx">
        <InnerClassVisibility>private</InnerClassVisibility>
    </EmbeddedResource>
</ItemGroup>

or globally

<PropertyGroup>
  <ResXFileCodeGenerator_InnerClassVisibility>private</ResXFileCodeGenerator_InnerClassVisibility>
</PropertyGroup>

Inner Class name (per file or globally)

By default the inner class is named "Resources", which can be overriden with this setting:

<ItemGroup>
    <EmbeddedResource Update="**/*.resx">
        <InnerClassName>MyResources</InnerClassName>
    </EmbeddedResource>
</ItemGroup>

or globally

<PropertyGroup>
  <ResXFileCodeGenerator_InnerClassName>MyResources</ResXFileCodeGenerator_InnerClassName>
</PropertyGroup>

Inner Class instance name (per file or globally)

By default no instance is available of the class, but that can be made available if this setting is given.

<ItemGroup>
    <EmbeddedResource Update="**/*.resx">
        <InnerClassInstanceName>EveryoneLikeMyNaming</InnerClassInstanceName>
    </EmbeddedResource>
</ItemGroup>

or globally

<PropertyGroup>
  <ResXFileCodeGenerator_InnerClassInstanceName>EveryoneLikeMyNaming</ResXFileCodeGenerator_InnerClassInstanceName>
</PropertyGroup>

For brevity, settings to make everything non-static is omitted.

Generate Code (per file or globally)

By default the ancient System.Resources.ResourceManager is used.

Benefits of using System.Resources.ResourceManager:

  • Supports custom CultureInfo
  • Languages are only loaded the first time a language is referenced
  • Only use memory for the languages used
  • Can ship satellite dlls separately

Disadvantages of using System.Resources.ResourceManager

  • The satellite dlls are always lazy loaded, so cold start penalty is high
  • Satellite dlls requires that you can scan the dir for which files are available, which can cause issues in some project types
  • Loading a satellite dll takes way more memory than just loading the respective strings
  • Build time for .resources -> satellite dll can be quite slow (~150msec per file)
  • Linker optimization doesn't work, since it cannot know which resources are referenced

Benefits of using Catglobe code generation:

  • All languages are placed in the main dll, no more satellite dlls
  • Lookup speed is ~600% faster (5ns vs 33ns)
  • Zero allocations
  • Very small code footprint (about 10 bytes per language, instead of including the entire System.Resources)
  • Very fast build time
  • Because all code is referencing the strings directly, the linker can see which strings are actually used and which are not.
  • No cold start penalty
  • Smaller combined size of dll (up to 50%, since it doesn't need to store the keys for every single language)

Disadvantages of using Catglobe code generation

  • Since CultureInfo are pre-computed, custom CultureInfo are not supported (or rather, they always return the default language)
  • Cannot lookup "all" keys (unless using reflection)
  • Main dll size increased since it contains all language strings (sometimes, the compiler can pack code strings much better than resource strings and it doesn't need to store the keys)

Notice, it is required to set GenerateResource to false for all resx files to prevent the built-in resgen.exe from running.

<ItemGroup>
    <EmbeddedResource Update="**/*.resx">
        <UseResManager>true</UseResManager>
        <GenerateResource>false</GenerateResource>
    </EmbeddedResource>
</ItemGroup>

or globally

<PropertyGroup>
  <ResXFileCodeGenerator_UseResManager>true</ResXFileCodeGenerator_UseResManager>
</PropertyGroup>
<ItemGroup>
    <EmbeddedResource Update="@(EmbeddedResource)">
        <GenerateResource>false</GenerateResource>
    </EmbeddedResource>
</ItemGroup>

If you get build error MSB3030, add this to your csproj to prevent it from trying to copy satellite dlls that no longer exists

<Target Name="PreventMSB3030" DependsOnTargets="ComputeIntermediateSatelliteAssemblies" BeforeTargets="GenerateSatelliteAssemblies" >
  <ItemGroup>
    <IntermediateSatelliteAssembliesWithTargetPath Remove="@(IntermediateSatelliteAssembliesWithTargetPath)"></IntermediateSatelliteAssembliesWithTargetPath>
  </ItemGroup>   
</Target>

Resource file namespaces

Linked resources namespace follow Link if it is set. The Link setting is also used by msbuild built-in 'resgen.exe' to determine the embedded filename.

Use-case: Linking .resx files from outside source (e.g. generated in a localization sub-module by translators) and expose them as "Resources" namespace.

<ItemGroup>
  <EmbeddedResource Include="..\..\Another.Project\Translations\*.resx">
    <Link>Resources\%(FileName)%(Extension)</Link>
    <PublicClass>true</PublicClass>
    <StaticClass>false</StaticClass>
  </EmbeddedResource>
  <EmbeddedResource Update="..\..\Another.Project\Translations\*.*.resx">
    <DependentUpon>$([System.IO.Path]::GetFilenameWithoutExtension([System.String]::Copy('%(FileName)'))).resx</DependentUpon>
  </EmbeddedResource>
</ItemGroup>

You can also use the TargetPath to just overwrite the namespace

<ItemGroup>
  <EmbeddedResource Include="..\..\Another.Project\Translations\*.resx">
    <TargetPath>Resources\%(FileName)%(Extension)</TargetPath>
    <PublicClass>true</PublicClass>
    <StaticClass>false</StaticClass>
  </EmbeddedResource>
  <EmbeddedResource Update="..\..\Another.Project\Translations\*.*.resx">
    <DependentUpon>$([System.IO.Path]::GetFilenameWithoutExtension([System.String]::Copy('%(FileName)'))).resx</DependentUpon>
  </EmbeddedResource>
</ItemGroup>

It is also possible to set the namespace using the CustomToolNamespace setting. Unlike the Link and TargetPath, which will prepend the assemblys namespace and includes the filename, the CustomToolNamespace is taken verbatim.

<ItemGroup>
  <EmbeddedResource Update="**\*.resx">
    <CustomToolNamespace>MyNamespace.AllMyResourcesAreBelongToYouNamespace</CustomToolNamespace>
  </EmbeddedResource>
</ItemGroup>

References

About

Catglobe.ResXFileCodeGenerator is a C# source generator to generate strongly-typed resource classes for looking up localized strings.

Resources

Readme

License

MIT license
Activity
Custom properties

Stars

2 stars

Watchers

0 watching

Forks

1 fork
Report repository

Releases 9

v4.0.9 Latest
Mar 1, 2025
+ 8 releases

Packages

No packages published

Languages

  • C# 100.0%