feat: hot reload for Google Sheets (#26)

Author: aarthificial

.github/workflows/release.yml

@@ -98,6 +98,7 @@ jobs:
           targetPlatform: ${{ matrix.targetPlatform }}
           versioning: Custom
           version: ${{ needs.release.outputs.version }}
+          buildMethod: Editor.BuildScript.Build
       - name: Create zip archive
         run: |
           cd build/${{ matrix.targetPlatform }}

.github/workflows/verify.yml

@@ -50,6 +50,7 @@ jobs:
           unityVersion: 2022.3.6f1
           targetPlatform: ${{ matrix.targetPlatform }}
           versioning: Tag
+          buildMethod: Editor.BuildScript.Build
       - uses: actions/upload-artifact@v3
         with:
           name: Build

Assets/DevTools.meta

@@ -10,7 +10,7 @@
 using UnityEngine;
 using Object = UnityEngine.Object;
 
-namespace Editor.Typewriter {
+namespace DevTools.CSV {
   public static class CsvConverter {
     private enum ScriptState {
       Initial,
@@ -69,7 +69,7 @@ Object context
       }
 
       // _collection =
-        // LocalizationEditorSettings.GetStringTableCollection("Dialogue");
+      // LocalizationEditorSettings.GetStringTableCollection("Dialogue");
 
       _lookup.Add("LT", InteractionContext.LT);
       _lookup.Add("RT", InteractionContext.RT);
@@ -84,7 +84,7 @@ Object context
       BaseEntry previous = null;
       for (var i = 1; i < rows.Count; i++) {
         var cells = rows[i].Cells;
-        if (cells.Key() == "") {
+        if (cells.IsEmpty()) {
           continue;
         }
 
@@ -106,7 +106,10 @@ Object context
             type = typeof(FactEntry);
             break;
           default:
-            Debug.LogError($"Row {i + 1}: Unknown type {cells.Type()}", context);
+            Debug.LogError(
+              $"Row {i + 1} ({cells.Key()}): Unknown type {cells.Type()}",
+              context
+            );
             continue;
         }
 
@@ -138,7 +141,7 @@ Object context
 
       for (var i = 1; i < rows.Count; i++) {
         var cells = rows[i].Cells;
-        if (cells.Key() == "") {
+        if (cells.IsEmpty()) {
           previous = null;
           continue;
         }
@@ -160,7 +163,7 @@ Object context
               break;
           }
         } catch (Exception e) {
-          Debug.LogError($"Row {i + 1}: {e.Message}", context);
+          Debug.LogError($"Row {i + 1} ({cells.Key()}): {e.Message}", context);
           Debug.LogException(e);
         }
       }
@@ -434,13 +437,21 @@ private static IEnumerable<ScriptResult> ParseScript(string text) {
         text += '\n';
       }
 
+      var isComment = false;
       var context = new ParsingContext {
         Code = text,
         Line = 0,
         Column = 0,
       };
 
       foreach (var c in text) {
+        if (isComment) {
+          if (c == '\n') {
+            isComment = false;
+          }
+          continue;
+        }
+
         switch (c) {
           case '\r':
           case ' ':
@@ -467,6 +478,9 @@ private static IEnumerable<ScriptResult> ParseScript(string text) {
               throw new ParsingException("Unexpected '.'", context);
             }
 
+            break;
+          case '#' when state == ScriptState.Initial:
+            isComment = true;
             break;
           case '\n':
             switch (state) {
@@ -531,21 +545,31 @@ private static IEnumerable<EntryReference> ParseReferences(string text) {
         text += '\n';
       }
 
+      var isComment = false;
       var builder = new StringBuilder();
       foreach (var c in text) {
         switch (c) {
           case ' ':
           case '\r':
             continue;
+          case '#' when builder.Length == 0:
+            isComment = true;
+            break;
           case ',':
           case '\n':
+            if (isComment) {
+              isComment = false;
+              builder.Clear();
+              break;
+            }
+
             var value = builder.ToString();
             builder.Clear();
             if (value.Length > 0) {
               if (_lookup.TryGetValue(value, out var entry)) {
                 yield return entry;
               } else {
-                Debug.LogWarningFormat("Missing reference {0}", value);
+                throw new Exception($"Unknown entry reference: {value}.");
               }
             }
             break;
@@ -575,6 +599,9 @@ private static string GetErrorFrame(ParsingContext context) {
       return builder.ToString();
     }
 
+    private static bool IsEmpty(this List<string> list) =>
+      string.IsNullOrEmpty(list[0]) || list[0].StartsWith('#');
+
     private static string Key(this List<string> list) => list[0];
     private static string Type(this List<string> list) => list[2];
     private static string Speaker(this List<string> list) => list[3];

Assets/DevTools/CSV.meta

@@ -2,7 +2,7 @@
 using System.Collections.Generic;
 using System.Text;
 
-namespace Editor.Typewriter {
+namespace DevTools.CSV {
   public static class CsvParser {
     [Serializable]
     public struct Row {
@@ -27,7 +27,10 @@ public static IReadOnlyList<Row> Parse(string text) {
             continue;
           case '"': {
             isInsideField = !isInsideField;
-            if (!isInsideField && i + 1 < text.Length && text[i + 1] != ',') {
+            if (!isInsideField
+              && i + 1 < text.Length
+              && text[i + 1] != ','
+              && text[i + 1] != '\n') {
               _builder.Append('"');
             }
             break;
@@ -37,7 +40,9 @@ public static IReadOnlyList<Row> Parse(string text) {
             break;
           case '\n' when !isInsideField:
             AddCell(cells);
-            _rows.Add(new Row { Cells = cells });
+            if (cells.Count > 0) {
+              _rows.Add(new Row { Cells = cells });
+            }
             cells = new List<string>();
             break;
           default:

Assets/Editor/Typewriter/CsvConverter.cs renamed to Assets/DevTools/CSV/CsvConverter.cs

@@ -0,0 +1,5 @@
+using UnityEngine;
+
+namespace DevTools {
+  public partial class GoogleSheetLoader : MonoBehaviour { }
+}