Merge pull request #30 from kbond/deprecate-docblocks

Deprecate `ConfigureWithDocblocks` on PHP 8

Author: kbond

README.md

@@ -267,6 +267,10 @@ class CreateUserCommand extends Command
 
 ### `ConfigureWithDocblocks`
 
+> **Note**
+> This trait is deprecated when using with PHP 8+ and will be removed in 2.0.
+> Use [`ConfigureWithAttributes`](#configurewithattributes) instead.
+
 Use this trait to allow your command to be configured by your command class' docblock.
 `phpdocumentor/reflection-docblock` is required for this feature
 (`composer install phpdocumentor/reflection-docblock`).

composer.json

@@ -14,6 +14,7 @@
     "require": {
         "php": ">=7.4",
         "symfony/console": "^4.4|^5.0|^6.0",
+        "symfony/deprecation-contracts": "^2.2|^3.0",
         "symfony/polyfill-php80": "^1.15",
         "symfony/string": "^5.0|^6.0",
         "zenstruck/callback": "^1.4.2"

src/Configuration/DocblockConfiguration.php

@@ -7,6 +7,8 @@
 use Symfony\Component\Console\Command\Command;
 use Symfony\Component\Console\Input\InputArgument;
 use Symfony\Component\Console\Input\InputOption;
+use Zenstruck\Console\ConfigureWithAttributes;
+use Zenstruck\Console\ConfigureWithDocblocks;
 
 use function Symfony\Component\String\u;
 
@@ -38,6 +40,10 @@ private function __construct(string $class)
     {
         $this->class = new \ReflectionClass($class);
         $this->docblock = self::factory()->create($this->class->getDocComment() ?: ' '); // hack to allow empty docblock
+
+        if (\PHP_VERSION_ID >= 80000) {
+            trigger_deprecation('zenstruck/console-extra', '1.1', 'The %s trait is deprecated and will be removed in 2.0. Use %s instead.', ConfigureWithDocblocks::class, ConfigureWithAttributes::class);
+        }
     }
 
     /**

tests/Unit/AttributesConfigureTest.php …sts/Unit/ConfigureWithAttributesTest.phptests/Unit/AttributesConfigureTest.php renamed to tests/Unit/ConfigureWithAttributesTest.php tests/Unit/AttributesConfigureTest.php renamed to tests/Unit/ConfigureWithAttributesTest.php

@@ -17,7 +17,7 @@
  *
  * @requires PHP 8
  */
-final class AttributesConfigureTest extends TestCase
+final class ConfigureWithAttributesTest extends TestCase
 {
     /**
      * @test

tests/Unit/DocblockConfigureTest.php tests/Unit/ConfigureWithDocblocksTest.phptests/Unit/DocblockConfigureTest.php renamed to tests/Unit/ConfigureWithDocblocksTest.php

@@ -9,8 +9,10 @@
 
 /**
  * @author Kevin Bond <kevinbond@gmail.com>
+ *
+ * @group legacy
  */
-final class DocblockConfigureTest extends TestCase
+final class ConfigureWithDocblocksTest extends TestCase
 {
     /**
      * @test