-
Notifications
You must be signed in to change notification settings - Fork 399
Add Localization Features package for System.CommandLine #1013
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Draft
fredrikhr
wants to merge
12
commits into
dotnet:main
Choose a base branch
from
fredrikhr:localization
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Draft
Changes from all commits
Commits
Show all changes
12 commits
Select commit
Hold shift + click to select a range
d931e1d
Add new localization project with unit tests
fredrikhr b28033a
Add localized help file builder
fredrikhr 0c4855e
Add Localization extensions to CommandLineBuilder
fredrikhr e7452ac
Test IStringLocalizerFactory in invocation
fredrikhr ad6eb1c
Restructure Localization Extensions
fredrikhr a86d2c6
Defensive loading of Hosting Abstractions library
fredrikhr d71bb38
Add localization playground project
fredrikhr 104bc10
Show Help at the end of Playground execution
fredrikhr 042d089
Use Xliff Tasks for localized translations
fredrikhr 8d69f6e
Localized output of DefaultHelpText
fredrikhr 46fe1fb
Add braces to if/foreach/else expressions
fredrikhr 8587a5c
Only capture execution context if needed
fredrikhr File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1 @@ | ||
| xlf |
30 changes: 30 additions & 0 deletions
30
samples/LocalizationPlayground/CultureEnvironmentCommandLineExtensions.cs
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,30 @@ | ||
| using System; | ||
| using System.CommandLine.Builder; | ||
| using System.CommandLine.Invocation; | ||
| using System.Globalization; | ||
| using System.Threading; | ||
|
|
||
| namespace LocalizationPlayground | ||
| { | ||
| internal static class CultureEnvironmentCommandLineExtensions | ||
| { | ||
| internal static CommandLineBuilder UseCultureEnvironment( | ||
| this CommandLineBuilder builder) | ||
| { | ||
| return builder.UseMiddleware(async (context, next) => | ||
| { | ||
| if (Environment.GetEnvironmentVariable("DOTNET_SYSTEM_GLOBALIZATION_CULTURE") is string culture && | ||
| !string.IsNullOrEmpty(culture)) | ||
| CultureInfo.CurrentCulture = CultureInfo.CurrentUICulture = CultureInfo.GetCultureInfo(culture); | ||
|
|
||
| await next(context).ConfigureAwait(false); | ||
|
|
||
| if (context.InvocationResult is IInvocationResult innerResult) | ||
| { | ||
| var execCtx = ExecutionContext.Capture(); | ||
| context.InvocationResult = new ExecutionContextRestoringInvocationResult(execCtx, innerResult); | ||
| } | ||
| }, MiddlewareOrder.ExceptionHandler); | ||
| } | ||
| } | ||
| } |
35 changes: 35 additions & 0 deletions
35
samples/LocalizationPlayground/ExecutionContextRestoringInvocationResult.cs
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,35 @@ | ||
| using System; | ||
| using System.CommandLine.Invocation; | ||
| using System.Threading; | ||
|
|
||
| namespace LocalizationPlayground | ||
| { | ||
| internal class ExecutionContextRestoringInvocationResult : IInvocationResult | ||
| { | ||
| private static readonly ContextCallback executionContextApplyCallback = state => | ||
| { | ||
| var (@this, context) = (ValueTuple<IInvocationResult, InvocationContext>)state!; | ||
| @this.Apply(context); | ||
| }; | ||
|
|
||
| private readonly ExecutionContext? executionContext; | ||
| private readonly IInvocationResult innerResult; | ||
|
|
||
| public ExecutionContextRestoringInvocationResult(ExecutionContext? executionContext, IInvocationResult innerResult) | ||
| { | ||
| this.executionContext = executionContext; | ||
| this.innerResult = innerResult; | ||
| } | ||
|
|
||
| public void Apply(InvocationContext context) | ||
| { | ||
| if (executionContext is null) | ||
| innerResult.Apply(context); | ||
| else | ||
| ExecutionContext.Run(executionContext, | ||
| executionContextApplyCallback, | ||
| (innerResult, context) | ||
| ); | ||
| } | ||
| } | ||
| } |
14 changes: 14 additions & 0 deletions
14
samples/LocalizationPlayground/LocalizationPlayground.csproj
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,14 @@ | ||
| <Project Sdk="Microsoft.NET.Sdk"> | ||
|
|
||
| <PropertyGroup> | ||
| <Nullable>enable</Nullable> | ||
| <OutputType>Exe</OutputType> | ||
| <TargetFramework>netcoreapp3.1</TargetFramework> | ||
| </PropertyGroup> | ||
|
|
||
| <ItemGroup> | ||
| <ProjectReference Include="..\..\src\System.CommandLine\System.CommandLine.csproj" /> | ||
| <ProjectReference Include="..\..\src\System.CommandLine.Localization\System.CommandLine.Localization.csproj" /> | ||
| </ItemGroup> | ||
|
|
||
| </Project> |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,74 @@ | ||
| using System; | ||
| using System.CommandLine; | ||
| using System.CommandLine.Builder; | ||
| using System.CommandLine.Invocation; | ||
| using System.CommandLine.Localization; | ||
| using System.CommandLine.Parsing; | ||
| using System.Globalization; | ||
| using System.Threading.Tasks; | ||
| using Microsoft.Extensions.Localization; | ||
|
|
||
| namespace LocalizationPlayground | ||
| { | ||
| public static class Program | ||
| { | ||
| public static Task<int> Main(string[] args) | ||
| { | ||
| CultureInfo.CurrentCulture = CultureInfo.InvariantCulture; | ||
| var parser = new CommandLineBuilder( | ||
| new RootCommand | ||
| { | ||
| Description = "Playground for localized CommandLine", | ||
| Handler = CommandHandler.Create((int count, string name, InvocationContext invocation, IStringLocalizerFactory localizerFactory) => | ||
| { | ||
| var cult = CultureInfo.CurrentUICulture; | ||
| var germanResourceNames = typeof(Program).Assembly | ||
| .GetSatelliteAssembly(CultureInfo.GetCultureInfo("de")) | ||
| .GetManifestResourceNames(); | ||
|
|
||
| var localizer = localizerFactory.Create(typeof(Program)); | ||
| var locCultureInfo = localizer.GetString("Current culture: {0}", cult.NativeName); | ||
| Console.WriteLine(locCultureInfo); | ||
| var locLine = localizer.GetString("Hello {0}!", name); | ||
|
|
||
| var availableStrings = localizer.GetAllStrings(true); | ||
|
|
||
| _ = germanResourceNames; | ||
| _ = availableStrings; | ||
|
|
||
| for (int i = 0; i < count; i++) | ||
| { | ||
| Console.WriteLine(locLine); | ||
| } | ||
|
|
||
| Console.WriteLine(); | ||
| invocation.InvocationResult = new HelpResult(); | ||
| }), | ||
| }) | ||
| .AddOption(new Option<int>(new[] { "--count", "-c" }, () => 1) | ||
| { | ||
| Name = "count", | ||
| Description = "Count of lines to print", | ||
| Argument = | ||
| { | ||
| Name = "COUNT", | ||
| Description = "An integer value", | ||
| Arity = ArgumentArity.ZeroOrOne, | ||
| } | ||
| }) | ||
| .AddArgument(new Argument<string>("NAME") | ||
| { | ||
| Description = "The name to display", | ||
| Arity = ArgumentArity.ExactlyOne, | ||
| }) | ||
| .UseEnvironmentVariableDirective() | ||
| .UseDebugDirective() | ||
| .UseHelp() | ||
| .UseVersionOption() | ||
| .UseCultureEnvironment() | ||
| .UseLocalization() | ||
| .Build(); | ||
| return parser.InvokeAsync(args ?? Array.Empty<string>()); | ||
| } | ||
| } | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,138 @@ | ||
| <?xml version="1.0" encoding="utf-8"?> | ||
| <root> | ||
| <!-- | ||
| Microsoft ResX Schema | ||
|
|
||
| Version 2.0 | ||
|
|
||
| The primary goals of this format is to allow a simple XML format | ||
| that is mostly human readable. The generation and parsing of the | ||
| various data types are done through the TypeConverter classes | ||
| associated with the data types. | ||
|
|
||
| Example: | ||
|
|
||
| ... ado.net/XML headers & schema ... | ||
| <resheader name="resmimetype">text/microsoft-resx</resheader> | ||
| <resheader name="version">2.0</resheader> | ||
| <resheader name="reader">System.Resources.ResXResourceReader, System.Windows.Forms, ...</resheader> | ||
| <resheader name="writer">System.Resources.ResXResourceWriter, System.Windows.Forms, ...</resheader> | ||
| <data name="Name1"><value>this is my long string</value><comment>this is a comment</comment></data> | ||
| <data name="Color1" type="System.Drawing.Color, System.Drawing">Blue</data> | ||
| <data name="Bitmap1" mimetype="application/x-microsoft.net.object.binary.base64"> | ||
| <value>[base64 mime encoded serialized .NET Framework object]</value> | ||
| </data> | ||
| <data name="Icon1" type="System.Drawing.Icon, System.Drawing" mimetype="application/x-microsoft.net.object.bytearray.base64"> | ||
| <value>[base64 mime encoded string representing a byte array form of the .NET Framework object]</value> | ||
| <comment>This is a comment</comment> | ||
| </data> | ||
|
|
||
| There are any number of "resheader" rows that contain simple | ||
| name/value pairs. | ||
|
|
||
| Each data row contains a name, and value. The row also contains a | ||
| type or mimetype. Type corresponds to a .NET class that support | ||
| text/value conversion through the TypeConverter architecture. | ||
| Classes that don't support this are serialized and stored with the | ||
| mimetype set. | ||
|
|
||
| The mimetype is used for serialized objects, and tells the | ||
| ResXResourceReader how to depersist the object. This is currently not | ||
| extensible. For a given mimetype the value must be set accordingly: | ||
|
|
||
| Note - application/x-microsoft.net.object.binary.base64 is the format | ||
| that the ResXResourceWriter will generate, however the reader can | ||
| read any of the formats listed below. | ||
|
|
||
| mimetype: application/x-microsoft.net.object.binary.base64 | ||
| value : The object must be serialized with | ||
| : System.Runtime.Serialization.Formatters.Binary.BinaryFormatter | ||
| : and then encoded with base64 encoding. | ||
|
|
||
| mimetype: application/x-microsoft.net.object.soap.base64 | ||
| value : The object must be serialized with | ||
| : System.Runtime.Serialization.Formatters.Soap.SoapFormatter | ||
| : and then encoded with base64 encoding. | ||
|
|
||
| mimetype: application/x-microsoft.net.object.bytearray.base64 | ||
| value : The object must be serialized into a byte array | ||
| : using a System.ComponentModel.TypeConverter | ||
| : and then encoded with base64 encoding. | ||
| --> | ||
| <xsd:schema id="root" xmlns="" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:msdata="urn:schemas-microsoft-com:xml-msdata"> | ||
| <xsd:import namespace="http://www.w3.org/XML/1998/namespace" /> | ||
| <xsd:element name="root" msdata:IsDataSet="true"> | ||
| <xsd:complexType> | ||
| <xsd:choice maxOccurs="unbounded"> | ||
| <xsd:element name="metadata"> | ||
| <xsd:complexType> | ||
| <xsd:sequence> | ||
| <xsd:element name="value" type="xsd:string" minOccurs="0" /> | ||
| </xsd:sequence> | ||
| <xsd:attribute name="name" use="required" type="xsd:string" /> | ||
| <xsd:attribute name="type" type="xsd:string" /> | ||
| <xsd:attribute name="mimetype" type="xsd:string" /> | ||
| <xsd:attribute ref="xml:space" /> | ||
| </xsd:complexType> | ||
| </xsd:element> | ||
| <xsd:element name="assembly"> | ||
| <xsd:complexType> | ||
| <xsd:attribute name="alias" type="xsd:string" /> | ||
| <xsd:attribute name="name" type="xsd:string" /> | ||
| </xsd:complexType> | ||
| </xsd:element> | ||
| <xsd:element name="data"> | ||
| <xsd:complexType> | ||
| <xsd:sequence> | ||
| <xsd:element name="value" type="xsd:string" minOccurs="0" msdata:Ordinal="1" /> | ||
| <xsd:element name="comment" type="xsd:string" minOccurs="0" msdata:Ordinal="2" /> | ||
| </xsd:sequence> | ||
| <xsd:attribute name="name" type="xsd:string" use="required" msdata:Ordinal="1" /> | ||
| <xsd:attribute name="type" type="xsd:string" msdata:Ordinal="3" /> | ||
| <xsd:attribute name="mimetype" type="xsd:string" msdata:Ordinal="4" /> | ||
| <xsd:attribute ref="xml:space" /> | ||
| </xsd:complexType> | ||
| </xsd:element> | ||
| <xsd:element name="resheader"> | ||
| <xsd:complexType> | ||
| <xsd:sequence> | ||
| <xsd:element name="value" type="xsd:string" minOccurs="0" msdata:Ordinal="1" /> | ||
| </xsd:sequence> | ||
| <xsd:attribute name="name" type="xsd:string" use="required" /> | ||
| </xsd:complexType> | ||
| </xsd:element> | ||
| </xsd:choice> | ||
| </xsd:complexType> | ||
| </xsd:element> | ||
| </xsd:schema> | ||
| <resheader name="resmimetype"> | ||
| <value>text/microsoft-resx</value> | ||
| </resheader> | ||
| <resheader name="version"> | ||
| <value>2.0</value> | ||
| </resheader> | ||
| <resheader name="reader"> | ||
| <value>System.Resources.ResXResourceReader, System.Windows.Forms, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089</value> | ||
| </resheader> | ||
| <resheader name="writer"> | ||
| <value>System.Resources.ResXResourceWriter, System.Windows.Forms, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089</value> | ||
| </resheader> | ||
| <data name="An integer value" xml:space="preserve"> | ||
| <value>An integer value</value> | ||
| </data> | ||
| <data name="Count of lines to print" xml:space="preserve"> | ||
| <value>Count of lines to print</value> | ||
| </data> | ||
| <data name="Current culture: {0}" xml:space="preserve"> | ||
| <value>Current language settings: {0}</value> | ||
| </data> | ||
| <data name="Hello {0}!" xml:space="preserve"> | ||
| <value>Hello {0}!</value> | ||
| </data> | ||
| <data name="Playground for localized CommandLine" xml:space="preserve"> | ||
| <value>Playground for localized command-line applications</value> | ||
| </data> | ||
| <data name="The name to display" xml:space="preserve"> | ||
| <value>The name to display</value> | ||
| </data> | ||
| </root> |
8 changes: 8 additions & 0 deletions
8
samples/LocalizationPlayground/Properties/launchSettings.json
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,8 @@ | ||
| { | ||
| "profiles": { | ||
| "LocalizationPlayground": { | ||
| "commandName": "Project", | ||
| "commandLineArgs": "[env:DOTNET_SYSTEM_GLOBALIZATION_CULTURE=de-DE] -c 3 .NET" | ||
| } | ||
| } | ||
| } | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This env should not be needed
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There should be a .net core leveled env to do the same thing
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@wli3 We were hoping to align to whatever environment variables exist already in the SDK but the only one I could find was for specifying the invariant culture, not for specifying other cultures. https://docs.microsoft.com/en-us/dotnet/core/run-time-config/globalization
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
my memory is wrong. https://github.com/dotnet/sdk/blob/b1223209644d900702287faea8e9b71f95ec49f8/src/Cli/dotnet/UILanguageOverride.cs#L38
we had a CLI specific flag. If we need a flag for this library that's fine.