Senlin.Mo.Localization 1.0.25-alpha

Senlin.Mo.Localization

• reading in other languages: English, 中文.

Introduction

Provide multi-language support, use source generator and json configuration file to generate resource files.

Quick Start

Add NuGet package

dotnet add package Senlin.Mo.Localization

Define JSON file

• Create l.json file in the project

{
  "hello": "Hello",
  "sayHelloTo": "Hello {name}!"
}

• Modify the project configuration, set AdditionalFiles

<ItemGroup>
    <AdditionalFiles Include="l.json">
        <CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
    </AdditionalFiles>
</ItemGroup>

• Check the generated files L.g.cs, LResource.g.cs

• Example

  • Create folder L
  • Add zh.json

  {
    "hello": "你好",
    "sayHelloTo": "你好，{name}！"
  }
  

  • Modify the project configuration

  <ItemGroup>
      <None Update="L\*.json">
          <CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
      </None>
  </ItemGroup>
  

  • Use the generated file (inherit LResource or use JSON file)

  var zh = new ZhResource();
  var ja = new JaResource();
  var resourceProvider = new LResourceProvider(zh, ja);
  
  var currentCulture = "zh";
  GetCulture getCulture = () => currentCulture;
  GetCultureResource getCultureResource = resourceProvider.GetResource;
  
  var resolver = new LStringResolver(getCulture, getCultureResource);
  var zhHello = resolver[L.Hello];
  Console.WriteLine(zhHello);
  
  currentCulture = "ja";
  var jaHello = resolver[L.Hello];
  Console.WriteLine(jaHello);
  
  Console.WriteLine(resolver[L.SayHelloTo("世界")]);
  currentCulture = "unknown";
  Console.WriteLine(resolver[L.SayHelloTo("World")]);
  
  public class JaResource : LResource
  {
    public override string Culture => "ja";
  
    protected override string Hello => "こんにちは";
  
    protected override string SayHelloTo => "こんにちは、{name}";
  }
  
  public class ZhResource : ILResource
  {
    public string Culture => "zh";
  
    public Dictionary<string, string> GetResource()
    {
        var jsonPath = Path.Combine(
            Directory.GetCurrentDirectory(),
            "L",
            $"{Culture}.json");
        var json = File.ReadAllText(jsonPath);
        return JsonSerializer.Deserialize<Dictionary<string, string>>(json)!;
    }
  }
  

  • Default use l.json file, if you need to modify, please configure the project's MoLocalizationFile

  <Project>
    <PropertyGroup>
        <MoLocalizationFile>l-customize.config</MoLocalizationFile>
    </PropertyGroup>
    <ItemGroup>
        <CompilerVisibleProperty Include="MoLocalizationFile" />
    </ItemGroup>
  </Project>