Clean up and normalize console command classes

packages/framework/src/Console/Commands/BuildRssFeedCommand.php

@@ -10,11 +10,14 @@
 /**
  * Hyde command to run the build process for the RSS feed.
  *
- * @see \Hyde\Framework\Testing\Feature\Commands\HydeBuildRssFeedCommandTest
+ * @see \Hyde\Framework\Testing\Feature\Commands\BuildRssFeedCommandTest
  */
 class BuildRssFeedCommand extends Command
 {
+    /** @var string */
     protected $signature = 'build:rss';
+
+    /** @var string */
     protected $description = 'Generate the RSS feed';
 
     public function handle(): int

packages/framework/src/Console/Commands/BuildSearchCommand.php

@@ -10,11 +10,14 @@
 /**
  * Hyde command to run the build process for the documentation search index.
  *
- * @see \Hyde\Framework\Testing\Feature\Commands\HydeBuildSearchCommandTest
+ * @see \Hyde\Framework\Testing\Feature\Commands\BuildSearchCommandTest
  */
 class BuildSearchCommand extends Command
 {
+    /** @var string */
     protected $signature = 'build:search';
+
+    /** @var string */
     protected $description = 'Generate the docs/search.json';
 
     public function handle(): int

packages/framework/src/Console/Commands/BuildSiteCommand.php

@@ -4,7 +4,6 @@
 
 namespace Hyde\Console\Commands;
 
-use Exception;
 use Hyde\Framework\Actions\PostBuildTasks\GenerateRssFeed;
 use Hyde\Framework\Actions\PostBuildTasks\GenerateSearch;
 use Hyde\Framework\Actions\PostBuildTasks\GenerateSitemap;
@@ -23,34 +22,19 @@
  */
 class BuildSiteCommand extends Command
 {
-    /**
-     * The signature of the command.
-     *
-     * @var string
-     */
+    /** @var string */
     protected $signature = 'build 
         {--run-dev : Run the NPM dev script after build}
         {--run-prod : Run the NPM prod script after build}
         {--run-prettier : Format the output using NPM Prettier}
         {--pretty-urls : Should links in output use pretty URLs?}
         {--no-api : Disable API calls, for example, Torchlight}';
 
-    /**
-     * The description of the command.
-     *
-     * @var string
-     */
+    /** @var string */
     protected $description = 'Build the static site';
 
     protected BuildService $service;
 
-    /**
-     * Execute the console command.
-     *
-     * @return int
-     *
-     * @throws Exception
-     */
     public function handle(): int
     {
         $time_start = microtime(true);
@@ -74,7 +58,6 @@ public function handle(): int
         return 0;
     }
 
-    /** @internal */
     protected function runPreBuildActions(): void
     {
         if ($this->option('no-api')) {
@@ -92,11 +75,6 @@ protected function runPreBuildActions(): void
         }
     }
 
-    /**
-     * Run any post-build actions.
-     *
-     * @return void
-     */
     public function runPostBuildActions(): void
     {
         $service = new BuildTaskService($this->output);
@@ -124,7 +102,6 @@ public function runPostBuildActions(): void
         $service->runPostBuildTasks();
     }
 
-    /** @internal */
     protected function printFinishMessage(float $time_start): void
     {
         $execution_time = (microtime(true) - $time_start);
@@ -141,7 +118,6 @@ protected function printFinishMessage(float $time_start): void
         );
     }
 
-    /* @internal */
     protected function runNodeCommand(string $command, string $message, ?string $actionMessage = null): void
     {
         $this->info($message.' This may take a second.');

packages/framework/src/Console/Commands/BuildSitemapCommand.php

@@ -10,7 +10,7 @@
 /**
  * Hyde command to run the build process for the sitemap.
  *
- * @see \Hyde\Framework\Testing\Feature\Commands\HydeBuildSitemapCommandTest
+ * @see \Hyde\Framework\Testing\Feature\Commands\BuildSitemapCommandTest
  */
 class BuildSitemapCommand extends Command
 {

packages/framework/src/Console/Commands/DebugCommand.php

@@ -13,18 +13,10 @@
  */
 class DebugCommand extends Command
 {
-    /**
-     * The signature of the command.
-     *
-     * @var string
-     */
+    /** @var string */
     protected $signature = 'debug';
 
-    /**
-     * The description of the command.
-     *
-     * @var string
-     */
+    /** @var string */
     protected $description = 'Print debug info';
 
     public function __construct()
@@ -36,11 +28,6 @@ public function __construct()
         }
     }
 
-    /**
-     * Execute the console command.
-     *
-     * @return int
-     */
     public function handle(): int
     {
         $this->info('HydePHP Debug Screen');

packages/framework/src/Console/Commands/MakePageCommand.php

@@ -14,27 +14,19 @@
 /**
  * Hyde Command to scaffold a new Markdown or Blade page file.
  *
- * @see \Hyde\Framework\Testing\Feature\Commands\HydeMakePageCommandTest
+ * @see \Hyde\Framework\Testing\Feature\Commands\MakePageCommandTest
  */
 class MakePageCommand extends Command
 {
-    /**
-     * The name and signature of the console command.
-     *
-     * @var string
-     */
+    /** @var string */
     protected $signature = 'make:page 
 		{title? : The name of the page file to create. Will be used to generate the slug}
 		{--type=markdown : The type of page to create (markdown, blade, or docs)}
         {--blade : Create a Blade page}
         {--docs : Create a Documentation page}
 		{--force : Overwrite any existing files}';
 
-    /**
-     * The console command description.
-     *
-     * @var string
-     */
+    /** @var string */
     protected $description = 'Scaffold a new Markdown, Blade, or documentation page file';
 
     /**
@@ -57,9 +49,6 @@ class MakePageCommand extends Command
      */
     public bool $force;
 
-    /**
-     * Execute the console command.
-     */
     public function handle(): int
     {
         $this->title('Creating a new page!');
@@ -81,13 +70,6 @@ public function handle(): int
         return 0;
     }
 
-    /**
-     * Validate the options passed to the command.
-     *
-     * @return void
-     *
-     * @throws UnsupportedPageTypeException if the page type is invalid.
-     */
     protected function validateOptions(): void
     {
         $type = $this->getSelectedType();
@@ -112,11 +94,6 @@ protected function validateOptions(): void
         throw new UnsupportedPageTypeException("Invalid page type: $type");
     }
 
-    /**
-     * Get the selected page type.
-     *
-     * @return string
-     */
     protected function getSelectedType(): string
     {
         $type = 'markdown';

packages/framework/src/Console/Commands/MakePostCommand.php

@@ -13,27 +13,14 @@
  */
 class MakePostCommand extends Command
 {
-    /**
-     * The signature of the command.
-     *
-     * @var string
-     */
+    /** @var string */
     protected $signature = 'make:post
                             {title? : The title for the Post. Will be used to generate the slug}
                             {--force : Should the generated file overwrite existing posts with the same slug?}';
 
-    /**
-     * The description of the command.
-     *
-     * @var string
-     */
+    /** @var string */
     protected $description = 'Scaffold a new Markdown blog post file';
 
-    /**
-     * Execute the console command.
-     *
-     * @return int
-     */
     public function handle(): int
     {
         $this->title('Creating a new post!');

packages/framework/src/Console/Commands/PackageDiscoverCommand.php

@@ -9,14 +9,14 @@
 use Illuminate\Foundation\PackageManifest;
 
 /**
- * @see \Hyde\Framework\Testing\Feature\Commands\HydePackageDiscoverCommandTest
+ * @see \Hyde\Framework\Testing\Feature\Commands\PackageDiscoverCommandTest
  */
 class PackageDiscoverCommand extends BaseCommand
 {
     /** @var true */
     protected $hidden = true;
 
-    public function handle(PackageManifest $manifest)
+    public function handle(PackageManifest $manifest): void
     {
         $manifest->manifestPath = Hyde::path('storage/framework/cache/packages.php');
         parent::handle($manifest);

packages/framework/src/Console/Commands/PublishHomepageCommand.php

@@ -13,7 +13,7 @@
 /**
  * Publish one of the default homepages.
  *
- * @see \Hyde\Framework\Testing\Feature\Commands\HydePublishHomepageCommandTest
+ * @see \Hyde\Framework\Testing\Feature\Commands\PublishHomepageCommandTest
  */
 class PublishHomepageCommand extends Command
 {

packages/framework/src/Console/Commands/RebuildStaticSiteCommand.php

@@ -14,23 +14,15 @@
 /**
  * Hyde Command to build a single static site file.
  *
- * @see \Hyde\Framework\Testing\Feature\Commands\HydeRebuildStaticSiteCommandTest
+ * @see \Hyde\Framework\Testing\Feature\Commands\RebuildStaticSiteCommandTest
  */
 class RebuildStaticSiteCommand extends Command
 {
-    /**
-     * The signature of the command.
-     *
-     * @var string
-     */
+    /** @var string */
     protected $signature = 'rebuild
         {path : The relative file path (example: _posts/hello-world.md)}';
 
-    /**
-     * The description of the command.
-     *
-     * @var string
-     */
+    /** @var string */
     protected $description = 'Run the static site builder for a single file';
 
     /**
@@ -40,11 +32,6 @@ class RebuildStaticSiteCommand extends Command
      */
     public string $path;
 
-    /**
-     * Execute the console command.
-     *
-     * @return int
-     */
     public function handle(): int
     {
         $time_start = microtime(true);

packages/framework/src/Console/Commands/RouteListCommand.php

@@ -11,11 +11,14 @@
 /**
  * Hyde command to display the list of site routes.
  *
- * @see \Hyde\Framework\Testing\Feature\Commands\HydeRouteListCommandTest
+ * @see \Hyde\Framework\Testing\Feature\Commands\RouteListCommandTest
  */
 class RouteListCommand extends Command
 {
+    /** @var string */
     protected $signature = 'route:list';
+
+    /** @var string */
     protected $description = 'Display all registered routes.';
 
     public function handle(): int

packages/framework/src/Console/Commands/ServeCommand.php

@@ -12,25 +12,12 @@
  */
 class ServeCommand extends Command
 {
-    /**
-     * The signature of the command.
-     *
-     * @var string
-     */
+    /** @var string */
     protected $signature = 'serve {--port=8080} {--host=localhost}';
 
-    /**
-     * The description of the command.
-     *
-     * @var string
-     */
+    /** @var string */
     protected $description = 'Start the experimental realtime compiler.';
 
-    /**
-     * Execute the console command.
-     *
-     * @return int
-     */
     public function handle(): int
     {
         $this->line('<info>Starting the HydeRC server...</info> Press Ctrl+C to stop');

packages/framework/src/Console/Commands/UpdateConfigsCommand.php

@@ -11,7 +11,7 @@
 /**
  * Publish the Hyde Config Files.
  *
- * @see \Hyde\Framework\Testing\Feature\Commands\HydeUpdateConfigsCommandTest
+ * @see \Hyde\Framework\Testing\Feature\Commands\UpdateConfigsCommandTest
  */
 class UpdateConfigsCommand extends Command
 {

packages/framework/src/Console/Commands/ValidateCommand.php

@@ -8,7 +8,7 @@
 use LaravelZero\Framework\Commands\Command;
 
 /**
- * @see \Hyde\Framework\Testing\Feature\Commands\HydeValidateCommandTest
+ * @see \Hyde\Framework\Testing\Feature\Commands\ValidateCommandTest
  */
 class ValidateCommand extends Command
 {

packages/framework/src/Framework/Concerns/AbstractBuildTask.php

@@ -20,6 +20,10 @@ abstract class AbstractBuildTask implements BuildTaskContract
     protected static string $description = 'Generic build task';
 
     protected float $timeStart;
+
+    /**
+     * @todo Consider setting default value to 0
+     */
     protected ?int $exitCode = null;
 
     public function __construct(?OutputStyle $output = null)

packages/framework/src/Framework/Models/Support/ValidationResult.php

@@ -6,7 +6,7 @@
 
 /**
  * @see \Hyde\Framework\Testing\Feature\Services\ValidationServiceTest
- * @see \Hyde\Framework\Testing\Feature\Commands\HydeValidateCommandTest
+ * @see \Hyde\Framework\Testing\Feature\Commands\ValidateCommandTest
  */
 class ValidationResult
 {