Skip to content

Commit 9d6cc6a

Browse files
curtisy1curtisy1
authored
v1.0.0
This marks the first release in a while. A short list of notable changes: - The project has been renamed to Intl.Net, older releases will be removed from NuGet later on - the generator has been improved and stabilitzed. It's no longer required to hack-remove the generated files - Support for i18n providers. Currently only Tolgee is supported as a sample integration. Contributions welcome! - Nested JSON support. This is especially useful, if you fetch files from providers and have a concept of namespaces - Note: Currently, we separate namespaces by using the dot-notation. This means `{ "key": { "nested": "value" } }` will become `key.nested` in the resource cache and accessible via `key_nested` - In the future, I'm hoping to extend this to support custom nested classes
2 parents f6a9def + 7a4500e commit 9d6cc6a

File tree

93 files changed

+400817
-267
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

93 files changed

+400817
-267
lines changed

‎.github/workflows/create-release.yml

+5-5
Original file line numberDiff line numberDiff line change
@@ -19,18 +19,18 @@ jobs:
1919
- name: Install dependencies
2020
run: dotnet restore
2121
- name: Build
22-
run: dotnet build src/Localizati18n.ResourceGenerator/Localizati18n.ResourceGenerator.csproj --configuration Release --no-restore
22+
run: dotnet build src/Intl.Net.ResourceGenerator/Intl.Net.ResourceGenerator.csproj --configuration Release --no-restore
2323
- name: Test
2424
run: dotnet test --no-restore --verbosity normal
2525
- name: Pack Manager
26-
run: dotnet pack -c Release src/Localizati18n.ResourceManager/Localizati18n.ResourceManager.csproj
26+
run: dotnet pack -c Release src/Intl.Net.ResourceManager/Intl.Net.ResourceManager.csproj
2727
- name: Pack Generator
28-
run: dotnet pack -c Release src/Localizati18n.ResourceGenerator/Localizati18n.ResourceGenerator.csproj
28+
run: dotnet pack -c Release src/Intl.Net.ResourceGenerator/Intl.Net.ResourceGenerator.csproj
2929
- name: Publish Manager
3030
env:
3131
NUGET_AUTH_TOKEN: ${{secrets.NUGET_AUTH_TOKEN}}
32-
run: dotnet nuget push src/Localizati18n.ResourceManager/bin/Release/*.nupkg --skip-duplicate -n true -k $NUGET_AUTH_TOKEN -s https://api.nuget.org/v3/index.json
32+
run: dotnet nuget push src/Intl.Net.ResourceManager/bin/Release/*.nupkg --skip-duplicate -n true -k $NUGET_AUTH_TOKEN -s https://api.nuget.org/v3/index.json
3333
- name: Publish Generator
3434
env:
3535
NUGET_AUTH_TOKEN: ${{secrets.NUGET_AUTH_TOKEN}}
36-
run: dotnet nuget push src/Localizati18n.ResourceGenerator/bin/Release/*.nupkg --skip-duplicate -n true -k $NUGET_AUTH_TOKEN -s https://api.nuget.org/v3/index.json
36+
run: dotnet nuget push src/Intl.Net.ResourceGenerator/bin/Release/*.nupkg --skip-duplicate -n true -k $NUGET_AUTH_TOKEN -s https://api.nuget.org/v3/index.json

‎Localizati18n.sln ‎Intl.Net.sln

+11-5
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,17 @@
1-
1+
22
Microsoft Visual Studio Solution File, Format Version 12.00
33
# Visual Studio Version 16
44
VisualStudioVersion = 16.0.30914.41
55
MinimumVisualStudioVersion = 10.0.40219.1
6-
Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Localizati18n.ResourceGenerator", "src\Localizati18n.ResourceGenerator\Localizati18n.ResourceGenerator.csproj", "{210EF250-4028-42AE-9BAB-80C22F236816}"
6+
Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Intl.Net.ResourceGenerator", "src\Intl.Net.ResourceGenerator\Intl.Net.ResourceGenerator.csproj", "{210EF250-4028-42AE-9BAB-80C22F236816}"
77
EndProject
8-
Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Localizati18n.ResourceGenerator.Tests", "tests\Localizati18n.ResourceGenerator.Tests\Localizati18n.ResourceGenerator.Tests.csproj", "{47BDEBDC-42BF-4A8E-9825-FC5ECC844542}"
8+
Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Intl.Net.ResourceGenerator.Tests", "tests\Intl.Net.ResourceGenerator.Tests\Intl.Net.ResourceGenerator.Tests.csproj", "{47BDEBDC-42BF-4A8E-9825-FC5ECC844542}"
99
EndProject
10-
Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Localizati18n.ResourceManager", "src\Localizati18n.ResourceManager\Localizati18n.ResourceManager.csproj", "{D3DFDF6B-29A3-4FFA-9540-C6A35F374F74}"
10+
Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Intl.Net.ResourceManager", "src\Intl.Net.ResourceManager\Intl.Net.ResourceManager.csproj", "{D3DFDF6B-29A3-4FFA-9540-C6A35F374F74}"
1111
EndProject
12-
Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Localizati18n.WebApp", "samples\Localizati18n.WebApp\Localizati18n.WebApp.csproj", "{FE723C34-1297-43AF-9C53-30F7B009BD4A}"
12+
Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Intl.Net.WebApp", "samples\Intl.Net.WebApp\Intl.Net.WebApp.csproj", "{FE723C34-1297-43AF-9C53-30F7B009BD4A}"
13+
EndProject
14+
Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Intl.Net.Benchmark", "benchmark\Intl.Net.Benchmark.csproj", "{08A31D44-3941-43E5-9E96-BCC951CBDDF9}"
1315
EndProject
1416
Global
1517
GlobalSection(SolutionConfigurationPlatforms) = preSolution
@@ -33,6 +35,10 @@ Global
3335
{FE723C34-1297-43AF-9C53-30F7B009BD4A}.Debug|Any CPU.Build.0 = Debug|Any CPU
3436
{FE723C34-1297-43AF-9C53-30F7B009BD4A}.Release|Any CPU.ActiveCfg = Release|Any CPU
3537
{FE723C34-1297-43AF-9C53-30F7B009BD4A}.Release|Any CPU.Build.0 = Release|Any CPU
38+
{08A31D44-3941-43E5-9E96-BCC951CBDDF9}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
39+
{08A31D44-3941-43E5-9E96-BCC951CBDDF9}.Debug|Any CPU.Build.0 = Debug|Any CPU
40+
{08A31D44-3941-43E5-9E96-BCC951CBDDF9}.Release|Any CPU.ActiveCfg = Release|Any CPU
41+
{08A31D44-3941-43E5-9E96-BCC951CBDDF9}.Release|Any CPU.Build.0 = Release|Any CPU
3642
EndGlobalSection
3743
GlobalSection(SolutionProperties) = preSolution
3844
HideSolutionNode = FALSE

‎README.md

+12-23
Original file line numberDiff line numberDiff line change
@@ -1,39 +1,28 @@
1-
# Localizati18n
2-
A ResX Globalization alternative using simple JSON Key-Value-Pairs instead of bulky XML.
1+
# Intl.Net
2+
A ResX Globalization alternative using JSON instead of bulky XML.
33

44
Generates strongly-typed resource classes for looking up localized strings.
55

66
## Usage
77

8-
Install the [`Localizati18n.ResourceGenerator`](https://www.nuget.org/packages/Localizati18n.ResourceGenerator/) and [`Localizati18n.ResourceManager`](https://www.nuget.org/packages/Localizati18n.ResourceManager/) packages in your resource project:
8+
Install the [`Intl.Net.ResourceGenerator`](https://www.nuget.org/packages/Intl.Net.ResourceGenerator/) and [`Intl.Net.ResourceManager`](https://www.nuget.org/packages/Intl.Net.ResourceManager/) packages in your resource project:
99

1010
Make sure to copy your JSON resource files to your output directory and mark them as EmbeddedResource
11-
12-
If you want to use a custom namespace for your resources, add a `CustomToolNamespace` tag to your embedded resource
13-
i.e.
1411
```xml
1512
<EmbeddedResource Include="Localization.json">
1613
<CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
17-
<CustomToolNamespace>Localization</CustomToolNamespace>
1814
</EmbeddedResource>
1915
```
2016

21-
By default, source generators will not persist the generated files to disk. In many cases, it's desirable to have the generated source in version control though.
22-
I also found that Intellisense doesn't work without it, so please do copy those files if you encounter any issues
17+
For a list of configurable options, as well as supported i18n providers that fetch your translations from a remote API, please see the wiki pages.
2318

24-
Luckily, there's another tag you can use. Simply add `<EmitCompilerGeneratedFiles>true</EmitCompilerGeneratedFiles>` to your `PropertyGroup`
19+
## Performance
20+
Currently, Intl.Net is just as fast as the Resx ResourceManager shipped with dotnet itself.
21+
In cases where trying to get a non-existing key, it is even significantly faster.
2522

26-
You can then add a `<CompilerGeneratedFilesOutputPath></CompilerGeneratedFilesOutputPath>` if desired and copy the resource file after build.
27-
```xml
28-
<!-- This is important because the compiler would complain about the duplicate file otherwise -->
29-
<Target Name="RemovePreviouslyGeneratedFile" BeforeTargets="BeforeCompile">
30-
<Delete Files="Localization.cs" ContinueOnError="true" />
31-
</Target>
32-
33-
<Target Name="CopyGeneratedFile" AfterTargets="AfterBuild">
34-
<Copy SourceFiles="Generated\Localizati18n.ResourceGenerator\Localizati18n.ResourceGenerator.SourceGenerator\Localization.cs" DestinationFolder="$(ProjectDir)" />
35-
<RemoveDir Directories="Generated" />
36-
</Target>
37-
```
23+
For details and the benchmarks run, check the benchmarks folder.
24+
25+
## Related libraries
26+
If this library looks amazing, please do check out these similar projects and give them a star!
3827

39-
Note that for some reason this does not work on rebuild. If you figure out why, please submit a PR to the example project
28+
[TypealizR](https://github.com/earloc/TypealizR) - A source generator doing the same thing for .resx files. It's pretty much a modern Globalization alternative

‎benchmark/Intl.Net.Benchmark.csproj

+41
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
<Project Sdk="Microsoft.NET.Sdk">
2+
3+
<PropertyGroup>
4+
<TargetFramework>net6.0</TargetFramework>
5+
<ImplicitUsings>enable</ImplicitUsings>
6+
<Nullable>enable</Nullable>
7+
<OutputType>exe</OutputType>
8+
9+
<IsPackable>false</IsPackable>
10+
</PropertyGroup>
11+
12+
<ItemGroup>
13+
<PackageReference Include="BenchmarkDotNet" Version="0.13.4" />
14+
</ItemGroup>
15+
16+
<ItemGroup>
17+
<ProjectReference Include="..\src\Intl.Net.ResourceManager\Intl.Net.ResourceManager.csproj" />
18+
</ItemGroup>
19+
20+
<ItemGroup>
21+
<None Update="bench.json">
22+
<CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
23+
</None>
24+
</ItemGroup>
25+
26+
<ItemGroup>
27+
<EmbeddedResource Update="bench.resx">
28+
<Generator>ResXFileCodeGenerator</Generator>
29+
<LastGenOutput>bench.Designer.cs</LastGenOutput>
30+
</EmbeddedResource>
31+
</ItemGroup>
32+
33+
<ItemGroup>
34+
<Compile Update="bench.Designer.cs">
35+
<DesignTime>True</DesignTime>
36+
<AutoGen>True</AutoGen>
37+
<DependentUpon>bench.resx</DependentUpon>
38+
</Compile>
39+
</ItemGroup>
40+
41+
</Project>

‎benchmark/ResxVsJson.cs

+53
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,53 @@
1+
namespace Intl.Net.Benchmark;
2+
3+
using System.Resources;
4+
using BenchmarkDotNet.Attributes;
5+
using BenchmarkDotNet.Running;
6+
using ResourceManager;
7+
8+
public class ResxVsJson {
9+
private readonly ResourceManager resxManager;
10+
11+
private readonly JsonResourceManager jsonManager;
12+
13+
public ResxVsJson() {
14+
this.resxManager = new ResourceManager("Intl.Net.Benchmark.bench", typeof(ResxVsJson).Assembly);
15+
this.jsonManager = new JsonResourceManager("bench", typeof(ResxVsJson).Assembly, "bench");
16+
}
17+
18+
[Benchmark]
19+
public string FirstEntryJson() => jsonManager.GetString("calculatinggroupwarenetworkssystemsturquoise");
20+
21+
[Benchmark]
22+
public string FirstEntryResx() => resxManager.GetString("calculatinggroupwarenetworkssystemsturquoise");
23+
24+
[Benchmark]
25+
public string LastEntryJson() => jsonManager.GetString("FrozenErgonomicRubberPizzaglobalfirewall");
26+
27+
[Benchmark]
28+
public string LastEntryResx() => resxManager.GetString("FrozenErgonomicRubberPizzaglobalfirewall");
29+
30+
[Benchmark]
31+
public string MiddleEntryJson() => jsonManager.GetString("orchidcircuitbusAgentAutoLoanAccount");
32+
33+
[Benchmark]
34+
public string MiddleEntryResx() => resxManager.GetString("orchidcircuitbusAgentAutoLoanAccount");
35+
36+
[Benchmark]
37+
public string NonExistingEntryJson() => jsonManager.GetString("abcdefghijklmnopqrstuvwxyz");
38+
39+
[Benchmark]
40+
public string NonExistingEntryResx() => resxManager.GetString("abcdefghijklmnopqrstuvwxyz");
41+
42+
[Benchmark]
43+
public (string, string) SameEntryTwiceJson() => (jsonManager.GetString("calculatinggroupwarenetworkssystemsturquoise"), jsonManager.GetString("calculatinggroupwarenetworkssystemsturquoise"));
44+
45+
[Benchmark]
46+
public (string, string) SameEntryTwiceResx() => (resxManager.GetString("calculatinggroupwarenetworkssystemsturquoise"), resxManager.GetString("calculatinggroupwarenetworkssystemsturquoise"));
47+
}
48+
49+
public class Program {
50+
public static void Main(string[] args) {
51+
var summary = BenchmarkRunner.Run<ResxVsJson>();
52+
}
53+
}

0 commit comments

Comments
 (0)