ResXGenerator

KO | EN

gitlite — search

#python #hacktoberfest #golang #typescript #postgresql #react #nextjs #hacking #go #hacktoberfest2023 #java #exploit

★ 49 Open GitHub ↗

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

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# ResXGenerator

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

NOTE: This is an independent fork of VocaDb/ResXFileCodeGenerator.

## Usage

Install the `Aigamo.ResXGenerator` package:

```psl
dotnet add package Aigamo.ResXGenerator
```

Generated source from [ActivityEntrySortRuleNames.resx](https://github.com/VocaDB/vocadb/blob/6ac18dd2981f82100c8c99566537e4916920219e/VocaDbWeb.Resources/App_GlobalResources/ActivityEntrySortRuleNames.resx):

```cs
// ------------------------------------------------------------------------------
//	<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 static class ActivityEntrySortRuleNames
	{
		private static ResourceManager? s_resourceManager;
		public static ResourceManager ResourceManager => s_resourceManager ??= new ResourceManager("VocaDb.Web.App_GlobalResources.ActivityEntrySortRuleNames", typeof(ActivityEntrySortRuleNames).Assembly);
		public static CultureInfo? CultureInfo { get; set; }

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

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

## 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

## New in version 4.3

-	The generator now includes support for `IStringLocalizer` and static methods to register resources in `IServiceCollection` (no more need for "magic strings").

```c#
var local = provider.GetService<IArtistCategoriesNames>();
local.Actor // return the value string
```

or

```c#
var myViewModel = provider.GetService<IMyViewModel>();

public class MyViewModel(IArtistCategoriesNames resources) : IMyViewModel
{
	public string Value => resources.Actor // return also the value string
}
```

## New in version 4.4

-	Resources are no longer limited to strings. A resource with a `type` (for example `System.Drawing.Bitmap`, `System.Drawing.Icon`, or `System.Byte[]`), including [`ResXFileRef`](https://learn.microsoft.com/en-us/dotnet/api/system.resources.resxfileref) file references, now generates a strongly-typed member backed by `ResourceManager.GetObject`. String resources are unchanged.

```cs
/// <summary>
/// Looks up a localized resource of type System.Drawing.Bitmap.
/// </summary>
public static System.Drawing.Bitmap? Logo => (System.Drawing.Bitmap)ResourceManager.GetObject(nameof(Logo), CultureInfo);
```

Non-string resources are only supported with the `ResourceManager` generation type. `StringLocalizer` and `CodeGeneration` remain string-only, and a non-string resource used with those modes reports a build diagnostic.

-	Added support for the `LogicalName` and `ManifestResourceName` metadata on `EmbeddedResource` items, so resources whose manifest name is set explicitly are resolved with the correct name.

## Options

<a name="GenerationType"></a>
### GenerationType (per file or globally)
Use cases: https://github.com/ycanardeau/ResXGenerator/issues/6.

Some frameworks, like Blazor, use `IStringLocalizer` to get resource strings via dependency injection. To support this while keeping existing functionality, it is now possible to choose the generation type by setting the `GenerationType` parameter.

This parameter is optional. The default value is `ResourceManager` to preserve the existing behavior.

AllowedValues :
-	ResourceManager
	- When this option is chosen, the generator will use the classic [System.Resources.ResourceManager](https://learn.microsoft.com/en-us/dotnet/api/system.resources.resourcemanager?view=net-9.0) to get resource strings.
-	CodeGeneration (You can chose this option to replace the GenerateCode option)
	- When this option is chosen, the generator will generate code to access resource strings. See [Generate Code](#Generate-Code) for more details.
-	StringLocalizer
	- When this option is chosen, the generator will create interfaces and classes compatible with [Microsoft.Extensions.Localization](https://docs.microsoft.com/en-us/dotnet/core/extensions/localization) `IStringLocalizer<T>`.  
  See [Using IStringLocalizer](#IStringLocalizer) for usage examples.
-	SameAsOuter
	- When this option is chosen, the generator will use the same generation type as the outer class, if any. If no outer class exists, it falls back to `ResourceManager`.
```xml
<ItemGroup>
	<EmbeddedResource Update="Resources\ArtistCategoriesNames.resx">
		<GenerationType>StringLocalizer</GenerationType>
	</EmbeddedResource>
</ItemGroup>
```

or

```xml
<ItemGroup>
	<EmbeddedResource Update="Resources\ArtistCategoriesNames.resx" GenerationType="StringLocalizer" />
</ItemGroup>
```

If you want to apply this globally, use

```xml
<PropertyGroup>
	<ResXGenerator_GenerationType>StringLocalizer</ResXGenerator_GenerationType>
</PropertyGroup>
```

### PublicClass (per file or globally)

Use cases: https://github.com/VocaDB/ResXFileCodeGenerator/issues/2.

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

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

or

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

If you want to apply this globally, use

```xml
<PropertyGroup>
	<ResXGenerator_PublicClass>true</ResXGenerator_PublicClass>
</PropertyGroup>
```

### NullForgivingOperators (globally)

Use cases: https://github.com/VocaDB/ResXFileCodeGenerator/issues/1.

```xml
<PropertyGroup>
	<ResXGenerator_NullForgivingOperators>true</ResXGenerator_NullForgivingOperators>
</PropertyGroup>
```

By setting `ResXGenerator_NullForgivingOperators` to `true`, ResXGenerator generates

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

instead of

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

### Non-static classes (per file or globally)

To use generated resources with [Microsoft.Extensions.Localization](https://docs.microsoft.com/en-us/dotnet/core/extensions/localization) `IStringLocalizer<T>` and resource manager, the resolved type cannot be a static class. You can disable default behavior per file by setting the value to `false`.

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

or globally

```xml
<PropertyGroup>
	<ResXGenerator_StaticClass>false</ResXGenerator_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. *Not suitable for StringLocalizer*.

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

or globally

```xml
<PropertyGroup>
	<ResXGenerator_PartialClass>true</ResXGenerator_PartialClass>
</PropertyGroup>
```

### Static Members (per file or globally)

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

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

or globally

```xml
<PropertyGroup>
	<ResXGenerator_StaticMembers>false</ResXGenerator_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.

```xml
<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

```xml
<PropertyGroup>
	<ResXGenerator_ClassNamePostfix>Model</ResXGenerator_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. *Not suitable for StringLocalizer*

```xml
<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

```xml
<PropertyGroup>
	<ResXGenerator_InnerClassName>MyResources</ResXGenerator_InnerClassName>
	<ResXGenerator_InnerClassVisibility>private</ResXGenerator_InnerClassVisibility>
	<ResXGenerator_InnerClassInstanceName>EveryoneLikeMyNaming</InnerClassInstanceName>
	<ResXGenerator_StaticMembers>false</ResXGenerator_StaticMembers>
	<ResXGenerator_StaticClass>false</ResXGenerator_StaticClass>
	<ResXGenerator_PartialClass>true</ResXGenerator_PartialClass>
</PropertyGroup>
```

This example would generate files like this:

```cs
// ------------------------------------------------------------------------------
// <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("VocaDb.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.

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

or globally

```xml
<PropertyGroup>
	<ResXGenerator_InnerClassVisibility>private</ResXGenerator_InnerClassVisibility>
</PropertyGroup>
```

### Inner Class name (per file or globally)

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

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

or globally

```xml
<PropertyGroup>
	<ResXGenerator_InnerClassName>MyResources</ResXGenerator_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.

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

or globally

```xml
<PropertyGroup>
	<ResXGenerator_InnerClassInstanceName>EveryoneLikeMyNaming</ResXGenerator_InnerClassInstanceName>
</PropertyGroup>
```

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

<a name="Generate-Code"></a>
### 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 `GenerateCode` 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 `GenerateCode` 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.

```xml
<ItemGroup>
	<EmbeddedResource Update="**/*.resx">
		<GenerateCode>true</GenerateCode>
		<GenerateResource>false</GenerateResource>
	</EmbeddedResource>
</ItemGroup>
```

or globally

```xml
<PropertyGroup>
	<ResXGenerator_GenerateCode>true</ResXGenerator_GenerateCode>
</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

```xml
<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.

```xml
<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

```xml
<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 assemblies namespace and includes the filename, the `CustomToolNamespace` is taken verbatim.

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

## Excluding resx files

Individual resx files can also be excluded from being processed by setting the `SkipFile` metadata to true.

```xml
<ItemGroup>
	<EmbeddedResource Update="ExcludedFile.resx">
		<SkipFile>true</SkipFile>
	</EmbeddedResource>
</ItemGroup>
```

Alternatively it can be set with the attribute `SkipFile="true"`.

```xml
<ItemGroup>
	<EmbeddedResource Update="ExcludedFile.resx" SkipFile="true" />
</ItemGroup>
```

<a name="IStringLocalizer"></a>
## Using IStringLocalizer

To enable the generation of interfaces and classes for your resources, you need to set the `GenerationType` to [StringLocalizer](#GenerationType).  
Note: to use this, you must ensure that your project references the following NuGet packages:

- [Microsoft.Extensions.DependencyInjection](https://www.nuget.org/packages/Microsoft.Extensions.DependencyInjection)
- [Microsoft.Extensions.Localization](https://www.nuget.org/packages/Microsoft.Extensions.Localization)
- [Microsoft.Extensions.Logging](https://www.nuget.org/packages/Microsoft.Extensions.Logging)

You can now register singletons for resources using extension methods.

Examples for a file ArtistCategoriesNames.resx :
```c#
using ResXGenerator.Registration;

builder.Services
	.AddLogging();
	.AddLocalization()
	.UsingResXGenerator(); //This will register all resx class in one line of code
```

you can also (if you prefer to load resources by namespace using individual registrations). A class of registration is created by namespace.

```c#
using MyResourceAssembly;

builder.Services
	.AddLogging();
	.AddLocalization()
	.UsingArtistCategoriesNamesResX(); //This will register all resx class of the namespace in one line of code
```

You can now use dependency injection to get your resource classes.
All interfaces are in the same namespace as their corresponding resource file (or the configured namespace).

## References

-	[Introducing C# Source Generators | .NET Blog](https://devblogs.microsoft.com/dotnet/introducing-c-source-generators/)
-	[microsoft/CsWin32: A source generator to add a user-defined set of Win32 P/Invoke methods and supporting types to a C# project.](https://github.com/microsoft/cswin32)
-	[kenkendk/mdresxfilecodegenerator: Resx Designer Generator](https://github.com/kenkendk/mdresxfilecodegenerator)
-	[dotnet/ResXResourceManager: Manage localization of all ResX-Based resources in one central place.](https://github.com/dotnet/ResXResourceManager)
-	[roslyn/source-generators.cookbook.md at master · dotnet/roslyn](https://github.com/dotnet/roslyn/blob/master/docs/features/source-generators.cookbook.md)
-	[roslyn/Using Additional Files.md at master · dotnet/roslyn](https://github.com/dotnet/roslyn/blob/master/docs/analyzers/Using%20Additional%20Files.md)
-	[ufcpp - YouTube](https://www.youtube.com/channel/UCY-z_9mau6X-Vr4gk2aWtMQ)
-	[amis92/csharp-source-generators: A list of C# Source Generators (not necessarily awesome) and associated resources: articles, talks, demos.](https://github.com/amis92/csharp-source-generators)
-	[A NuGet package workflow using GitHub Actions | by Andrew Craven | Medium](https://acraven.medium.com/a-nuget-package-workflow-using-github-actions-7da8c6557863)

ResXGenerator

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README