Merge branch 'master' into chore/upgrade-to-webpack-5

pinterest · Oct 25, 2024 · 8bb4d25 · 8bb4d25
2 parents 33bd4b8 + e54ee55
commit 8bb4d25
Show file tree

Hide file tree

Showing 6 changed files with 30 additions and 26 deletions.
diff --git a/...main/java/com/box/l10n/mojito/cli/command/checks/AbstractPlaceholderDescriptionCheck.java b/...main/java/com/box/l10n/mojito/cli/command/checks/AbstractPlaceholderDescriptionCheck.java
@@ -20,17 +20,21 @@ public Optional<String> getFailureText(String placeholder) {
               + placeholder
               + QUOTE_MARKER
               + " in comment. Please add a description in the string comment in the form "
+              + QUOTE_MARKER
               + placeholder
-              + ":<description>";
+              + ":<description>"
+              + QUOTE_MARKER;
     } else if (!placeholder.trim().isEmpty()) {
       failureText =
           "Missing description for placeholder with name "
               + QUOTE_MARKER
               + placeholder
               + QUOTE_MARKER
               + " in comment. Please add a description in the string comment in the form "
+              + QUOTE_MARKER
               + placeholder
-              + ":<description>";
+              + ":<description>"
+              + QUOTE_MARKER;
     }
     return Optional.ofNullable(failureText);
   }

diff --git a/...com/box/l10n/mojito/cli/command/checks/DoubleBracesPlaceholderDescriptionCheckerTest.java b/...com/box/l10n/mojito/cli/command/checks/DoubleBracesPlaceholderDescriptionCheckerTest.java
@@ -37,7 +37,7 @@ public void testMissingPlaceholderDescriptionInComment() {
                 + QUOTE_MARKER
                 + "placeholder"
                 + QUOTE_MARKER
-                + " in comment. Please add a description in the string comment in the form placeholder:<description>"));
+                + " in comment. Please add a description in the string comment in the form `placeholder:<description>`"));
   }
 
   @Test
@@ -52,15 +52,15 @@ public void testNullComment() {
                 + QUOTE_MARKER
                 + "placeholder"
                 + QUOTE_MARKER
-                + " in comment. Please add a description in the string comment in the form placeholder:<description>"));
+                + " in comment. Please add a description in the string comment in the form `placeholder:<description>`"));
   }
 
   @Test
   public void testMultiplePlaceholderDescriptionsInComment() {
     Set<String> failures =
         doubleBracesPlaceholderCommentChecker.checkCommentForDescriptions(
             "A source string with a single {{placeholder}} and {another} and so {more}.",
-            "Test comment placeholder:description 1,another: description 2,more: description 3");
+            "Test comment `placeholder:description 1`,`another: description 2`,`more: description 3`");
     Assert.assertTrue(failures.isEmpty());
   }
 
@@ -77,7 +77,7 @@ public void testOneOfMultiplePlaceholderDescriptionsMissingInComment() {
                 + QUOTE_MARKER
                 + "another"
                 + QUOTE_MARKER
-                + " in comment. Please add a description in the string comment in the form another:<description>"));
+                + " in comment. Please add a description in the string comment in the form `another:<description>`"));
   }
 
   @Test
@@ -93,7 +93,7 @@ public void testPluralPlaceholderMissingDescription() {
                 + QUOTE_MARKER
                 + "numFiles"
                 + QUOTE_MARKER
-                + " in comment. Please add a description in the string comment in the form numFiles:<description>"));
+                + " in comment. Please add a description in the string comment in the form `numFiles:<description>`"));
   }
 
   @Test
@@ -109,6 +109,6 @@ public void testNumberedPlaceholder() {
                 + QUOTE_MARKER
                 + "0"
                 + QUOTE_MARKER
-                + " in comment. Please add a description in the string comment in the form 0:<description>"));
+                + " in comment. Please add a description in the string comment in the form `0:<description>`"));
   }
 }
diff --git a/cli/src/test/java/com/box/l10n/mojito/cli/command/checks/PlaceholderCommentCheckerTest.java b/cli/src/test/java/com/box/l10n/mojito/cli/command/checks/PlaceholderCommentCheckerTest.java
@@ -146,7 +146,7 @@ public void testOneOfMultiplePlaceholderDescriptionsMissingInComment() {
             + QUOTE_MARKER
             + "another"
             + QUOTE_MARKER
-            + " in comment. Please add a description in the string comment in the form another:<description>",
+            + " in comment. Please add a description in the string comment in the form `another:<description>`",
         result.getNotificationText());
   }
 
@@ -270,17 +270,17 @@ public void testMultipleIOSPlaceholderTypesFails() {
         result
             .getNotificationText()
             .contains(
-                "Please add a description in the string comment in the form %1$@:<description>"));
+                "Please add a description in the string comment in the form `%1$@:<description>`"));
     Assert.assertTrue(
         result
             .getNotificationText()
             .contains(
-                "Please add a description in the string comment in the form %@:<description>"));
+                "Please add a description in the string comment in the form `%@:<description>`"));
     Assert.assertTrue(
         result
             .getNotificationText()
             .contains(
-                "Please add a description in the string comment in the form %2$@ld:<description>"));
+                "Please add a description in the string comment in the form `%2$@ld:<description>`"));
   }
 
   @Test

diff --git a/...0n/mojito/cli/command/checks/PrintfLikeVariableTypePlaceholderDescriptionCheckerTest.java b/...0n/mojito/cli/command/checks/PrintfLikeVariableTypePlaceholderDescriptionCheckerTest.java
@@ -52,7 +52,7 @@ public void testFailure() {
                 + QUOTE_MARKER
                 + "count"
                 + QUOTE_MARKER
-                + " in comment. Please add a description in the string comment in the form count:<description>"));
+                + " in comment. Please add a description in the string comment in the form `count:<description>`"));
   }
 
   @Test
@@ -69,7 +69,7 @@ public void testFailureWithBraces() {
                 + QUOTE_MARKER
                 + "count"
                 + QUOTE_MARKER
-                + " in comment. Please add a description in the string comment in the form count:<description>"));
+                + " in comment. Please add a description in the string comment in the form `count:<description>`"));
   }
 
   @Test
@@ -86,7 +86,7 @@ public void testNullComment() {
                 + QUOTE_MARKER
                 + "count"
                 + QUOTE_MARKER
-                + " in comment. Please add a description in the string comment in the form count:<description>"));
+                + " in comment. Please add a description in the string comment in the form `count:<description>`"));
   }
 
   @Test
@@ -103,7 +103,7 @@ public void testFailureWithMultiplePlaceholders() {
                 + QUOTE_MARKER
                 + "shelf_count"
                 + QUOTE_MARKER
-                + " in comment. Please add a description in the string comment in the form shelf_count:<description>"));
+                + " in comment. Please add a description in the string comment in the form `shelf_count:<description>`"));
   }
 
   @Test

diff --git a/.../com/box/l10n/mojito/cli/command/checks/SimpleRegexPlaceholderDescriptionCheckerTest.java b/.../com/box/l10n/mojito/cli/command/checks/SimpleRegexPlaceholderDescriptionCheckerTest.java
@@ -42,7 +42,7 @@ public void testFailure() {
                 + QUOTE_MARKER
                 + "%1"
                 + QUOTE_MARKER
-                + " in comment. Please add a description in the string comment in the form %1:<description>"));
+                + " in comment. Please add a description in the string comment in the form `%1:<description>`"));
   }
 
   @Test
@@ -58,7 +58,7 @@ public void testNullComment() {
                 + QUOTE_MARKER
                 + "%1"
                 + QUOTE_MARKER
-                + " in comment. Please add a description in the string comment in the form %1:<description>"));
+                + " in comment. Please add a description in the string comment in the form `%1:<description>`"));
   }
 
   @Test
@@ -74,7 +74,7 @@ public void testFailureWithMultiplePlaceholders() {
                 + QUOTE_MARKER
                 + "%2"
                 + QUOTE_MARKER
-                + " in comment. Please add a description in the string comment in the form %2:<description>"));
+                + " in comment. Please add a description in the string comment in the form `%2:<description>`"));
   }
 
   @Test
@@ -103,7 +103,7 @@ public void testNoSpecifierRegexFailure() {
                 + QUOTE_MARKER
                 + "%d"
                 + QUOTE_MARKER
-                + " in comment. Please add a description in the string comment in the form %d:<description>"));
+                + " in comment. Please add a description in the string comment in the form `%d:<description>`"));
   }
 
   @Test
@@ -121,6 +121,6 @@ public void testNoSpecifierRegexFailureWithMultiplePlaceholders() {
                 + QUOTE_MARKER
                 + "%s"
                 + QUOTE_MARKER
-                + " in comment. Please add a description in the string comment in the form %s:<description>"));
+                + " in comment. Please add a description in the string comment in the form `%s:<description>`"));
   }
 }
diff --git a/...com/box/l10n/mojito/cli/command/checks/SingleBracesPlaceholderDescriptionCheckerTest.java b/...com/box/l10n/mojito/cli/command/checks/SingleBracesPlaceholderDescriptionCheckerTest.java
@@ -37,7 +37,7 @@ public void testMissingPlaceholderDescriptionInComment() {
                 + QUOTE_MARKER
                 + "placeholder"
                 + QUOTE_MARKER
-                + " in comment. Please add a description in the string comment in the form placeholder:<description>"));
+                + " in comment. Please add a description in the string comment in the form `placeholder:<description>`"));
   }
 
   @Test
@@ -52,7 +52,7 @@ public void testNullComment() {
                 + QUOTE_MARKER
                 + "placeholder"
                 + QUOTE_MARKER
-                + " in comment. Please add a description in the string comment in the form placeholder:<description>"));
+                + " in comment. Please add a description in the string comment in the form `placeholder:<description>`"));
   }
 
   @Test
@@ -77,7 +77,7 @@ public void testOneOfMultiplePlaceholderDescriptionsMissingInComment() {
                 + QUOTE_MARKER
                 + "another"
                 + QUOTE_MARKER
-                + " in comment. Please add a description in the string comment in the form another:<description>"));
+                + " in comment. Please add a description in the string comment in the form `another:<description>`"));
   }
 
   @Test
@@ -93,7 +93,7 @@ public void testPluralPlaceholderMissingDescription() {
                 + QUOTE_MARKER
                 + "numFiles"
                 + QUOTE_MARKER
-                + " in comment. Please add a description in the string comment in the form numFiles:<description>"));
+                + " in comment. Please add a description in the string comment in the form `numFiles:<description>`"));
   }
 
   @Test
@@ -110,7 +110,7 @@ public void testNumberedPlaceholder() {
                 + QUOTE_MARKER
                 + "0"
                 + QUOTE_MARKER
-                + " in comment. Please add a description in the string comment in the form 0:<description>"));
+                + " in comment. Please add a description in the string comment in the form `0:<description>`"));
   }
 
   @Test