Issue checkstyle#15605: update TodoComment to show how to use ignore …

…case in format property
romani · Sep 2, 2024 · cf2f17e · cf2f17e
1 parent c7cedf2
commit cf2f17e
Show file tree

Hide file tree

Showing 3 changed files with 8 additions and 7 deletions.
diff --git a/...cs-examples/java/com/puppycrawl/tools/checkstyle/checks/TodoCommentCheckExamplesTest.java b/...cs-examples/java/com/puppycrawl/tools/checkstyle/checks/TodoCommentCheckExamplesTest.java
@@ -43,9 +43,10 @@ public void testExample1() throws Exception {
     @Test
     public void testExample2() throws Exception {
         final String[] expected = {
-            "1:3: " + getCheckMessage(MSG_KEY, "(TODO)|(FIXME)"),
-            "18:14: " + getCheckMessage(MSG_KEY, "(TODO)|(FIXME)"),
-            "20:14: " + getCheckMessage(MSG_KEY, "(TODO)|(FIXME)"),
+            "1:3: " + getCheckMessage(MSG_KEY, "(?i)(TODO)|(FIXME)"),
+            "18:14: " + getCheckMessage(MSG_KEY, "(?i)(TODO)|(FIXME)"),
+            "19:14: " + getCheckMessage(MSG_KEY, "(?i)(TODO)|(FIXME)"),
+            "20:14: " + getCheckMessage(MSG_KEY, "(?i)(TODO)|(FIXME)"),
         };
 
         verifyWithInlineConfigParser(getPath("Example2.java"), expected);

diff --git a/...xdocs-examples/resources/com/puppycrawl/tools/checkstyle/checks/todocomment/Example2.java b/...xdocs-examples/resources/com/puppycrawl/tools/checkstyle/checks/todocomment/Example2.java
@@ -2,7 +2,7 @@
 <module name="Checker">
   <module name="TreeWalker">
     <module name="TodoComment">
-      <property name="format" value="(TODO)|(FIXME)"/>
+      <property name="format" value="(?i)(TODO)|(FIXME)"/>
     </module>
   </module>
 </module>
@@ -16,7 +16,7 @@ public class Example2 {
   int x;
   public void test() {
     i++;   // TODO: do differently in future    // violation
-    i++;   // todo: do differently in future
+    i++;   // todo: do differently in future    // violation
     i=i/x; // FIXME: handle x = 0 case          // violation
     i=i/x; // FIX :  handle x = 0 case
   }

diff --git a/src/xdocs/checks/misc/todocomment.xml b/src/xdocs/checks/misc/todocomment.xml
@@ -81,7 +81,7 @@ public class Example1 {
 &lt;module name=&quot;Checker&quot;&gt;
   &lt;module name=&quot;TreeWalker&quot;&gt;
     &lt;module name=&quot;TodoComment&quot;&gt;
-      &lt;property name=&quot;format&quot; value=&quot;(TODO)|(FIXME)&quot;/&gt;
+      &lt;property name=&quot;format&quot; value=&quot;(?i)(TODO)|(FIXME)&quot;/&gt;
     &lt;/module&gt;
   &lt;/module&gt;
 &lt;/module&gt;
@@ -95,7 +95,7 @@ public class Example2 {
   int x;
   public void test() {
     i++;   // TODO: do differently in future    // violation
-    i++;   // todo: do differently in future
+    i++;   // todo: do differently in future    // violation
     i=i/x; // FIXME: handle x = 0 case          // violation
     i=i/x; // FIX :  handle x = 0 case
   }