support colon after date

staabm · Dec 14, 2023 · 9188ee4 · 9188ee4
1 parent a1b9d67
commit 9188ee4
Show file tree

Hide file tree

Showing 3 changed files with 12 additions and 12 deletions.
diff --git a/src/TodoByRule.php b/src/TodoByRule.php
@@ -12,7 +12,7 @@
  */
 final class TodoByRule implements Rule
 {
-    private const PATTERN = '/^TODO:?\s*([0-9]{4}-[0-9]{2}-[0-9]{2})(.*)$/';
+    private const PATTERN = '/^TODO:?\s*([0-9]{4}-[0-9]{2}-[0-9]{2}):?(.*)$/';
 
     public function getNodeType(): string
     {
@@ -54,7 +54,7 @@ public function processNode(\PhpParser\Node $node, \PHPStan\Analyser\Scope $scop
             if ($todoText === '') {
                 $errorMessage = 'comment expired on '. $date .'.';
             } else {
-                $errorMessage = "'$todoText' expired on ". $date .'.';
+                $errorMessage = "comment '$todoText' expired on ". $date .'.';
             }
 
             $errors[] = RuleErrorBuilder::message($errorMessage)->line($comment->getStartLine())->build();

diff --git a/tests/TodoByRuleTest.php b/tests/TodoByRuleTest.php
@@ -20,43 +20,43 @@ public function testRule(): void
     {
         $this->analyse([__DIR__ . '/data/example.php'], [
             [
-                "'Expired comment1' expired on 2023-12-14.",
+                "comment 'Expired comment1' expired on 2023-12-14.",
                 9,
             ],
             [
-                "'Expired comment2' expired on 2023-12-14.",
+                "comment 'Expired comment2' expired on 2023-12-14.",
                 10,
             ],
             [
-                "'Expired comment3' expired on 2023-12-14.",
+                "comment 'Expired comment3' expired on 2023-12-14.",
                 11,
             ],
             [
-                "'Expired comment4' expired on 2023-12-14.",
+                "comment 'Expired comment4' expired on 2023-12-14.",
                 12,
             ],
             [
-                "'Expired comment5' expired on 2023-12-14.",
+                "comment 'Expired comment5' expired on 2023-12-14.",
                 13,
             ],
             [
-                "'Expired commentX' expired on 2023-12-14.",
+                "comment 'Expired commentX' expired on 2023-12-14.",
                 19,
             ],
             [
                 "comment expired on 2023-12-14.",
                 21,
             ],
             [
-                "'method comment' expired on 2023-12-14.",
+                "comment 'method comment' expired on 2023-12-14.",
                 27,
             ],
             [
-                "'in method comment1' expired on 2023-12-14.",
+                "comment 'in method comment1' expired on 2023-12-14.",
                 29,
             ],
             [
-                "'in method comment2' expired on 2023-12-14.",
+                "comment 'in method comment2' expired on 2023-12-14.",
                 31,
             ],
         ]);

diff --git a/tests/data/example.php b/tests/data/example.php
@@ -28,6 +28,6 @@ class Z {
     public function XY():void {
         // TODO: 2023-12-14 in method comment1
         $x = 1;
-        // TODO: 2023-12-14 in method comment2
+        // TODO 2023-12-14: in method comment2
     }
 }