LMP.Localize 8.1.0

LMP.Localize

A lightweight, thread-safe text localization library for .NET. It supports hierarchical culture fallback, on-the-fly hot reloading, and zero-allocation logging.

Features

• 🌲 Culture Inheritance (Fallback): Automatically resolves missing keys through the culture hierarchy (e.g., en-US → en).
• 🔄 Hot Reloading: Monitors folders using FileSystemWatcher and instantly updates dictionaries without blocking reader threads.
• 🛡️ Thread-Safe: Designed from the ground up for high-concurrency environments using ConcurrentDictionary and atomic references.
• 📊 Production-Ready: Natively integrates with ILoggerFactory using high-performance, compile-time generated LoggerMessage methods.

File Format

The library expects plain text files with a simple key=value structure. Keys are case-insensitive.

Example file: C:\Localization\en\strings.txt

welcome_message = Welcome to our application!
error_unknown = An unexpected error occurred.
button_save = Save changes

Quick Start

1. Initialize Options and Path Provider

using YourLibrary.Localization;
using Microsoft.Extensions.Logging;

// 1. Configure options
var options = new LanguageManagerOptions(
    BaseFolder: @"C:\Localization", 
    TrackChanges: true // Enables hot reloading via FileSystemWatcher
);

// 2. Choose a path provider (Default structure: {BaseFolder}/{Culture}/{FileName})
// By default, it looks for {YourAssemblyName}.txt, or you can specify a custom name:
ILanguagePathProvider pathProvider = new DefaultLanguagePathProvider("strings.txt");

// 3. Create the manager (ILoggerFactory parameter is optional)
ILoggerFactory loggerFactory = LoggerFactory.Create(builder => builder.AddConsole());
using var manager = new LanguageManager(options, pathProvider, loggerFactory);

2. Access Localized Strings

You can easily retrieve translations via indexers using either culture string names or CultureInfo objects:

// Access via string indexer (culture names are case-insensitive and trimmed)
ILanguage english = manager["en-US"];
Console.WriteLine(english["welcome_message"]); // Output: Welcome to our application!

// Access via CultureInfo indexer
ILanguage russian = manager[CultureInfo.GetCultureInfo("ru")];
Console.WriteLine(russian["button_save"]); // Output: Save changes

Culture Fallback Mechanics

The library utilizes the Chain of Responsibility design pattern. If a specific region file (e.g., en-US) does not contain the requested key, the system recursively looks for it in the parent culture file (en).