Feature: Plural and singular translation without complex implementation

[XTorLukas]

What feature or improvement do you think would benefit Files?

I've got an idea to enhance the efficiency of implementing translation for both plural and singular words in Files.

• Personally, I've developed and utilize my own straightforward extension adhering to the i18n standard, compatible with crowdin. This eliminates the need for duplicate keys, streamlining the writing process.
• I personally employ RESX with ResourceManager, and adapting its usage here would entail minor modifications.
• Additionally, all spell checks operate through a RegEx pattern, fine-tuned to disregard most whitespace.
  There's also the option to incorporate prefixes and postfixes.
• Nevertheless, experimentation should provide a good understanding of its functionality.

Sample of examples

Examples of display and use in crowdin

Test RegExr online work

Crowdin ICU message implementation (doc)

[XTorLukas]

Sample of personal use

StringExtensions.cs

// Copyright (c) 2024 Laštůvka Lukáš
// Licensed under the Apache-2.0 license. See the LICENSE.


using System.Text.RegularExpressions;

namespace ProjectName.Extensions;

public static partial class StringExtensions
{
    // Default resource manager
    private static readonly ResourceManager _resourceManager = new("ProjectName.Strings.Resources", typeof(Program).Assembly);

    // Default pattern for plural strings
    private const string _regexPattern = @"\{\s*(?'index'\d+)\s*,\s*plural\s*,\s*=\s*(?'num'\d+)\s*\{\s*(?'std'[^{]+)\s*\}\s*(?:(one|few|many|other)\s*\{\s*([^{}]+)\s*\})?\s*(?:(one|few|many|other)\s*\{\s*([^{}]+)\s*\})?\s*(?:(one|few|many|other)\s*\{\s*([^{}]+)\s*\})?\s*(?:(one|few|many|other)\s*\{\s*([^{}]+)\s*\})?\s*\}";

    // Default string to replace with amount
    private const string _replaceString = "#";

    // Default regex object for pattern
    [GeneratedRegex(_regexPattern, RegexOptions.IgnoreCase | RegexOptions.IgnorePatternWhitespace)]
    private static partial Regex ResourceRegex();
    private static readonly Regex _regex = ResourceRegex();

    /// <summary>
    /// Tests if a resource with the specified key exists in the resource manager with the specified culture.
    /// </summary>
    /// <param name="resKey">The key of the resource to look for.</param>
    /// <param name="culture">The culture to use when looking for the resource.</param>
    /// <param name="value">The value of the resource, if it exists.</param>
    /// <returns>True if the resource exists, false otherwise.</returns>
    private static bool ExistsLocalizedResource(this string resKey, CultureInfo culture, out string value)
    {
        try
        {
            var keyValue = _resourceManager.GetResourceSet(culture, true, true)?.GetString(resKey);
            if (keyValue != null)
            {
                value = keyValue;
                return true;
            }
        }
        catch { }
        value = string.Empty;
        return false;
    }

    /// <summary>
    /// Gets the plural category for the specified number.
    /// </summary>
    /// <param name="amount">The number for which to get the plural category.</param>
    /// <returns>The plural category for the specified number.</returns>
    private static string GetPluralCategory(int amount)
    {
        if (amount == 1)
        {
            return "one";
        }
        else if (amount % 10 >= 2 && amount % 10 <= 4 && (amount % 100 < 10 || amount % 100 >= 20))
        {
            return "few";
        }
        else if ((amount % 10 == 0 || (amount % 10 >= 5 && amount % 10 <= 9) || (amount % 100 >= 11 && amount % 100 <= 19)))
        {
            return "many";
        }
        else
        {
            return "other";
        }
    }

    /// <summary>
    /// Tests if a resource with the specified key exists in the resource manager with the current UI culture.
    /// </summary>
    /// <param name="resKey">The key of the resource to look for.</param>
    /// <returns>True if the resource exists, false otherwise.</returns>
    public static bool ExistsLocalizedResource(this string resKey) => ExistsLocalizedResource(resKey, CultureInfo.CurrentUICulture, out var _);

    /// <summary>
    /// Gets the localized string for the specified resource key from the resource manager with the specified culture.
    /// </summary>
    /// <param name="resKey">The key of the resource to look for.</param>
    /// <param name="culture">The culture to use when looking for the resource.</param>
    /// <returns>The localized string for the resource, or the resource key if the resource could not be found.</returns>
    public static string GetLocalizedResource(this string resKey, CultureInfo culture) => ExistsLocalizedResource(resKey, culture, out string value) ? value : resKey;

    /// <summary>
    /// Gets the localized string for the specified resource key from the resource manager with the current UI culture.
    /// </summary>
    /// <param name="resKey">The key of the resource to look for.</param>
    /// <returns>The localized string for the resource, or the resource key if the resource could not be found.</returns>
    public static string GetLocalizedResource(this string resKey) => GetLocalizedResource(resKey, CultureInfo.CurrentUICulture);

    /// <summary>
    /// Gets the plural localized resource for the specified resource key and culture, using the specified amounts.
    /// </summary>
    /// <param name="resKey">The key of the resource to look for.</param>
    /// <param name="culture">The culture to use when looking for the resource.</param>
    /// <param name="amounts">The amounts to use for pluralization.</param>
    /// <returns>The pluralized localized resource for the specified key and culture.</returns>
    public static string GetPluralLocalizedResource(this string resKey, CultureInfo culture, params int[] amounts)
    {
        var res = GetLocalizedResource(resKey, culture);
        var matches = _regex.Matches(res);

        if (matches.Count == 0)
        {
            return res;
        }

        foreach (var match in matches.Cast<Match>())
        {
            var index = int.Parse(match.Groups["index"].Value);
            var num = int.Parse(match.Groups["num"].Value);
            

            if (amounts[index] == num)
            {
                var std = match.Groups["std"].Value;
                res = res.ReplaceFirst(match.Groups[0].Value, std.ReplaceFirst(_replaceString, amounts[index].ToString()));
                continue;
            }

            for (int i = 1; i < match.Groups.Count; i += 2)
            {
                var groupName = match.Groups[i].Value;
                var groupText = match.Groups[i + 1].Value;

                if (groupName == GetPluralCategory(amounts[index]) || groupName == "other")
                {
                    res = res.ReplaceFirst(match.Groups[0].Value, groupText.ReplaceFirst(_replaceString, amounts[index].ToString()).TrimEnd());
                    break;
                }
            }
        }

        return res;
    }

    /// <summary>
    /// Gets the plural localized resource for the specified resource key and culture, using the specified amounts with the current UI culture.
    /// </summary>
    /// <param name="resKey">The key of the resource to look for.</param>
    /// <param name="amounts">The amounts to use for pluralization.</param>
    /// <returns>The pluralized localized resource for the specified key and culture.</returns>
    public static string GetPluralLocalizedResource(this string resKey, params int[] amounts) => GetPluralLocalizedResource(resKey, CultureInfo.CurrentUICulture, amounts);

    /// <summary>
    /// Replaces the first occurrence of a specified string with another specified string in a given string.
    /// </summary>
    /// <param name="str">The given string.</param>
    /// <param name="oldValue">The string to be replaced.</param>
    /// <param name="newValue">The new string to replace the old string.</param>
    /// <returns>A string that is identical to the given string except that the first occurrence of oldValue is replaced with newValue.</returns>
    public static string ReplaceFirst(this string str, string oldValue, string newValue)
    {
        int position = str.IndexOf(oldValue);
        if (position < 0)
        {
            return str;
        }
        str = string.Concat(str.AsSpan(0, position), newValue, str.AsSpan(position + oldValue.Length));
        return str;
    }
}

Example using in code

// Copyright (c) 2024 Laštůvka Lukáš
// Licensed under the Apache-2.0 license. See the LICENSE.

// Test New Version

CultureInfo.CurrentUICulture = new("en-US");

string[] testStrings = ["CreateShortcutDescription", "UnpinFolderFromSidebarDescription"];

foreach (string testString in testStrings)
{
    Console.WriteLine($"KEY: {testString}");
    Console.WriteLine($"Source: \"{testString.GetLocalizedResource()}\"");
    Console.WriteLine($"\nResult:\n");

    for (int i = 1; i <= 10; i++)
    {
        Console.WriteLine($"NUM:{i}\t->\t{testString.GetPluralLocalizedResource(i)}");
    }
    Console.WriteLine();
}

string[] testStrings2 = ["ConflictingItemsDialogSubtitleMultipleConflictsMultipleNonConflicts", "CopyItemsDialogSubtitleMultiple"];

foreach (string testString in testStrings2)
{
    Console.WriteLine($"KEY: {testString}");
    Console.WriteLine($"Source: \"{testString.GetLocalizedResource()}\"");
    Console.WriteLine($"\nResult:\n");

    for (int i = 0; i <= 10; i++)
    {
        Console.WriteLine($"NUM:{i}\t->\t{testString.GetPluralLocalizedResource(i,0)}");
    }
    Console.WriteLine();
}

Console.ReadKey();

[XTorLukas]

Testing on real data

• For compatibility reasons, I created a new version that handles multivalued text better.

• I have made a demonstration of the possibilities and implementation

• Test New Version RegExr online work

• Test New Version regex101 online work

Samples

Sample A

KEY: CreateShortcutDescription
Source: "Create new {0, plural, =1 {shortcut} other {shortcuts}} to selected {0, plural, =1 {item} other {items}}"

Result:

NUM:1   ->      Create new shortcut to selected item
NUM:2   ->      Create new shortcuts to selected items
NUM:3   ->      Create new shortcuts to selected items
NUM:4   ->      Create new shortcuts to selected items
NUM:5   ->      Create new shortcuts to selected items
NUM:6   ->      Create new shortcuts to selected items
NUM:7   ->      Create new shortcuts to selected items
NUM:8   ->      Create new shortcuts to selected items
NUM:9   ->      Create new shortcuts to selected items
NUM:10  ->      Create new shortcuts to selected items

Sample B

KEY: UnpinFolderFromSidebarDescription
Source: "Unpin {0, plural, =1 {folder} other {folders}} from Sidebar"

Result:

NUM:1   ->      Unpin folder from Sidebar
NUM:2   ->      Unpin folders from Sidebar
NUM:3   ->      Unpin folders from Sidebar
NUM:4   ->      Unpin folders from Sidebar
NUM:5   ->      Unpin folders from Sidebar
NUM:6   ->      Unpin folders from Sidebar
NUM:7   ->      Unpin folders from Sidebar
NUM:8   ->      Unpin folders from Sidebar
NUM:9   ->      Unpin folders from Sidebar
NUM:10  ->      Unpin folders from Sidebar

Sample C

KEY: ConflictingItemsDialogSubtitleMultipleConflictsMultipleNonConflicts
Source: "There are {0, plural, =0 {no conflicting file names} one {# conflicting file name} other {# conflicting file names}}, and {1, plural, =0 {zero outgoing items} one {# outgoing item} other {# outgoing items}}."

Result:

NUM:0   ->      There are no conflicting file names, and zero outgoing items.
NUM:1   ->      There are 1 conflicting file name, and zero outgoing items.
NUM:2   ->      There are 2 conflicting file names, and zero outgoing items.
NUM:3   ->      There are 3 conflicting file names, and zero outgoing items.
NUM:4   ->      There are 4 conflicting file names, and zero outgoing items.
NUM:5   ->      There are 5 conflicting file names, and zero outgoing items.
NUM:6   ->      There are 6 conflicting file names, and zero outgoing items.
NUM:7   ->      There are 7 conflicting file names, and zero outgoing items.
NUM:8   ->      There are 8 conflicting file names, and zero outgoing items.
NUM:9   ->      There are 9 conflicting file names, and zero outgoing items.
NUM:10  ->      There are 10 conflicting file names, and zero outgoing items.

Sample D

KEY: CopyItemsDialogSubtitleMultiple
Source: "{0, plural, =1 {# item} other {# items}} will be copied"

Result:

NUM:0   ->      0 items will be copied
NUM:1   ->      1 item will be copied
NUM:2   ->      2 items will be copied
NUM:3   ->      3 items will be copied
NUM:4   ->      4 items will be copied
NUM:5   ->      5 items will be copied
NUM:6   ->      6 items will be copied
NUM:7   ->      7 items will be copied
NUM:8   ->      8 items will be copied
NUM:9   ->      9 items will be copied
NUM:10  ->      10 items will be copied

[yaira2]

@Jay-o-Way do you have any input?

[Jay-o-Way]

Hm, looks sweet! But not really my expertise... Would be nice as a nuget package? 😉
One detail: I see it doesn't work for the "is/are" words.

There are 1 conflicting file name

[XTorLukas]

is/are can also:

KEY: FilesReady
Source: "{0, plural, =1 {# file} other {# files}} {0, plural, =1 {is} other {are}} ready"

Result:

NUM:0   ->      0 files are ready
NUM:1   ->      1 file is ready
NUM:2   ->      2 files are ready
NUM:3   ->      3 files are ready
NUM:4   ->      4 files are ready
NUM:5   ->      5 files are ready
NUM:6   ->      6 files are ready
NUM:7   ->      7 files are ready
NUM:8   ->      8 files are ready
NUM:9   ->      9 files are ready
NUM:10  ->      10 files are ready

Test regex101 online work

[XTorLukas]

MessageFormat

• I tried the existing nuget package "MessageFormat"
• Public repo MessageFormatter for .NET

Install NuGet

Install-Package MessageFormat

Demo code

// Copyright (c) 2024 Laštůvka Lukáš
// Licensed under the Apache-2.0 license. See the LICENSE.

// Test With MessageFormat

using Jeffijoe.MessageFormat;

CultureInfo.CurrentUICulture = new("en-US");
var mf = new MessageFormatter(useCache: true, locale: CultureInfo.CurrentUICulture.Name);

string[] testStrings = ["CreateShortcutDescription", "UnpinFolderFromSidebarDescription"];

foreach (string testString in testStrings)
{
    Console.WriteLine($"KEY: {testString}");
    Console.WriteLine($"Source: \"{testString.GetLocalizedResource()}\"");
    Console.WriteLine($"\nResult:\n");

    for (int i = 1; i <= 10; i++)
    {
        Console.WriteLine($"NUM:{i}\t->\t{mf.FormatMessage(testString.GetLocalizedResource(), new Dictionary<string, object?> { { "0", i } })}");
    }
    Console.WriteLine();
}

string[] testStrings2 = ["ConflictingItemsDialogSubtitleMultipleConflictsMultipleNonConflicts", "CopyItemsDialogSubtitleMultiple", "FilesReady"];

foreach (string testString in testStrings2)
{
    Console.WriteLine($"KEY: {testString}");
    Console.WriteLine($"Source: \"{testString.GetLocalizedResource()}\"");
    Console.WriteLine($"\nResult:\n");

    for (int i = 0; i <= 10; i++)
    {
        Console.WriteLine($"NUM:{i}\t->\t{mf.FormatMessage(testString.GetLocalizedResource(), new Dictionary<string, object?> { { "0", i },{ "1", 0} })}");
    }
    Console.WriteLine();
}

Console.ReadKey();

Results

KEY: CreateShortcutDescription
Source: "Create new {0, plural, =1 {shortcut} other {shortcuts}} to selected {0, plural, =1 {item} other {items}}"

Result:

NUM:1   ->      Create new shortcut to selected item
NUM:2   ->      Create new shortcuts to selected items
NUM:3   ->      Create new shortcuts to selected items
NUM:4   ->      Create new shortcuts to selected items
NUM:5   ->      Create new shortcuts to selected items
NUM:6   ->      Create new shortcuts to selected items
NUM:7   ->      Create new shortcuts to selected items
NUM:8   ->      Create new shortcuts to selected items
NUM:9   ->      Create new shortcuts to selected items
NUM:10  ->      Create new shortcuts to selected items

KEY: UnpinFolderFromSidebarDescription
Source: "Unpin {0, plural, =1 {folder} other {folders}} from Sidebar"

Result:

NUM:1   ->      Unpin folder from Sidebar
NUM:2   ->      Unpin folders from Sidebar
NUM:3   ->      Unpin folders from Sidebar
NUM:4   ->      Unpin folders from Sidebar
NUM:5   ->      Unpin folders from Sidebar
NUM:6   ->      Unpin folders from Sidebar
NUM:7   ->      Unpin folders from Sidebar
NUM:8   ->      Unpin folders from Sidebar
NUM:9   ->      Unpin folders from Sidebar
NUM:10  ->      Unpin folders from Sidebar

KEY: ConflictingItemsDialogSubtitleMultipleConflictsMultipleNonConflicts
Source: "There are {0, plural, =0 {no conflicting file names} one {# conflicting file name} other {# conflicting file names}}, and {1, plural, =0 {zero outgoing items} one {# outgoing item} other {# outgoing items}}."

Result:

NUM:0   ->      There are no conflicting file names, and zero outgoing items.
NUM:1   ->      There are 1 conflicting file name, and zero outgoing items.
NUM:2   ->      There are 2 conflicting file names, and zero outgoing items.
NUM:3   ->      There are 3 conflicting file names, and zero outgoing items.
NUM:4   ->      There are 4 conflicting file names, and zero outgoing items.
NUM:5   ->      There are 5 conflicting file names, and zero outgoing items.
NUM:6   ->      There are 6 conflicting file names, and zero outgoing items.
NUM:7   ->      There are 7 conflicting file names, and zero outgoing items.
NUM:8   ->      There are 8 conflicting file names, and zero outgoing items.
NUM:9   ->      There are 9 conflicting file names, and zero outgoing items.
NUM:10  ->      There are 10 conflicting file names, and zero outgoing items.

KEY: CopyItemsDialogSubtitleMultiple
Source: "{0, plural, =1 {# item} other {# items}} will be copied"

Result:

NUM:0   ->      0 items will be copied
NUM:1   ->      1 item will be copied
NUM:2   ->      2 items will be copied
NUM:3   ->      3 items will be copied
NUM:4   ->      4 items will be copied
NUM:5   ->      5 items will be copied
NUM:6   ->      6 items will be copied
NUM:7   ->      7 items will be copied
NUM:8   ->      8 items will be copied
NUM:9   ->      9 items will be copied
NUM:10  ->      10 items will be copied

KEY: FilesReady
Source: "{0, plural, one {# file} other {# files}} {0, plural, =1 {is} other {are}} ready"

Result:

NUM:0   ->      0 files are ready
NUM:1   ->      1 file is ready
NUM:2   ->      2 files are ready
NUM:3   ->      3 files are ready
NUM:4   ->      4 files are ready
NUM:5   ->      5 files are ready
NUM:6   ->      6 files are ready
NUM:7   ->      7 files are ready
NUM:8   ->      8 files are ready
NUM:9   ->      9 files are ready
NUM:10  ->      10 files are ready

[0x5bfa]

This has low priority comparing to other urgent issues but definitely worth trying and if someone gonna make a PR for this we are happy to help.

[XTorLukas]

This has low priority comparing to other urgent issues but definitely worth trying and if someone gonna make a PR for this we are happy to help.

Personally, I try to find a compromise between speed, compatibility and simplicity. Personally, I am creating my own new project and trying to implement this feature.
In addition, I try to contribute to extensions in community projects.
Thus, in my personal development, I only share the main points of progress so that a working prototype already exists when It start development.

[yaira2]

The main question about this implementation is if it will cause confusion. This is something we need translators to provide input on as they are the ones putting the time and effort into localizing Files.

[yaira2]

We can also start with a couple strings as a test and see how it goes.

[yaira2]

@XTorLukas do you want to open a PR using this method for a couple strings so we can get a feel for it?