You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
[Xamarin.Android.Build.Tasks] Move XA4214 warning text into .resx file (#3900)
Context: https://dev.azure.com/devdiv/DevDiv/_workitems/edit/1009374/
This is a first step toward localizing the MSBuild error and warning
messages produced by `Xamarin.Android.Build.Tasks.dll`.
We will be following the [.NET Resource Localization pattern][0] and
generating satellite assemblies using [`.resx` files][1], in particular
`src/Xamarin.Android.Build.Tasks/Properties/Resources.resx`.
`Resources.resx` is an XML file, and will contain `/root/data`
elements in which `//data/@name` will start with the Xamarin.Android
error or warning code, and `//data/value` will be the error or
warning message:
<root>
<data name="XA4214" xml:space="preserve">
<value>The managed type `{0}` exists in multiple assemblies: {1}. Please refactor the managed type names in these assemblies so that they are not identical.</value>
</data>
</root>
An optional `//data/comment` element may be provided to describe the
meaning within the `//data/value` element to translators:
<data name="XA4214" xml:space="preserve">
<value>The managed type `{0}` exists in multiple assemblies: {1}. Please refactor the managed type names in these assemblies so that they are not identical.</value>
<comment>
{0} - The managed type name
{1} - Comma-separated list of all the assemblies where the managed type exists
</comment>
</data>
During the build, `Resources.resx` will be translated into a
`Resources.Designer.cs` file:
namespace Xamarin.Android.Tasks.Properties {
internal partial class Resources {
internal static string XA4214 {
get => ...
}
}
}
The `Resources` members should be used to obtain all strings for use
in `LogCodedError()` and `LogCodedWarning()` calls:
Log.LogCodedWarning ("XA4214", Properties.Resources.XA4214, kvp.Key, string.Join (", ", kvp.Value));
When an MSBuild error or warning code is used with more than one
output string, then a semantically meaningful suffix should be used
to distinguish between the two:
<data name="XA4214_Result" xml:space="preserve">
<value>References to the type `{0}` will refer to `{0}, {1}`.</value>
</data>
Note that this infrastructure does not interoperate with C#6 string
interpolation. Any error or warning messages currently using C#6
string interpolation will need to use .NET 1.0-style format strings.
Our translation team doesn't work directly with `.resx` files.
Instead, the translation team works with [XLIFF files][2].
`Resources.resx` is converted into a set of
`src/Xamarin.Android.Build.Tasks/Properties/xlf/Resources.*.xlf`
files via `XliffTasks.targets` from the [dotnet/xliff-tasks][3] repo.
The `Resources.*.xlf` files should be automatically updated whenever
`Resources.resx` is updated.
Other:
* This approach leaves the error code `XA4214` as a string literal
for now. This differs from what dotnet/sdk and microsoft/msbuild
do; they instead include the message code as part of the string
resource in the `.resx` file. That might sometimes provide useful
additional context for the translation team, but it also requires
using a different set of logging methods from
`Microsoft.Build.Utilities.TaskLoggingHelper`.
* Fix the Test MSBuild Azure Pipelines build
Specify the `feedsToUse` and `nugetConfigPath` inputs for the
[`NuGetCommand@2`][6] Azure Pipelines task so that the NuGet
restore step will be able to restore XliffTasks successfully from
the dotnet-eng Azure DevOps NuGet package feed.
This resolves the following error:
The nuget command failed with exit code(1) and error(Errors in packages.config projects
Unable to find version '1.0.0-beta.19252.1' of package 'XliffTasks'.
C:\Users\dlab14\.nuget\packages\: Package 'XliffTasks.1.0.0-beta.19252.1' is not found on source 'C:\Users\dlab14\.nuget\packages\'.
https://api.nuget.org/v3/index.json: Package 'XliffTasks.1.0.0-beta.19252.1' is not found on source 'https://api.nuget.org/v3/index.json'.)
TODO:
* When `Xamarin.Android.Build.Tasks.csproj` is converted into a
[short-form project][4], add a dependency on dotnet/arcade and
switch to using the [`GenerateResxSource` mechanism][5] instead
of using `%(EmbeddedResource.Generator)`=ResXFileCodeGenerator
and set `$(UsingToolXliff)`=True. This would match dotnet/sdk.
[0]: https://docs.microsoft.com/dotnet/framework/resources/index
[1]: https://docs.microsoft.com/dotnet/framework/resources/creating-resource-files-for-desktop-apps#resources-in-resx-files
[2]: http://docs.oasis-open.org/xliff/v1.2/os/xliff-core.html
[3]: https://github.com/dotnet/xliff-tasks
[4]: https://docs.microsoft.com/visualstudio/msbuild/how-to-use-project-sdk
[5]: https://github.com/dotnet/arcade/blob/e67d9f098029ebecedf11012a749b532d68ad2a9/Documentation/ArcadeSdk.md#generateresxsource-bool
[6]: https://docs.microsoft.com/azure/devops/pipelines/tasks/package/nuget
<value>The managed type `{0}` exists in multiple assemblies: {1}. Please refactor the managed type names in these assemblies so that they are not identical.</value>
122
+
<comment>{0} - The managed type name
123
+
{1} - Comma-separated list of all the assemblies where the managed type exists</comment>
124
+
</data>
125
+
<dataname="XA4214_Result"xml:space="preserve">
126
+
<value>References to the type `{0}` will refer to `{0}, {1}`.</value>
127
+
<comment>The phrase "`{0}, {1}`" does not need to be translated.
128
+
{0} - The managed type name
129
+
{1} - The the name of the library that contains the type</comment>
<source>The managed type `{0}` exists in multiple assemblies: {1}. Please refactor the managed type names in these assemblies so that they are not identical.</source>
7
+
<targetstate="new">The managed type `{0}` exists in multiple assemblies: {1}. Please refactor the managed type names in these assemblies so that they are not identical.</target>
8
+
<note>{0} - The managed type name
9
+
{1} - Comma-separated list of all the assemblies where the managed type exists</note>
10
+
</trans-unit>
11
+
<trans-unitid="XA4214_Result">
12
+
<source>References to the type `{0}` will refer to `{0}, {1}`.</source>
13
+
<targetstate="new">References to the type `{0}` will refer to `{0}, {1}`.</target>
14
+
<note>The phrase "`{0}, {1}`" does not need to be translated.
15
+
{0} - The managed type name
16
+
{1} - The the name of the library that contains the type</note>
<source>The managed type `{0}` exists in multiple assemblies: {1}. Please refactor the managed type names in these assemblies so that they are not identical.</source>
7
+
<targetstate="new">The managed type `{0}` exists in multiple assemblies: {1}. Please refactor the managed type names in these assemblies so that they are not identical.</target>
8
+
<note>{0} - The managed type name
9
+
{1} - Comma-separated list of all the assemblies where the managed type exists</note>
10
+
</trans-unit>
11
+
<trans-unitid="XA4214_Result">
12
+
<source>References to the type `{0}` will refer to `{0}, {1}`.</source>
13
+
<targetstate="new">References to the type `{0}` will refer to `{0}, {1}`.</target>
14
+
<note>The phrase "`{0}, {1}`" does not need to be translated.
15
+
{0} - The managed type name
16
+
{1} - The the name of the library that contains the type</note>
<source>The managed type `{0}` exists in multiple assemblies: {1}. Please refactor the managed type names in these assemblies so that they are not identical.</source>
7
+
<targetstate="new">The managed type `{0}` exists in multiple assemblies: {1}. Please refactor the managed type names in these assemblies so that they are not identical.</target>
8
+
<note>{0} - The managed type name
9
+
{1} - Comma-separated list of all the assemblies where the managed type exists</note>
10
+
</trans-unit>
11
+
<trans-unitid="XA4214_Result">
12
+
<source>References to the type `{0}` will refer to `{0}, {1}`.</source>
13
+
<targetstate="new">References to the type `{0}` will refer to `{0}, {1}`.</target>
14
+
<note>The phrase "`{0}, {1}`" does not need to be translated.
15
+
{0} - The managed type name
16
+
{1} - The the name of the library that contains the type</note>
<source>The managed type `{0}` exists in multiple assemblies: {1}. Please refactor the managed type names in these assemblies so that they are not identical.</source>
7
+
<targetstate="new">The managed type `{0}` exists in multiple assemblies: {1}. Please refactor the managed type names in these assemblies so that they are not identical.</target>
8
+
<note>{0} - The managed type name
9
+
{1} - Comma-separated list of all the assemblies where the managed type exists</note>
10
+
</trans-unit>
11
+
<trans-unitid="XA4214_Result">
12
+
<source>References to the type `{0}` will refer to `{0}, {1}`.</source>
13
+
<targetstate="new">References to the type `{0}` will refer to `{0}, {1}`.</target>
14
+
<note>The phrase "`{0}, {1}`" does not need to be translated.
15
+
{0} - The managed type name
16
+
{1} - The the name of the library that contains the type</note>
<source>The managed type `{0}` exists in multiple assemblies: {1}. Please refactor the managed type names in these assemblies so that they are not identical.</source>
7
+
<targetstate="new">The managed type `{0}` exists in multiple assemblies: {1}. Please refactor the managed type names in these assemblies so that they are not identical.</target>
8
+
<note>{0} - The managed type name
9
+
{1} - Comma-separated list of all the assemblies where the managed type exists</note>
10
+
</trans-unit>
11
+
<trans-unitid="XA4214_Result">
12
+
<source>References to the type `{0}` will refer to `{0}, {1}`.</source>
13
+
<targetstate="new">References to the type `{0}` will refer to `{0}, {1}`.</target>
14
+
<note>The phrase "`{0}, {1}`" does not need to be translated.
15
+
{0} - The managed type name
16
+
{1} - The the name of the library that contains the type</note>
<source>The managed type `{0}` exists in multiple assemblies: {1}. Please refactor the managed type names in these assemblies so that they are not identical.</source>
7
+
<targetstate="new">The managed type `{0}` exists in multiple assemblies: {1}. Please refactor the managed type names in these assemblies so that they are not identical.</target>
8
+
<note>{0} - The managed type name
9
+
{1} - Comma-separated list of all the assemblies where the managed type exists</note>
10
+
</trans-unit>
11
+
<trans-unitid="XA4214_Result">
12
+
<source>References to the type `{0}` will refer to `{0}, {1}`.</source>
13
+
<targetstate="new">References to the type `{0}` will refer to `{0}, {1}`.</target>
14
+
<note>The phrase "`{0}, {1}`" does not need to be translated.
15
+
{0} - The managed type name
16
+
{1} - The the name of the library that contains the type</note>
<source>The managed type `{0}` exists in multiple assemblies: {1}. Please refactor the managed type names in these assemblies so that they are not identical.</source>
7
+
<targetstate="new">The managed type `{0}` exists in multiple assemblies: {1}. Please refactor the managed type names in these assemblies so that they are not identical.</target>
8
+
<note>{0} - The managed type name
9
+
{1} - Comma-separated list of all the assemblies where the managed type exists</note>
10
+
</trans-unit>
11
+
<trans-unitid="XA4214_Result">
12
+
<source>References to the type `{0}` will refer to `{0}, {1}`.</source>
13
+
<targetstate="new">References to the type `{0}` will refer to `{0}, {1}`.</target>
14
+
<note>The phrase "`{0}, {1}`" does not need to be translated.
15
+
{0} - The managed type name
16
+
{1} - The the name of the library that contains the type</note>
<source>The managed type `{0}` exists in multiple assemblies: {1}. Please refactor the managed type names in these assemblies so that they are not identical.</source>
7
+
<targetstate="new">The managed type `{0}` exists in multiple assemblies: {1}. Please refactor the managed type names in these assemblies so that they are not identical.</target>
8
+
<note>{0} - The managed type name
9
+
{1} - Comma-separated list of all the assemblies where the managed type exists</note>
10
+
</trans-unit>
11
+
<trans-unitid="XA4214_Result">
12
+
<source>References to the type `{0}` will refer to `{0}, {1}`.</source>
13
+
<targetstate="new">References to the type `{0}` will refer to `{0}, {1}`.</target>
14
+
<note>The phrase "`{0}, {1}`" does not need to be translated.
15
+
{0} - The managed type name
16
+
{1} - The the name of the library that contains the type</note>
<source>The managed type `{0}` exists in multiple assemblies: {1}. Please refactor the managed type names in these assemblies so that they are not identical.</source>
7
+
<targetstate="new">The managed type `{0}` exists in multiple assemblies: {1}. Please refactor the managed type names in these assemblies so that they are not identical.</target>
8
+
<note>{0} - The managed type name
9
+
{1} - Comma-separated list of all the assemblies where the managed type exists</note>
10
+
</trans-unit>
11
+
<trans-unitid="XA4214_Result">
12
+
<source>References to the type `{0}` will refer to `{0}, {1}`.</source>
13
+
<targetstate="new">References to the type `{0}` will refer to `{0}, {1}`.</target>
14
+
<note>The phrase "`{0}, {1}`" does not need to be translated.
15
+
{0} - The managed type name
16
+
{1} - The the name of the library that contains the type</note>
<source>The managed type `{0}` exists in multiple assemblies: {1}. Please refactor the managed type names in these assemblies so that they are not identical.</source>
7
+
<targetstate="new">The managed type `{0}` exists in multiple assemblies: {1}. Please refactor the managed type names in these assemblies so that they are not identical.</target>
8
+
<note>{0} - The managed type name
9
+
{1} - Comma-separated list of all the assemblies where the managed type exists</note>
10
+
</trans-unit>
11
+
<trans-unitid="XA4214_Result">
12
+
<source>References to the type `{0}` will refer to `{0}, {1}`.</source>
13
+
<targetstate="new">References to the type `{0}` will refer to `{0}, {1}`.</target>
14
+
<note>The phrase "`{0}, {1}`" does not need to be translated.
15
+
{0} - The managed type name
16
+
{1} - The the name of the library that contains the type</note>
<source>The managed type `{0}` exists in multiple assemblies: {1}. Please refactor the managed type names in these assemblies so that they are not identical.</source>
7
+
<targetstate="new">The managed type `{0}` exists in multiple assemblies: {1}. Please refactor the managed type names in these assemblies so that they are not identical.</target>
8
+
<note>{0} - The managed type name
9
+
{1} - Comma-separated list of all the assemblies where the managed type exists</note>
10
+
</trans-unit>
11
+
<trans-unitid="XA4214_Result">
12
+
<source>References to the type `{0}` will refer to `{0}, {1}`.</source>
13
+
<targetstate="new">References to the type `{0}` will refer to `{0}, {1}`.</target>
14
+
<note>The phrase "`{0}, {1}`" does not need to be translated.
15
+
{0} - The managed type name
16
+
{1} - The the name of the library that contains the type</note>
<source>The managed type `{0}` exists in multiple assemblies: {1}. Please refactor the managed type names in these assemblies so that they are not identical.</source>
7
+
<targetstate="new">The managed type `{0}` exists in multiple assemblies: {1}. Please refactor the managed type names in these assemblies so that they are not identical.</target>
8
+
<note>{0} - The managed type name
9
+
{1} - Comma-separated list of all the assemblies where the managed type exists</note>
10
+
</trans-unit>
11
+
<trans-unitid="XA4214_Result">
12
+
<source>References to the type `{0}` will refer to `{0}, {1}`.</source>
13
+
<targetstate="new">References to the type `{0}` will refer to `{0}, {1}`.</target>
14
+
<note>The phrase "`{0}, {1}`" does not need to be translated.
15
+
{0} - The managed type name
16
+
{1} - The the name of the library that contains the type</note>
<source>The managed type `{0}` exists in multiple assemblies: {1}. Please refactor the managed type names in these assemblies so that they are not identical.</source>
7
+
<targetstate="new">The managed type `{0}` exists in multiple assemblies: {1}. Please refactor the managed type names in these assemblies so that they are not identical.</target>
8
+
<note>{0} - The managed type name
9
+
{1} - Comma-separated list of all the assemblies where the managed type exists</note>
10
+
</trans-unit>
11
+
<trans-unitid="XA4214_Result">
12
+
<source>References to the type `{0}` will refer to `{0}, {1}`.</source>
13
+
<targetstate="new">References to the type `{0}` will refer to `{0}, {1}`.</target>
14
+
<note>The phrase "`{0}, {1}`" does not need to be translated.
15
+
{0} - The managed type name
16
+
{1} - The the name of the library that contains the type</note>
0 commit comments