Added a setting to sort unity loc tables.

This fixes the issue where a line added into the middle of a yarn file would be at the bottom of the string table.
The downside to this is we do this by sorting the string table so for larger projects this could take a little while to complete.
As such we default this to off but can be changed in the Yarn Spinner settings inside of Unity

Author: McJones

Editor/Editors/YarnSpinnerProjectSettings.cs

@@ -40,6 +40,8 @@ class YarnSpinnerProjectSettings
                 minorVersion = value.minor;
             }
         }
+        public bool sortLocalisationValuesInsideStringTable = false;
+
         private int majorVersion = 0;
         private int minorVersion = 0;
 
@@ -49,6 +51,7 @@ class YarnSpinnerProjectSettings
         private const string enableDirectLinkToVSCodeKey = "enableDirectLinkToVSCode";
         private const string majorVersionKey = "majorVersion";
         private const string minorVersionKey = "minorVersion";
+        private const string sortLocalisationValuesInsideStringTableKey = "sortLocalisationValuesInsideStringTable";
 
         internal static YarnSpinnerProjectSettings GetOrCreateSettings(string? path = null, Yarn.Unity.ILogger? iLogger = null)
         {
@@ -80,6 +83,7 @@ internal static YarnSpinnerProjectSettings GetOrCreateSettings(string? path = nu
             settings.generateYSLSFile = false;
             settings.majorVersion = 0;
             settings.minorVersion = 0;
+            settings.sortLocalisationValuesInsideStringTable = false;
             settings.WriteSettings(path, logger);
 
             return settings;
@@ -119,13 +123,15 @@ T GetValueOrDefault<T>(string key, T defaultValue)
                 bool enableDirectLinkToVSCode = GetValueOrDefault(enableDirectLinkToVSCodeKey, false);
                 int major = GetValueOrDefault(majorVersionKey, 0);
                 int minor = GetValueOrDefault(minorVersionKey, 0);
+                bool sortLocalisationValuesInsideStringTable = GetValueOrDefault(sortLocalisationValuesInsideStringTableKey, false);
 
                 settings.automaticallyLinkAttributedYarnCommandsAndFunctions = automaticallyLinkAttributedYarnCommandsAndFunctions;
                 settings.autoRefreshLocalisedAssets = autoRefreshLocalisedAssets;
                 settings.generateYSLSFile = generateYSLSFile;
                 settings.enableDirectLinkToVSCode = enableDirectLinkToVSCode;
                 settings.majorVersion = major;
                 settings.minorVersion = minor;
+                settings.sortLocalisationValuesInsideStringTable = sortLocalisationValuesInsideStringTable;
             }
             catch (System.Exception ex)
             {

Editor/Editors/YarnSpinnerProjectSettingsProvider.cs

@@ -50,6 +50,7 @@ public override void OnGUI(string searchContext)
                 var linkingAttributedFuncs = unsavedSettings.automaticallyLinkAttributedYarnCommandsAndFunctions;
                 var generateYSLS = unsavedSettings.generateYSLSFile;
                 var enableDirectLinkToVSCode = unsavedSettings.enableDirectLinkToVSCode;
+                var sortLocalisationValuesInsideStringTable = unsavedSettings.sortLocalisationValuesInsideStringTable;
 
                 using (new EditorGUI.IndentLevelScope())
                 {
@@ -67,6 +68,13 @@ public override void OnGUI(string searchContext)
                     EditorGUILayout.LabelField("Generate YSLS file for attributed methods", GUILayout.Width(settingWidth), GUILayout.ExpandWidth(false));
                     generateYSLS = EditorGUILayout.Toggle(unsavedSettings.generateYSLSFile, GUILayout.ExpandWidth(false));
                     EditorGUILayout.EndHorizontal();
+
+#if USE_UNITY_LOCALIZATION
+                    EditorGUILayout.BeginHorizontal();
+                    EditorGUILayout.LabelField("Keep Unity Localization tables sorted", GUILayout.Width(settingWidth), GUILayout.ExpandWidth(false));
+                    sortLocalisationValuesInsideStringTable = EditorGUILayout.Toggle(unsavedSettings.sortLocalisationValuesInsideStringTable, GUILayout.ExpandWidth(false));
+                    EditorGUILayout.EndHorizontal();
+#endif
                 }
 
                 EditorGUILayout.Space();
@@ -85,6 +93,7 @@ public override void OnGUI(string searchContext)
                     unsavedSettings.automaticallyLinkAttributedYarnCommandsAndFunctions = linkingAttributedFuncs;
                     unsavedSettings.generateYSLSFile = generateYSLS;
                     unsavedSettings.enableDirectLinkToVSCode = enableDirectLinkToVSCode;
+                    unsavedSettings.sortLocalisationValuesInsideStringTable = sortLocalisationValuesInsideStringTable;
                 }
 
                 bool disabledReimportButton = true;
@@ -93,7 +102,8 @@ public override void OnGUI(string searchContext)
                     unsavedSettings.automaticallyLinkAttributedYarnCommandsAndFunctions != baseSettings.automaticallyLinkAttributedYarnCommandsAndFunctions ||
                     unsavedSettings.autoRefreshLocalisedAssets != baseSettings.autoRefreshLocalisedAssets ||
                     unsavedSettings.generateYSLSFile != baseSettings.generateYSLSFile ||
-                    unsavedSettings.enableDirectLinkToVSCode != baseSettings.enableDirectLinkToVSCode
+                    unsavedSettings.enableDirectLinkToVSCode != baseSettings.enableDirectLinkToVSCode ||
+                    unsavedSettings.sortLocalisationValuesInsideStringTable != baseSettings.sortLocalisationValuesInsideStringTable
                 )
                 {
                     disabledReimportButton = false;
@@ -123,12 +133,17 @@ public override void OnGUI(string searchContext)
                         {
                             needsCSharpRecompilation = true;
                         }
+                        if (baseSettings.sortLocalisationValuesInsideStringTable != unsavedSettings.sortLocalisationValuesInsideStringTable)
+                        {
+                            needsYarnProjectReimport = true;
+                        }
 
                         // saving the changed settings out to disk
                         baseSettings.autoRefreshLocalisedAssets = unsavedSettings.autoRefreshLocalisedAssets;
                         baseSettings.automaticallyLinkAttributedYarnCommandsAndFunctions = unsavedSettings.automaticallyLinkAttributedYarnCommandsAndFunctions;
                         baseSettings.generateYSLSFile = unsavedSettings.generateYSLSFile;
                         baseSettings.enableDirectLinkToVSCode = unsavedSettings.enableDirectLinkToVSCode;
+                        baseSettings.sortLocalisationValuesInsideStringTable = unsavedSettings.sortLocalisationValuesInsideStringTable;
                         baseSettings.WriteSettings();
 
                         // now we can reimport

Editor/Importers/YarnProjectImporter.cs

@@ -1311,6 +1311,44 @@ private static void AddStringTableEntries(IDictionary<string, StringInfo> string
                 }
             }
 
+            if (YarnSpinnerProjectSettings.GetOrCreateSettings().sortLocalisationValuesInsideStringTable)
+            {
+                // sorting the table based on file and line number
+                Dictionary<string, string> sortKeys = new();
+                foreach (var pair in stringTable)
+                {
+                    sortKeys[pair.Key] = $"{pair.Value.fileName.ToLower()}-{string.Format("{0:D6}", pair.Value.lineNumber)}";
+                }
+
+                HashSet<string> invalidKeys = new();
+                unityStringTable.SharedData.Entries.Sort((a,b) =>
+                {
+                    // if we encounter a key that doesn't match a value we got from the string table we want to log this and push it to one end
+                    if (sortKeys.TryGetValue(unityStringTable.GetEntry(a.Id).Key, out var aKey))
+                    {
+                        if (sortKeys.TryGetValue(unityStringTable.GetEntry(b.Id).Key, out var bKey))
+                        {
+                            return aKey.CompareTo(bKey);
+                        }
+                        else
+                        {
+                            invalidKeys.Add(unityStringTable.GetEntry(b.Id).Key);
+                            return 1;
+                        }
+                    }
+                    else
+                    {
+                        invalidKeys.Add(unityStringTable.GetEntry(a.Id).Key);
+                        return -1;
+                    }
+                });
+                // now that the table is sorted we want to log any invalid entries we might have found
+                foreach (var key in invalidKeys)
+                {
+                    Debug.LogWarning($"Encountered an ID in the Yarn string table \"{key}\" during import that didn't come from the Yarn Project.");
+                }
+            }
+
             // We've made changes to the table, so flag it and its shared data
             // as dirty.
             EditorUtility.SetDirty(unityStringTable);