From a55370ae324adbeb362aea0d7d2d7aef41da4acc Mon Sep 17 00:00:00 2001 From: Caen De Silva Date: Thu, 14 Dec 2023 15:19:34 +0100 Subject: [PATCH 1/3] Remove trailing periods from console command descriptions It's nice to have a consistent style for this, and Laravel doesn't use trailing periods here, so neither should we. --- .../src/Console/Commands/ChangeSourceDirectoryCommand.php | 2 +- .../src/Console/Commands/PublishHomepageCommand.php | 2 +- .../src/Console/Commands/PublishViewsCommand.php | 8 ++++---- .../framework/src/Console/Commands/RouteListCommand.php | 2 +- packages/framework/src/Console/Commands/ServeCommand.php | 2 +- .../framework/src/Console/Commands/ValidateCommand.php | 4 ++-- 6 files changed, 10 insertions(+), 10 deletions(-) diff --git a/packages/framework/src/Console/Commands/ChangeSourceDirectoryCommand.php b/packages/framework/src/Console/Commands/ChangeSourceDirectoryCommand.php index 92b0d583992..6bffde7f1ee 100644 --- a/packages/framework/src/Console/Commands/ChangeSourceDirectoryCommand.php +++ b/packages/framework/src/Console/Commands/ChangeSourceDirectoryCommand.php @@ -30,7 +30,7 @@ class ChangeSourceDirectoryCommand extends Command protected $signature = 'change:sourceDirectory {name : The new source directory name }'; /** @var string */ - protected $description = 'Change the source directory for your project.'; + protected $description = 'Change the source directory for your project'; protected $hidden = true; diff --git a/packages/framework/src/Console/Commands/PublishHomepageCommand.php b/packages/framework/src/Console/Commands/PublishHomepageCommand.php index 4d0a560287e..6a2a19dd7da 100644 --- a/packages/framework/src/Console/Commands/PublishHomepageCommand.php +++ b/packages/framework/src/Console/Commands/PublishHomepageCommand.php @@ -29,7 +29,7 @@ class PublishHomepageCommand extends Command {--force : Overwrite any existing files}'; /** @var string */ - protected $description = 'Publish one of the default homepages to index.blade.php.'; + protected $description = 'Publish one of the default homepages to index.blade.php'; /** @var array */ protected array $options = [ diff --git a/packages/framework/src/Console/Commands/PublishViewsCommand.php b/packages/framework/src/Console/Commands/PublishViewsCommand.php index fb6c0a01eda..46ef8d6c1be 100644 --- a/packages/framework/src/Console/Commands/PublishViewsCommand.php +++ b/packages/framework/src/Console/Commands/PublishViewsCommand.php @@ -20,23 +20,23 @@ class PublishViewsCommand extends Command protected $signature = 'publish:views {category? : The category to publish}'; /** @var string */ - protected $description = 'Publish the hyde components for customization. Note that existing files will be overwritten.'; + protected $description = 'Publish the hyde components for customization. Note that existing files will be overwritten'; /** @var array> */ protected array $options = [ 'layouts' => [ 'name' => 'Blade Layouts', - 'description' => 'Shared layout views, such as the app layout, navigation menu, and Markdown page templates.', + 'description' => 'Shared layout views, such as the app layout, navigation menu, and Markdown page templates', 'group' => 'hyde-layouts', ], 'components' => [ 'name' => 'Blade Components', - 'description' => 'More or less self contained components, extracted for customizability and DRY code.', + 'description' => 'More or less self contained components, extracted for customizability and DRY code', 'group' => 'hyde-components', ], 'page-404' => [ 'name' => '404 Page', - 'description' => 'A beautiful 404 error page by the Laravel Collective.', + 'description' => 'A beautiful 404 error page by the Laravel Collective', 'group' => 'hyde-page-404', ], ]; diff --git a/packages/framework/src/Console/Commands/RouteListCommand.php b/packages/framework/src/Console/Commands/RouteListCommand.php index ddbed8b5826..0e2ad7dc16c 100644 --- a/packages/framework/src/Console/Commands/RouteListCommand.php +++ b/packages/framework/src/Console/Commands/RouteListCommand.php @@ -23,7 +23,7 @@ class RouteListCommand extends Command protected $signature = 'route:list'; /** @var string */ - protected $description = 'Display all registered routes.'; + protected $description = 'Display all registered routes'; public function handle(): int { diff --git a/packages/framework/src/Console/Commands/ServeCommand.php b/packages/framework/src/Console/Commands/ServeCommand.php index abeb85f9571..98972f3442d 100644 --- a/packages/framework/src/Console/Commands/ServeCommand.php +++ b/packages/framework/src/Console/Commands/ServeCommand.php @@ -36,7 +36,7 @@ class ServeCommand extends Command '; /** @var string */ - protected $description = 'Start the realtime compiler server.'; + protected $description = 'Start the realtime compiler server'; protected ConsoleOutput $console; diff --git a/packages/framework/src/Console/Commands/ValidateCommand.php b/packages/framework/src/Console/Commands/ValidateCommand.php index 3a14fed0aec..148366411d9 100644 --- a/packages/framework/src/Console/Commands/ValidateCommand.php +++ b/packages/framework/src/Console/Commands/ValidateCommand.php @@ -24,10 +24,10 @@ class ValidateCommand extends Command protected $signature = 'validate'; /** @var string */ - protected $description = 'Test and validate your project to optimize your site.'; + protected $description = 'Test and validate your project to optimize your site'; /** @var string */ - protected $help = 'Run a series of tests to validate your setup and help you optimize your site.'; + protected $help = 'Run a series of tests to validate your setup and help you optimize your site'; protected ValidationService $service; From f175a831b077d59af2cfa7a9b2204284fa17b7e5 Mon Sep 17 00:00:00 2001 From: Caen De Silva Date: Thu, 14 Dec 2023 15:21:05 +0100 Subject: [PATCH 2/3] Improve console command description wording --- packages/framework/src/Console/Commands/DebugCommand.php | 2 +- packages/framework/src/Console/Commands/RouteListCommand.php | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/packages/framework/src/Console/Commands/DebugCommand.php b/packages/framework/src/Console/Commands/DebugCommand.php index b15a55541e9..c3f4effc11e 100644 --- a/packages/framework/src/Console/Commands/DebugCommand.php +++ b/packages/framework/src/Console/Commands/DebugCommand.php @@ -22,7 +22,7 @@ class DebugCommand extends Command protected $signature = 'debug'; /** @var string */ - protected $description = 'Print debug info'; + protected $description = 'Print debug information'; public function __construct() { diff --git a/packages/framework/src/Console/Commands/RouteListCommand.php b/packages/framework/src/Console/Commands/RouteListCommand.php index 0e2ad7dc16c..3fcc1ddcfa8 100644 --- a/packages/framework/src/Console/Commands/RouteListCommand.php +++ b/packages/framework/src/Console/Commands/RouteListCommand.php @@ -23,7 +23,7 @@ class RouteListCommand extends Command protected $signature = 'route:list'; /** @var string */ - protected $description = 'Display all registered routes'; + protected $description = 'Display all the registered routes'; public function handle(): int { From e48dd978f2ccf55a56cc86062e9ac7a4b04a29e1 Mon Sep 17 00:00:00 2001 From: Caen De Silva Date: Thu, 14 Dec 2023 15:22:40 +0100 Subject: [PATCH 3/3] Update RELEASE_NOTES.md --- RELEASE_NOTES.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/RELEASE_NOTES.md b/RELEASE_NOTES.md index d412dc012b6..f71fdf3e311 100644 --- a/RELEASE_NOTES.md +++ b/RELEASE_NOTES.md @@ -14,7 +14,7 @@ This serves two purposes: ### Changed - Shortened the path printed to console when using the dashboard to create a page in https://github.com/hydephp/develop/pull/1492 -- Code cleanup and style improvements in https://github.com/hydephp/develop/pull/1501 and https://github.com/hydephp/develop/pull/1502 +- Code cleanup and style improvements in https://github.com/hydephp/develop/pull/1501, https://github.com/hydephp/develop/pull/1502, and https://github.com/hydephp/develop/pull/1503. ### Deprecated - for soon-to-be removed features.