Merge pull request #783 from fabio-ivona/fix-comments-in-test-name

fix comments in dokblocks
pestphp · Apr 15, 2023 · 9744b98 · 9744b98
2 parents f6d9aa5 + e1143d2
commit 9744b98
Show file tree

Hide file tree

Showing 2 changed files with 12 additions and 1 deletion.
diff --git a/src/Factories/Annotations/TestDox.php b/src/Factories/Annotations/TestDox.php
@@ -14,7 +14,17 @@ final class TestDox implements AddsAnnotations
      */
     public function __invoke(TestCaseMethodFactory $method, array $annotations): array
     {
-        $annotations[] = "@testdox $method->description";
+        /*
+       * escapes docblock according to
+       * https://manual.phpdoc.org/HTMLframesConverter/default/phpDocumentor/tutorial_phpDocumentor.howto.pkg.html#basics.desc
+       *
+       * note: '@' escaping is not needed as it cannot be the first character of the line (it always starts with @testdox
+       */
+
+        assert($method->description !== null);
+        $methodDescription = str_replace('*/', '{@*}', $method->description);
+
+        $annotations[] = "@testdox $methodDescription";
 
         return $annotations;
     }

diff --git a/tests/Unit/TestName.php b/tests/Unit/TestName.php
@@ -61,6 +61,7 @@
     'Німеччина' => '__pest_evaluable_Німеччина',
     'Nam Định' => '__pest_evaluable_Nam_Định',
     '呼和浩特' => '__pest_evaluable_呼和浩特',
+    'test /** with comment */ should do' => '__pest_evaluable_test_____with_comment____should_do',
 ];
 
 foreach ($names as $name => $methodName) {