🚸 Add some workarounds and post-processing for YAML statblocks

- Change tests to be more specific about which asterisks are disallowed
- Add some workarounds for specific statblocks

Author: miscoined

src/main/java/dev/ebullient/convert/qute/QuteUtil.java

@@ -105,10 +105,14 @@ default String render() {
 
         /** Return the object rendered using its template with {@code asYamlStatblock} set to true. */
         default String renderAsYamlStatblock() {
-            // Manually remove the dice roller syntax - the yaml statblocks handle dice roller syntax differently. At this
-            // point, the parsing has already finished, so we can't use parseState to stop them from being added in the first
-            // place. So all we can do is post-process to remove them again.
-            return render(true).replaceAll("`dice: [^`]+` \\(`([^`]+)`\\)", "$1");
+            return render(true)
+                // Manually remove the dice roller syntax - the yaml statblocks handle dice roller syntax differently. At this
+                // point, the parsing has already finished, so we can't use parseState to stop them from being added in the
+                // first place. So all we can do is post-process to remove them again.
+                .replaceAll("`dice: [^`]+` \\(`([^`]+)`\\)", "$1")
+                // This usage is usually a footnote. With the Markdown rendering the asterisk is unnecessary, so just don't
+                // add the asterisk, so this doesn't get treated as Markdown formatting.
+                .replaceAll("\\* \\^\\[", " ^[");
         }
     }
 }

src/main/java/dev/ebullient/convert/tools/pf2e/qute/QuteCreature.java

@@ -362,6 +362,11 @@ public String formattedAmount() {
 
         @Override
         public String toString() {
+            if (notes.size() == 1 && notes.get(0).equals("*")) {
+                // Workaround for specific statblocks which use "*" to tag particular spells. Use a carat instead so it doesn't
+                // get Markdown formatted.
+                return join(" ", (spellRef == null ? name : spellRef.toString()) + "^", formattedAmount());
+            }
             return join(" ", spellRef == null ? name : spellRef, formattedAmount(), formattedNotes());
         }
     }

src/test/java/dev/ebullient/convert/TestUtils.java

@@ -48,6 +48,9 @@ public class TestUtils {
 
     static String GENERATED_DOCS = PROJECT_PATH.resolve("docs/templates").normalize().toAbsolutePath().toString();
 
+    private static final Pattern ASTERISK_START_PROP_PAT = Pattern.compile(":\\s*\\*");
+    private static final Pattern SINGLE_ASTERISK_PAT = Pattern.compile("[^*]\\*[^*]");
+
     // Obnoxious regular expression because markdown links are complicated:
     // Matches: [link text](vaultPath "title")
     // - link text is optional, and may contain parentheses. Use a negative lookahead for ](
@@ -374,7 +377,14 @@ public static List<String> yamlStatblockChecker(Path p, List<String> content) {
                 yaml = false; // end yaml block
             } else if (yaml) {
                 statblock.add(l);
-                if (l.contains("*")) {
+                // Asterisks at the start of values indicate aliases in YAML. If we find this, it's probably not intentional.
+                if (ASTERISK_START_PROP_PAT.matcher(l).matches()) {
+                    errors.add(String.format("Found '*' property alias in %s: %s", p, l));
+                }
+                // Sometimes statblock text uses asterisks. Double asterisks are usually intentional markdown, but single
+                // asterisks are suspect and may be asterisks which have snuck in from the data source, and won't be rendered
+                // literallywill be rendered.
+                if (SINGLE_ASTERISK_PAT.matcher(l).matches()) {
                     errors.add(String.format("Found '*' in %s: %s", p, l));
                 }
                 if (l.contains("\"desc\": \"\"")) {