Move name and description into Task

Author: jasonmccreary

config/defaults.php

@@ -2,21 +2,21 @@
 
 return [
     'tasks' => [
-        'anonymous-migrations' => \Shift\Cli\Tasks\AnonymousMigrations::class,
-        'check-lint' => \Shift\Cli\Tasks\CheckLint::class,
-        'class-strings' => \Shift\Cli\Tasks\ClassStrings::class,
-        'debug-calls' => \Shift\Cli\Tasks\DebugCalls::class,
-        'declare-strict' => \Shift\Cli\Tasks\DeclareStrictTypes::class,
-        'down-migration' => \Shift\Cli\Tasks\DownMigration::class,
-        'explicit-orderby' => \Shift\Cli\Tasks\ExplicitOrderBy::class,
-        'facade-aliases' => \Shift\Cli\Tasks\FacadeAliases::class,
-        'faker-methods' => \Shift\Cli\Tasks\FakerMethods::class,
-        'laravel-carbon' => \Shift\Cli\Tasks\LaravelCarbon::class,
-        'latest-oldest' => \Shift\Cli\Tasks\LatestOldest::class,
-        'model-table' => \Shift\Cli\Tasks\ModelTableName::class,
-        'order-model' => \Shift\Cli\Tasks\OrderModel::class,
-        'remove-docblocks' => \Shift\Cli\Tasks\RemoveDocBlocks::class,
-        'rules-arrays' => \Shift\Cli\Tasks\RulesArrays::class,
+        \Shift\Cli\Tasks\AnonymousMigrations::class,
+        \Shift\Cli\Tasks\CheckLint::class,
+        \Shift\Cli\Tasks\ClassStrings::class,
+        \Shift\Cli\Tasks\DebugCalls::class,
+        \Shift\Cli\Tasks\DeclareStrictTypes::class,
+        \Shift\Cli\Tasks\DownMigration::class,
+        \Shift\Cli\Tasks\ExplicitOrderBy::class,
+        \Shift\Cli\Tasks\FacadeAliases::class,
+        \Shift\Cli\Tasks\FakerMethods::class,
+        \Shift\Cli\Tasks\LaravelCarbon::class,
+        \Shift\Cli\Tasks\LatestOldest::class,
+        \Shift\Cli\Tasks\ModelTableName::class,
+        \Shift\Cli\Tasks\OrderModel::class,
+        \Shift\Cli\Tasks\RemoveDocBlocks::class,
+        \Shift\Cli\Tasks\RulesArrays::class,
     ],
 
     'run' => [

src/Commands/DiscoverCommand.php

@@ -10,7 +10,7 @@
 
 #[AsCommand(
     name: 'discover',
-    description: 'Load any additional automated tasks within the project',
+    description: 'Register any additional automated tasks within the project',
 )]
 class DiscoverCommand extends Command
 {

src/Commands/RunCommand.php

@@ -9,6 +9,7 @@
 use Shift\Cli\Support\TaskManifest;
 use Symfony\Component\Console\Attribute\AsCommand;
 use Symfony\Component\Console\Command\Command;
+use Symfony\Component\Console\Helper\Table;
 use Symfony\Component\Console\Input\InputArgument;
 use Symfony\Component\Console\Input\InputInterface;
 use Symfony\Component\Console\Input\InputOption;
@@ -32,12 +33,19 @@ public function __construct(TaskManifest $taskManifest)
     protected function configure(): void
     {
         $this->addArgument('task', InputArgument::IS_ARRAY | InputArgument::OPTIONAL, 'The name of the automated task');
+        $this->addOption('tasks', mode: InputOption::VALUE_NONE, description: 'List the available tasks');
         $this->addOption('dirty', mode: InputOption::VALUE_NONE, description: 'Scan only dirty files');
         $this->addOption('path', mode: InputOption::VALUE_REQUIRED | InputArgument::OPTIONAL | InputOption::VALUE_IS_ARRAY, description: 'The paths to scan');
     }
 
     protected function execute(InputInterface $input, OutputInterface $output): int
     {
+        if ($input->getOption('tasks')) {
+            $this->listTasks($output);
+
+            return 0;
+        }
+
         $tasks = empty($input->getArgument('task')) ? Configuration::get('tasks', []) : $input->getArgument('task');
 
         foreach ($tasks as $task) {
@@ -100,4 +108,17 @@ private function taskRegistry(string $task): string
 
         return $tasks[$task];
     }
+
+    private function listTasks(OutputInterface $output)
+    {
+        $output->writeln('<comment>Available tasks:</comment>');
+
+        $tasks = collect($this->taskManifest->list())
+            ->map(fn ($fqcn) => ['  <info>' . $fqcn::$name . '</info> ', $fqcn::$description])
+            ->all();
+
+        (new Table($output))->setStyle('compact')
+            ->setRows($tasks)
+            ->render();
+    }
 }

src/Support/TaskManifest.php

@@ -56,10 +56,10 @@ public function build(): void
 
         $this->write(collect($packages)
             ->mapWithKeys(function ($package) {
-                return $package['extra']['shift']['tasks'] ?? [];
+                return collect($package['extra']['shift']['tasks'] ?? [])->mapWithKeys(fn ($task) => [$task::$name => $task]);
             })
             ->filter()
-            ->merge($this->defaultTasks)
+            ->merge(collect($this->defaultTasks)->mapWithKeys(fn ($task) => [$task::$name => $task]))
             ->all());
     }
 

src/Tasks/AnonymousMigrations.php

@@ -10,6 +10,10 @@ class AnonymousMigrations implements Task
 {
     use FindsFiles;
 
+    public static string $name = 'anonymous-migrations';
+
+    public static string $description = 'Converts migrations to use anonymous classes';
+
     public function perform(): int
     {
         $this->updateMigrations();

src/Tasks/CheckLint.php

@@ -10,6 +10,10 @@ class CheckLint implements Task
 {
     use FindsFiles;
 
+    public static string $name = 'check-lint';
+
+    public static string $description = 'Checks PHP files for syntax errors';
+
     public function perform(): int
     {
         $files = $this->findFiles();

src/Tasks/ClassStrings.php

@@ -10,6 +10,10 @@ class ClassStrings implements Task
 {
     use FindsFiles;
 
+    public static string $name = 'class-strings';
+
+    public static string $description = 'Converts string class references to use `::class` constant';
+
     public function perform(): int
     {
         $namespaces = $this->psr4Namespaces();

src/Tasks/DebugCalls.php

@@ -11,6 +11,10 @@ class DebugCalls implements Task
 {
     use FindsFiles;
 
+    public static string $name = 'debug-calls';
+
+    public static string $description = 'Removes calls to common debugging functions';
+
     public function perform(): int
     {
         $files = $this->findFiles();

src/Tasks/DeclareStrictTypes.php

@@ -10,6 +10,10 @@ class DeclareStrictTypes implements Task
 {
     use FindsFiles;
 
+    public static string $name = 'declare-strict';
+
+    public static string $description = 'Adds `strict_types` declaration to PHP files';
+
     public function perform(): int
     {
         $files = $this->findFiles();

src/Tasks/DownMigration.php

@@ -10,6 +10,10 @@ class DownMigration implements Task
 {
     use FindsFiles;
 
+    public static string $name = 'down-migration';
+
+    public static string $description = 'Removes the `down` method from migrations';
+
     public function perform(): int
     {
         $this->updateMigrations();