feat: added better error handling and notification for invalid templates

src/lang/en.json

@@ -5,6 +5,7 @@
       "race": "Race",
       "senses": "Senses",
       "classes": "Classes",
+      "invalid-template": "The template you are using is invalid. <br/> Please check the template and try again.",
       "no-players": "No players are currently logged in.",
       "no-systems": "You do not have any json files for this system in your data/partysheets folder. Please add some to enable this feature.",
       "bugreport": "File a Bug Report",

src/lang/es.json

@@ -5,6 +5,7 @@
       "race": "Raza",
       "senses": "Sentidos",
       "classes": "Clases",
+      "invalid-template": "La plantilla que está usando no es válida. <BR/> Por favor revise la plantilla y vuelva a intentarlo.",
       "no-players": "Ningún jugador ha iniciado sesión actualmente.",
       "no-systems": "La carpeta data/partysheets no contiene archivos JSON para este sistema. Necesitas agregar algunos para activar esta funcionalidad.",
       "bugreport": "Dar retroalimentación",

src/module/app/party-sheet.js

@@ -5,6 +5,7 @@ import {
   getSelectedSystem,
   parseExtras,
   parsePluses,
+  TemplateProcessError,
   trimIfString,
   updateSelectedSystem,
 } from "../utils.js";
@@ -170,7 +171,14 @@ export class PartySheetForm extends FormApplication {
       }
       return { name: data.name, author: data.author, players: finalActorList, rowcount: data.rows.length };
     } catch (ex) {
-      console.log(ex);
+      // Detect if this is a TemplateProcessError or not
+      if (ex instanceof TemplateProcessError) {
+        ex.data.name = data.name;
+        ex.data.author = data.author;
+        throw ex;
+      } else {
+        console.log(ex);
+      }
     }
     return { name: "", author: "", players: [], rowcount: 0 };
   }
@@ -564,32 +572,36 @@ export class PartySheetForm extends FormApplication {
    * @memberof PartySheetForm
    */
   getCustomData(character, type, value) {
-    switch (type) {
-      case "direct":
-        return this.processDirect(character, type, value);
-      case "direct-complex":
-        return this.processDirectComplex(character, type, value);
-      case "charactersheet":
-        // @ts-ignore
-        return new Handlebars.SafeString(
-          `<input type="image" name="fvtt-party-sheet-actorimage" data-actorid="${
-            character.uuid
-          }" class="token-image" src="${character.prototypeToken.texture.src}" title="${
-            character.prototypeToken.name
-          }" width="36" height="36" style="transform: rotate(${character.prototypeToken.rotation ?? 0}deg);"/>`,
-        );
-      case "array-string-builder":
-        return this.processArrayStringBuilder(character, type, value);
-      case "string":
-        return value;
-      case "object-loop":
-        return this.processObjectLoop(character, type, value);
-      case "largest-from-array":
-        return this.processLargestFromArray(character, type, value);
-      case "smallest-from-array":
-        return this.processSmallestFromArray(character, type, value);
-      default:
-        return "";
+    try {
+      switch (type) {
+        case "direct":
+          return this.processDirect(character, type, value);
+        case "direct-complex":
+          return this.processDirectComplex(character, type, value);
+        case "charactersheet":
+          // @ts-ignore
+          return new Handlebars.SafeString(
+            `<input type="image" name="fvtt-party-sheet-actorimage" data-actorid="${
+              character.uuid
+            }" class="token-image" src="${character.prototypeToken.texture.src}" title="${
+              character.prototypeToken.name
+            }" width="36" height="36" style="transform: rotate(${character.prototypeToken.rotation ?? 0}deg);"/>`,
+          );
+        case "array-string-builder":
+          return this.processArrayStringBuilder(character, type, value);
+        case "string":
+          return value;
+        case "object-loop":
+          return this.processObjectLoop(character, type, value);
+        case "largest-from-array":
+          return this.processLargestFromArray(character, type, value);
+        case "smallest-from-array":
+          return this.processSmallestFromArray(character, type, value);
+        default:
+          return "";
+      }
+    } catch (ex) {
+      throw new TemplateProcessError(ex);
     }
   }
 
@@ -616,7 +628,27 @@ export class PartySheetForm extends FormApplication {
 
     updateSelectedSystem(applicableSystems[selectedIdx]);
     const selectedSystem = getSelectedSystem();
-    let { name: sysName, author: sysAuthor, players, rowcount } = this.getCustomPlayerData(selectedSystem);
+    let selectedName, selectedAuthor, players, rowcount;
+    let invalidTemplateError = false;
+    try {
+      let result = this.getCustomPlayerData(selectedSystem);
+      selectedName = result.name;
+      selectedAuthor = result.author;
+      players = result.players;
+      rowcount = result.rowcount;
+    } catch (ex) {
+      if (ex instanceof TemplateProcessError) {
+        // @ts-ignore
+        ui.notifications.error(
+          `There was an error processing the template for ${selectedSystem.name} by ${selectedSystem.author}.`,
+        );
+        selectedName = ex.data.name;
+        selectedAuthor = ex.data.author;
+        invalidTemplateError = true;
+      }
+      console.log(ex);
+    }
+
     // @ts-ignore
     return mergeObject(super.getData(options), {
       minimalView,
@@ -625,8 +657,9 @@ export class PartySheetForm extends FormApplication {
       rowcount,
       players,
       applicableSystems,
-      selectedName: sysName,
-      selectedAuthor: sysAuthor,
+      selectedName,
+      selectedAuthor,
+      invalidTemplateError,
       // @ts-ignore
       overrides: this.overrides,
     });

src/module/utils.js

@@ -4,6 +4,17 @@ var customSystems = [DND5E];
 export var selectedSystem = null;
 const NEWLINE_ELEMENTS = ["{newline}", "{nl}"];
 
+export class TemplateProcessError extends Error {
+  constructor(message) {
+    super(message);
+    this.name = "TemplateProcessError";
+    this.data = {
+      name: "",
+      author: "",
+    };
+  }
+}
+
 /**
  * Converts a string to proper case.
  * @param {string} inputString - The input string to convert.

src/templates/party-sheet.hbs

@@ -65,9 +65,12 @@
       </tbody>
     </table>
     {{else}}
-      <div class="fvtt-party-sheet-ps-no-players">{{ localize "fvtt-party-sheet.party-sheet.no-players" }}</div>
+      {{#if invalidTemplateError}}
+          <div class="fvtt-party-sheet-ps-no-players">{{{ localize "fvtt-party-sheet.party-sheet.invalid-template" }}}</div>
+        {{else}}
+          <div class="fvtt-party-sheet-ps-no-players">{{ localize "fvtt-party-sheet.party-sheet.no-players" }}</div>
+      {{/if}}
     {{/if}}
-
   {{else}}
     <div class="fvtt-party-sheet-ps-no-systems">{{ localize "fvtt-party-sheet.party-sheet.no-systems" }}</div>
   {{/if}}