Move name and description into Task

jasonmccreary · jasonmccreary · commit 14e275179ceb · 2023-09-15T06:55:52.000-04:00
diff --git a/config/defaults.php b/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' => [
diff --git a/src/Commands/DiscoverCommand.php b/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
 {
diff --git a/src/Commands/RunCommand.php b/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();
+    }
 }
diff --git a/src/Support/TaskManifest.php b/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());
     }
 
diff --git a/src/Tasks/AnonymousMigrations.php b/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();
diff --git a/src/Tasks/CheckLint.php b/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();
diff --git a/src/Tasks/ClassStrings.php b/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();
diff --git a/src/Tasks/DebugCalls.php b/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();
diff --git a/src/Tasks/DeclareStrictTypes.php b/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();
diff --git a/src/Tasks/DownMigration.php b/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();
diff --git a/src/Tasks/ExplicitOrderBy.php b/src/Tasks/ExplicitOrderBy.php
@@ -12,6 +12,10 @@ class ExplicitOrderBy implements Task
 {
     use FindsFiles;
 
+    public static string $name = 'explicit-orderby';
+
+    public static string $description = 'Converts `orderBy()` calls to `orderByAsc()`/`orderByDesc()`';
+
     public function perform(): int
     {
         $finder = new QueryOrderByFinder(false, true);
diff --git a/src/Tasks/FacadeAliases.php b/src/Tasks/FacadeAliases.php
@@ -9,6 +9,10 @@ class FacadeAliases implements Task
 {
     use FindsFiles;
 
+    public static string $name = 'facade-aliases';
+
+    public static string $description = 'Converts references to global Facade aliases to their FQCN';
+
     private array $coreFacades = [
         'App',
         'Artisan',
diff --git a/src/Tasks/FakerMethods.php b/src/Tasks/FakerMethods.php
@@ -10,6 +10,10 @@ class FakerMethods implements Task
 {
     use FindsFiles;
 
+    public static string $name = 'faker-methods';
+
+    public static string $description = 'Converts directly accessing Faker property to method calls';
+
     public function perform(): int
     {
         $map = array_combine(array_map('strtolower', $this->properties()), $this->properties());
diff --git a/src/Tasks/LaravelCarbon.php b/src/Tasks/LaravelCarbon.php
@@ -9,6 +9,10 @@ class LaravelCarbon implements Task
 {
     use FindsFiles;
 
+    public static string $name = 'laravel-carbon';
+
+    public static string $description = 'Converts `Carbon\Carbon` imports to `Illuminate\Support\Carbon`';
+
     public function perform(): int
     {
         foreach ($this->findFiles() as $path) {
diff --git a/src/Tasks/LatestOldest.php b/src/Tasks/LatestOldest.php
@@ -12,6 +12,10 @@ class LatestOldest implements Task
 {
     use FindsFiles;
 
+    public static string $name = 'latest-oldest';
+
+    public static string $description = 'Converts `orderBy()` calls to `latest()`/`oldest()`';
+
     public function perform(): int
     {
         $finder = new QueryOrderByFinder(false, false);
diff --git a/src/Tasks/ModelTableName.php b/src/Tasks/ModelTableName.php
@@ -13,6 +13,10 @@ class ModelTableName implements Task
 {
     use FindsFiles;
 
+    public static string $name = 'model-table';
+
+    public static string $description = 'Removes `$table` property from models which have a conventional name';
+
     public function perform(): int
     {
         foreach ($this->findFilesContaining('/^class\s+/m') as $path) {
diff --git a/src/Tasks/OrderModel.php b/src/Tasks/OrderModel.php
@@ -11,6 +11,10 @@ class OrderModel implements Task
 {
     use FindsFiles;
 
+    public static string $name = 'order-model';
+
+    public static string $description = 'Sorts code within your model classes by type and visibility';
+
     protected const METHOD_ORDER = [
         'constructor',
         'booting',
diff --git a/src/Tasks/RemoveDocBlocks.php b/src/Tasks/RemoveDocBlocks.php
@@ -9,6 +9,10 @@ class RemoveDocBlocks implements Task
 {
     use FindsFiles;
 
+    public static string $name = 'remove-docblocks';
+
+    public static string $description = 'Remove all DocBlocks from PHP files';
+
     public function perform(): int
     {
         $files = $this->findFiles();
diff --git a/src/Tasks/RulesArrays.php b/src/Tasks/RulesArrays.php
@@ -10,6 +10,10 @@ class RulesArrays implements Task
 {
     use FindsFiles;
 
+    public static string $name = 'rules-arrays';
+
+    public static string $description = 'Converts validation rules from string to array syntax';
+
     private static $indent = 16;
 
     public function perform(): int
diff --git a/tests/Feature/Support/TaskManifestTest.php b/tests/Feature/Support/TaskManifestTest.php
@@ -28,9 +28,9 @@ public function list_returns_default_tasks_for_no_manifest()
     {
         $this->fakeProject([]);
 
-        $taskManifest = new TaskManifest($this->currentSnapshotPath(), ['task-name' => 'Fully\\Qualified\\Class\\Name']);
+        $taskManifest = new TaskManifest($this->currentSnapshotPath(), ['Tests\\Support\\GoodTask']);
 
-        $this->assertSame(['task-name' => 'Fully\\Qualified\\Class\\Name'], $taskManifest->list());
+        $this->assertSame(['good-task' => 'Tests\\Support\\GoodTask'], $taskManifest->list());
         $this->assertFileExists($this->currentSnapshotPath() . DIRECTORY_SEPARATOR . 'shift-tasks.php');
 
         $manifest = require $this->currentSnapshotPath() . DIRECTORY_SEPARATOR . 'shift-tasks.php';
@@ -45,21 +45,31 @@ public function list_rebuilds_stale_manifest()
             'shift-tasks.php' => '<?php return ["namespace" => "Stale", "tasks" => ["task-name" => "foo"]];',
             'composer/installed.json' => json_encode([
                 'packages' => [
+                    [
+                        'extra' => ['laravel' => true],
+                    ],
+                    [
+                        'extra' => [
+                            'shift' => [
+                                'tasks' => ['Tests\\Support\\GoodTask'],
+                            ],
+                        ],
+                    ],
                     [
                         'extra' => [
                             'shift' => [
-                                'tasks' => ['task1' => '\\Package\\Task1', 'task2' => '\\Package\\Task2'],
+                                'tasks' => ['Tests\\Support\\GoodTask', 'Tests\\Support\\DirtyTask'],
                             ],
                         ],
                     ],
                 ],
             ]),
         ]);
 
-        $taskManifest = new TaskManifest($this->currentSnapshotPath(), ['task-name' => 'Fully\\Qualified\\Class\\Name']);
+        $taskManifest = new TaskManifest($this->currentSnapshotPath(), ['Tests\\Support\\CommentTask']);
 
         $this->assertEqualsCanonicalizing(
-            ['task-name' => 'Fully\\Qualified\\Class\\Name', 'task1' => '\\Package\\Task1', 'task2' => '\\Package\\Task2'],
+            ['comment-task' => 'Tests\\Support\\CommentTask', 'good-task' => 'Tests\\Support\\GoodTask', 'dirty-task' => 'Tests\\Support\\DirtyTask'],
             $taskManifest->list()
         );
 
@@ -79,25 +89,25 @@ public function build_returns_merged_tasks_from_packages()
                     [
                         'extra' => [
                             'shift' => [
-                                'tasks' => ['package1-task' => '\\Package1\\Task'],
+                                'tasks' => ['Tests\\Support\\CommentTask'],
                             ],
                         ],
                     ],
                     [
                         'extra' => [
                             'shift' => [
-                                'tasks' => ['package2-task' => '\\Package2\\Task'],
+                                'tasks' => ['Tests\\Support\\BadTask'],
                             ],
                         ],
                     ],
                 ],
             ]),
         ]);
 
-        $taskManifest = new TaskManifest($this->currentSnapshotPath(), ['task-name' => 'Fully\\Qualified\\Class\\Name']);
+        $taskManifest = new TaskManifest($this->currentSnapshotPath(), ['Tests\\Support\\GoodTask']);
 
         $this->assertEqualsCanonicalizing(
-            ['task-name' => 'Fully\\Qualified\\Class\\Name', 'package1-task' => '\\Package1\\Task', 'package2-task' => '\\Package2\\Task'],
+            ['good-task' => 'Tests\\Support\\GoodTask', 'comment-task' => 'Tests\\Support\\CommentTask', 'bad-task' => 'Tests\\Support\\BadTask'],
             $taskManifest->list()
         );
 
diff --git a/tests/Support/BadTask.php b/tests/Support/BadTask.php
@@ -6,6 +6,10 @@
 
 class BadTask implements Task
 {
+    public static string $name = 'bad-task';
+
+    public static string $description = 'A test task which returns an error code';
+
     public function perform(): int
     {
         return 123;
diff --git a/tests/Support/CommentTask.php b/tests/Support/CommentTask.php
@@ -7,6 +7,10 @@
 
 class CommentTask implements Task
 {
+    public static string $name = 'comment-task';
+
+    public static string $description = 'A test task which leaves a comment';
+
     public function perform(): int
     {
         Comment::addComment('Leaving a test comment.', ['file-1.php', 'file-2.php'], 'https://laravel.com/docs/');
diff --git a/tests/Support/DirtyTask.php b/tests/Support/DirtyTask.php
@@ -9,6 +9,10 @@ class DirtyTask implements Task
 {
     use FindsFiles;
 
+    public static string $name = 'dirty-task';
+
+    public static string $description = 'A test task which expects the dirty option';
+
     public function perform(): int
     {
         if (! $this->dirty) {
diff --git a/tests/Support/GoodTask.php b/tests/Support/GoodTask.php
@@ -6,6 +6,10 @@
 
 class GoodTask implements Task
 {
+    public static string $name = 'good-task';
+
+    public static string $description = 'A test task which immediately returns';
+
     public function perform(): int
     {
         return 0;
diff --git a/tests/Support/PathTask.php b/tests/Support/PathTask.php

Original file line number	Diff line number	Diff line change
`@@ -10,7 +10,7 @@`
`10`	`10`
`11`	`11`	`#[AsCommand(`
`12`	`12`	`name: 'discover',`
`13`		`- description: 'Load any additional automated tasks within the project',`
	`13`	`+ description: 'Register any additional automated tasks within the project',`
`14`	`14`	`)]`
`15`	`15`	`class DiscoverCommand extends Command`
`16`	`16`	`{`
Original file line number	Diff line number	Diff line change
`@@ -10,6 +10,10 @@ class AnonymousMigrations implements Task`
`10`	`10`	`{`
`11`	`11`	`use FindsFiles;`
`12`	`12`
	`13`	`+ public static string $name = 'anonymous-migrations';`
	`14`	`+`
	`15`	`+ public static string $description = 'Converts migrations to use anonymous classes';`
	`16`	`+`
`13`	`17`	`public function perform(): int`
`14`	`18`	`{`
`15`	`19`	`$this->updateMigrations();`
Original file line number	Diff line number	Diff line change
`@@ -10,6 +10,10 @@ class CheckLint implements Task`
`10`	`10`	`{`
`11`	`11`	`use FindsFiles;`
`12`	`12`
	`13`	`+ public static string $name = 'check-lint';`
	`14`	`+`
	`15`	`+ public static string $description = 'Checks PHP files for syntax errors';`
	`16`	`+`
`13`	`17`	`public function perform(): int`
`14`	`18`	`{`
`15`	`19`	`$files = $this->findFiles();`
Original file line number	Diff line number	Diff line change
`@@ -10,6 +10,10 @@ class ClassStrings implements Task`
`10`	`10`	`{`
`11`	`11`	`use FindsFiles;`
`12`	`12`
	`13`	`+ public static string $name = 'class-strings';`
	`14`	`+`
	`15`	+ public static string $description = 'Converts string class references to use `::class` constant';
	`16`	`+`
`13`	`17`	`public function perform(): int`
`14`	`18`	`{`
`15`	`19`	`$namespaces = $this->psr4Namespaces();`
Original file line number	Diff line number	Diff line change
`@@ -11,6 +11,10 @@ class DebugCalls implements Task`
`11`	`11`	`{`
`12`	`12`	`use FindsFiles;`
`13`	`13`
	`14`	`+ public static string $name = 'debug-calls';`
	`15`	`+`
	`16`	`+ public static string $description = 'Removes calls to common debugging functions';`
	`17`	`+`
`14`	`18`	`public function perform(): int`
`15`	`19`	`{`
`16`	`20`	`$files = $this->findFiles();`
Original file line number	Diff line number	Diff line change
`@@ -10,6 +10,10 @@ class DeclareStrictTypes implements Task`
`10`	`10`	`{`
`11`	`11`	`use FindsFiles;`
`12`	`12`
	`13`	`+ public static string $name = 'declare-strict';`
	`14`	`+`
	`15`	+ public static string $description = 'Adds `strict_types` declaration to PHP files';
	`16`	`+`
`13`	`17`	`public function perform(): int`
`14`	`18`	`{`
`15`	`19`	`$files = $this->findFiles();`
Original file line number	Diff line number	Diff line change
`@@ -10,6 +10,10 @@ class DownMigration implements Task`
`10`	`10`	`{`
`11`	`11`	`use FindsFiles;`
`12`	`12`
	`13`	`+ public static string $name = 'down-migration';`
	`14`	`+`
	`15`	+ public static string $description = 'Removes the `down` method from migrations';
	`16`	`+`
`13`	`17`	`public function perform(): int`
`14`	`18`	`{`
`15`	`19`	`$this->updateMigrations();`