Add HydeStan helper to create a todo list

monorepo/HydeStan/.gitignore

@@ -0,0 +1 @@
+todo.md

monorepo/HydeStan/HydeStan.php

@@ -419,6 +419,8 @@ public function run(string $file, string $contents): void
         if (str_contains($contents, 'extends TestCase') && ! str_contains($contents, 'extends UnitTestCase')) {
             $lineNumber = substr_count(substr($contents, 0, strpos($contents, 'extends TestCase')), "\n") + 1;
 
+            todo(realpath(__DIR__.'/../../packages/framework/'.$file), $lineNumber, 'Refactor unit test to extend UnitTestCase instead of TestCase');
+
             echo sprintf('Test in unit namespace extends TestCase instead of UnitTestCase at %s', fileLink($file, $lineNumber, false))."\n";
         }
     }

monorepo/HydeStan/includes/helpers.php

@@ -77,3 +77,61 @@ function recursiveFileFinder(string $directory): array
 
     return $files;
 }
+
+class TodoBuffer
+{
+    private static array $todos = [];
+
+    public static function add(string $file, int $line, string $todo): void
+    {
+        self::$todos[] = [
+            'file' => $file,
+            'line' => $line,
+            'todo' => $todo,
+        ];
+    }
+
+    public static function getTodos(): array
+    {
+        return self::$todos;
+    }
+
+    public static function writeTaskFile(): void
+    {
+        $todos = self::getTodos();
+
+        if (empty($todos)) {
+            return;
+        }
+
+        $taskFile = __DIR__.'/../todo.md';
+
+        $content = '# Todos'."\n\n";
+        $groupedTodos = [];
+
+        $baseDir = realpath(__DIR__.'/../../../');
+
+        foreach ($todos as $todo) {
+            $path = "{$todo['file']}:{$todo['line']}";
+            $path = str_replace('\\', '/', $path);
+
+            $path = substr($path, strlen($baseDir) + 1);
+
+            $groupedTodos[$todo['todo']][] = "[$path]($path)";
+        }
+
+        foreach ($groupedTodos as $todo => $items) {
+            $content .= "## $todo\n\n";
+            foreach ($items as $item) {
+                $content .= "- $item\n";
+            }
+        }
+
+        file_put_contents($taskFile, $content);
+    }
+}
+
+function todo(string $file, int $line, string $todo): void
+{
+    TodoBuffer::add($file, $line, $todo);
+}

monorepo/HydeStan/run.php

@@ -12,6 +12,9 @@
 $analyser = new HydeStan($debug);
 $analyser->run();
 
+// Todo: Could add a flag for this
+TodoBuffer::writeTaskFile();
+
 if ($analyser->hasErrors()) {
     exit(1);
 }