feat(console): support variadic argument

Author: Bapawe

packages/console/src/ConsoleInputBuilder.php

@@ -26,6 +26,18 @@ public function build(): array
         $argumentDefinitions = $this->command->getArgumentDefinitions();
 
         foreach ($argumentDefinitions as $argumentDefinition) {
+            if ($argumentDefinition->isVariadic) {
+                $arguments = $this->argumentBag->findForVariadicArgument($argumentDefinition);
+
+                if ($arguments === []) {
+                    $invalidArguments[] = $argumentDefinition;
+                } else {
+                    $validArguments = [...$validArguments, ...$arguments];
+                }
+
+                continue;
+            }
+
             $argument = $argumentDefinition->type === 'array'
                 ? $this->argumentBag->findArrayFor($argumentDefinition)
                 : $this->argumentBag->findFor($argumentDefinition);

packages/console/src/Input/ConsoleArgumentBag.php

@@ -129,6 +129,26 @@ public function findArrayFor(ConsoleArgumentDefinition $argumentDefinition): Con
         );
     }
 
+    /**
+     * @return list<ConsoleInputArgument>
+     */
+    public function findForVariadicArgument(ConsoleArgumentDefinition $argumentDefinition): array
+    {
+        $arguments = [];
+
+        foreach ($this->arguments as $argument) {
+            if ($argument->position >= $argumentDefinition->position) {
+                $arguments[] = new ConsoleInputArgument(
+                    name: $argumentDefinition->name,
+                    position: $argument->position,
+                    value: $this->resolveArgumentValue($argumentDefinition, $argument)->value,
+                );
+            }
+        }
+
+        return $arguments;
+    }
+
     public function add(ConsoleInputArgument $argument): self
     {
         $this->arguments[] = $argument;

packages/console/src/Input/ConsoleArgumentDefinition.php

@@ -18,6 +18,7 @@ public function __construct(
         public mixed $default,
         public bool $hasDefault,
         public int $position,
+        public bool $isVariadic = false,
         public ?string $description = null,
         public array $aliases = [],
         public ?string $help = null,
@@ -36,6 +37,7 @@ public static function fromParameter(ParameterReflector $parameter): ConsoleArgu
             default: $default,
             hasDefault: $parameter->isDefaultValueAvailable(),
             position: $parameter->getPosition(),
+            isVariadic: $type->isVariadic,
             description: $attribute?->description,
             aliases: $attribute->aliases ?? [],
             help: $attribute?->help,

packages/reflection/src/TypeReflector.php

@@ -53,12 +53,15 @@
 
     private bool $isNullable;
 
+    public bool $isVariadic;
+
     public function __construct(
         private PHPReflector|PHPReflectionType|string $reflector,
     ) {
         $this->definition = $this->resolveDefinition($this->reflector);
         $this->isNullable = $this->resolveIsNullable($this->reflector);
         $this->cleanDefinition = str_replace('?', '', $this->definition);
+        $this->isVariadic = $this->reflector instanceof PHPReflectionParameter && $this->reflector->isVariadic();
     }
 
     public function asClass(): ClassReflector

tests/Integration/Console/ConsoleArgumentBagTest.php

@@ -8,6 +8,7 @@
 use Tempest\Console\Exceptions\InvalidEnumArgument;
 use Tempest\Console\Input\ConsoleArgumentBag;
 use Tempest\Console\Input\ConsoleArgumentDefinition;
+use Tempest\Console\Input\ConsoleInputArgument;
 use Tests\Tempest\Integration\Console\Fixtures\TestStringEnum;
 use Tests\Tempest\Integration\FrameworkIntegrationTestCase;
 
@@ -190,4 +191,28 @@ public function test_name_mapping(): void
             ->assertSee('foo')
             ->assertSee('true');
     }
+
+    public function test_variadic_argument(): void
+    {
+        $argv = [
+            'tempest',
+            'command-with-variadic-argument',
+            'foo',
+            'bar',
+            '--input=baz',
+        ];
+
+        $bag = new ConsoleArgumentBag($argv);
+
+        $definition = new ConsoleArgumentDefinition(
+            name: 'input2',
+            type: 'bool',
+            default: null,
+            hasDefault: false,
+            position: 0,
+            isVariadic: true,
+        );
+
+        $this->assertSame(['foo', 'bar', 'baz'], array_map(static fn (ConsoleInputArgument $argument): string => $argument->value, $bag->findForVariadicArgument($definition)));
+    }
 }

tests/Integration/Console/Fixtures/VariadicCommand.php

@@ -0,0 +1,19 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Tests\Tempest\Integration\Console\Fixtures;
+
+use Tempest\Console\ConsoleCommand;
+use Tempest\Console\HasConsole;
+
+final readonly class VariadicCommand
+{
+    use HasConsole;
+
+    #[ConsoleCommand('command-with-variadic-argument')]
+    public function __invoke(string ...$input): void
+    {
+        $this->writeln(json_encode($input));
+    }
+}