Merge pull request #6 from aboutbits/ab-234-checkstyle-allow-todo

adjust checkstyle rule to allow for TODO comments if they have a link…
aboutbits · Sep 10, 2024 · 69d3b5a · 69d3b5a
2 parents 19c1c61 + 76f65df
commit 69d3b5a
Showing 1 changed file with 4 additions and 1 deletion.
diff --git a/checkstyle.xml b/checkstyle.xml
@@ -194,7 +194,10 @@
         <!-- See https://checkstyle.org/config_misc.html -->
         <module name="ArrayTypeStyle"/>
         <!--<module name="FinalParameters"/>-->
-        <module name="TodoComment"/>
+        <module name="TodoComment">
+            <!-- allow any form of TODO comments if they have a link associated -->
+            <property name="format" value="(?i)^\s*TO[-_]?DO:?(?!.*https?:\/\/)"/>
+        </module>
         <module name="UpperEll"/>
 
         <!-- https://checkstyle.org/config_filters.html#SuppressionXpathFilter -->