feat: Add ConvertMultilineDocblockToSingleLineRector

rules-tests/CodingStyle/Rector/FunctionLike/ConvertMultilineDocblockToSingleLineRector/ConvertMultilineDocblockToSingleLineRectorTest.php

@@ -0,0 +1,28 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Rector\Tests\CodingStyle\Rector\FunctionLike\ConvertMultilineDocblockToSingleLineRector;
+
+use Iterator;
+use PHPUnit\Framework\Attributes\DataProvider;
+use Rector\Testing\PHPUnit\AbstractRectorTestCase;
+
+final class ConvertMultilineDocblockToSingleLineRectorTest extends AbstractRectorTestCase
+{
+    #[DataProvider('provideData')]
+    public function test(string $filePath): void
+    {
+        $this->doTestFile($filePath);
+    }
+
+    public static function provideData(): Iterator
+    {
+        return self::yieldFilesFromDirectory(__DIR__ . '/Fixture');
+    }
+
+    public function provideConfigFilePath(): string
+    {
+        return __DIR__ . '/config/configured_rule.php';
+    }
+}

rules-tests/CodingStyle/Rector/FunctionLike/ConvertMultilineDocblockToSingleLineRector/Fixture/single_statements.php.inc

@@ -0,0 +1,137 @@
+<?php
+
+namespace Rector\Tests\CodingStyle\Rector\Node\ConvertMultilineDocblockToSingleLineRector\Fixture;
+
+/**
+ * @see Example
+ */
+class SingleStatements
+{
+    /**
+     * @var string
+     */
+    private $value;
+
+    /**
+     * @return string
+     */
+    public function getValue(): string
+    {
+        return $this->value;
+    }
+
+    /**
+     * @param string $value
+     */
+    public function setValue(string $value): void
+    {
+        $this->value = $value;
+    }
+
+    /**
+     * @throws \Exception
+     */
+    public function dangerous(): void
+    {
+        throw new \Exception();
+    }
+
+    public function testFunction()
+    {
+        /**
+         * @var Foo $foo
+         */
+        $foo = resolve(Foo::class);
+
+        /**
+         * @phpstan-ignore variable.undefined
+         */
+        echo $bar;
+
+        /**
+         * @var string
+         */
+        $name = 'test';
+
+        /**
+         * @param int $i
+         */
+        if ($i > 0) {
+            /**
+             * @var array $data
+             */
+            $data = [];
+        }
+
+        /**
+         * @var int $number
+         */
+        foreach ($items as $number) {
+            // do something
+        }
+
+        /**
+         * @return string
+         */
+        return $name;
+    }
+}
+
+?>
+-----
+<?php
+
+namespace Rector\Tests\CodingStyle\Rector\Node\ConvertMultilineDocblockToSingleLineRector\Fixture;
+
+/** @see Example */
+class SingleStatements
+{
+    /** @var string */
+    private $value;
+
+    /** @return string */
+    public function getValue(): string
+    {
+        return $this->value;
+    }
+
+    /** @param string $value */
+    public function setValue(string $value): void
+    {
+        $this->value = $value;
+    }
+
+    /** @throws \Exception */
+    public function dangerous(): void
+    {
+        throw new \Exception();
+    }
+
+    public function testFunction()
+    {
+        /** @var Foo $foo */
+        $foo = resolve(Foo::class);
+
+        /** @phpstan-ignore variable.undefined */
+        echo $bar;
+
+        /** @var string */
+        $name = 'test';
+
+        /** @param int $i */
+        if ($i > 0) {
+            /** @var array $data */
+            $data = [];
+        }
+
+        /** @var int $number */
+        foreach ($items as $number) {
+            // do something
+        }
+
+        /** @return string */
+        return $name;
+    }
+}
+
+?>

rules-tests/CodingStyle/Rector/FunctionLike/ConvertMultilineDocblockToSingleLineRector/Fixture/skip_multiple_line_statements.php.inc

@@ -0,0 +1,43 @@
+<?php
+
+namespace Rector\Tests\CodingStyle\Rector\Node\ConvertMultilineDocblockToSingleLineRector\Fixture;
+
+class SkipMultipleStatements
+{
+    /**
+     * Some function description.
+     *
+     * @return string
+     */
+    public function getTitle(): string
+    {
+        return $this->title;
+    }
+
+    /**
+     * @param string $value
+     * @return void
+     */
+    public function setValue(string $value): void
+    {
+        $this->value = $value;
+    }
+
+    /**
+     * @var string
+     * @see SomeClass
+     */
+    private $name;
+
+    /**
+     * This method does something dangerous.
+     * 
+     * Please be careful when using it.
+     *
+     * @throws \Exception
+     */
+    public function dangerous(): void
+    {
+        throw new \Exception();
+    }
+}

rules-tests/CodingStyle/Rector/FunctionLike/ConvertMultilineDocblockToSingleLineRector/Fixture/skip_single_line_statements.php.inc

@@ -0,0 +1,21 @@
+<?php
+
+namespace Rector\Tests\CodingStyle\Rector\Node\ConvertMultilineDocblockToSingleLineRector\Fixture;
+
+class SkipAlreadySingleLine
+{
+    /** @return string */
+    public function getTitle(): string
+    {
+        return $this->title;
+    }
+
+    /** @param string $value */
+    public function setValue(string $value): void
+    {
+        $this->value = $value;
+    }
+
+    /** @var string */
+    private $name;
+}

rules-tests/CodingStyle/Rector/FunctionLike/ConvertMultilineDocblockToSingleLineRector/config/configured_rule.php

@@ -0,0 +1,9 @@
+<?php
+
+declare(strict_types=1);
+
+use Rector\CodingStyle\Rector\FunctionLike\ConvertMultilineDocblockToSingleLineRector;
+use Rector\Config\RectorConfig;
+
+return RectorConfig::configure()
+    ->withRules([ConvertMultilineDocblockToSingleLineRector::class]);