fix(api): regex characters in StringTemplate variables should be es…

…caped (#65)
axieum · Oct 1, 2022 · 4553977 · 4553977
1 parent 927539b
commit 4553977
Show file tree

Hide file tree

Showing 2 changed files with 13 additions and 2 deletions.
diff --git a/minecord-api/src/main/java/me/axieum/mcmod/minecord/api/util/StringTemplate.java b/minecord-api/src/main/java/me/axieum/mcmod/minecord/api/util/StringTemplate.java
@@ -249,7 +249,7 @@ public String format(final @Nullable String template)
                     if (format != null && !format.isBlank()) {
                         // String
                         if (value instanceof String) {
-                            matcher.appendReplacement(builder, String.format(format, value));
+                            matcher.appendReplacement(builder, Matcher.quoteReplacement(String.format(format, value)));
                         // Number
                         } else if (value instanceof Number) {
                             matcher.appendReplacement(builder, new DecimalFormat(format).format(value));
@@ -277,7 +277,7 @@ public String format(final @Nullable String template)
                             );
                         // Other
                         } else {
-                            matcher.appendReplacement(builder, String.valueOf(value));
+                            matcher.appendReplacement(builder, Matcher.quoteReplacement(String.valueOf(value)));
                         }
                     }
                 } catch (IllegalArgumentException e) {

diff --git a/minecord-api/src/test/java/me/axieum/mcmod/minecord/api/util/StringTemplateTests.java b/minecord-api/src/test/java/me/axieum/mcmod/minecord/api/util/StringTemplateTests.java
@@ -36,6 +36,17 @@ public void variables()
         );
     }
 
+    @Test
+    @DisplayName("Replace variables with special regex characters")
+    public void variablesWithSpecialCharacters()
+    {
+        st.add("special", "\\$\\\\$$");
+        assertEquals(
+            "_\\$\\\\$$",
+            st.format("_${special}")
+        );
+    }
+
     @Test
     @DisplayName("Resolve lazy variables")
     public void lazyVariables()